Interface ClassDefinition

  • All Known Subinterfaces:
    AspectDefinition, TypeDefinition

    @AlfrescoPublicApi
    public interface ClassDefinition
    Read-only definition of a Class.
    Author:
    David Caruana
    • Method Detail

      • getName

        QName getName()
        Returns:
        the qualified name of the class
      • getTitle

        java.lang.String getTitle()
        Deprecated.
        The problem identified in MNT-413 will still exist
      • getDescription

        java.lang.String getDescription()
        Deprecated.
        The problem identified in MNT-413 will still exist
      • getTitle

        java.lang.String getTitle​(MessageLookup messageLookup)
        Returns:
        the human-readable class title
      • getDescription

        java.lang.String getDescription​(MessageLookup messageLookup)
        Returns:
        the human-readable class description
      • getParentName

        QName getParentName()
        Returns:
        the super class (or null, if this is the root)
      • isAspect

        boolean isAspect()
        Returns:
        true => aspect, false => type
      • getArchive

        java.lang.Boolean getArchive()
        Returns:
        Return true if the type should be archived on delete, false if it should be deleted or null if not defined.
      • getIncludedInSuperTypeQuery

        java.lang.Boolean getIncludedInSuperTypeQuery()
        Returns:
        Return true if the type should be included in supertypes queries, false if not deleted or null if not defined.
      • getProperties

        java.util.Map<QName,​PropertyDefinition> getProperties()
        Returns:
        the properties of the class, including inherited properties
      • getDefaultValues

        java.util.Map<QName,​java.io.Serializable> getDefaultValues()
        Returns:
        a map containing the default property values, including inherited properties
      • isContainer

        boolean isContainer()
        Returns:
        true => this class supports child associations
      • getChildAssociations

        java.util.Map<QName,​ChildAssociationDefinition> getChildAssociations()
        Fetch only child associations for which this is a source type.
        Returns:
        all child associations applicable to this type, including those inherited from super types
      • getDefaultAspects

        java.util.List<AspectDefinition> getDefaultAspects()
        Returns:
        the default aspects associated with this type
      • getDefaultAspectNames

        java.util.Set<QName> getDefaultAspectNames()
        Returns:
        the set of default aspects names associated with this type
      • getDefaultAspects

        java.util.List<AspectDefinition> getDefaultAspects​(boolean inherited)
        Parameters:
        inherited - include default aspects inherited from super types
        Returns:
        the default aspects
      • getAnalyserResourceBundleName

        java.lang.String getAnalyserResourceBundleName()
        Get the name of the property bundle that defines analyser mappings for this class (keyed by the type of the property)
        Returns:
        the resource or null if not set.
      • getParentClassDefinition

        ClassDefinition getParentClassDefinition()
        Get the parent class definition
        Returns:
        ClassDefinition