Interface ClassDefinition
-
- All Known Subinterfaces:
AspectDefinition
,TypeDefinition
@AlfrescoPublicApi public interface ClassDefinition
Read-only definition of a Class.- Author:
- David Caruana
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description String
getAnalyserResourceBundleName()
Get the name of the property bundle that defines analyser mappings for this class (keyed by the type of the property)Boolean
getArchive()
Map<QName,AssociationDefinition>
getAssociations()
Fetch all associations for which this is a source type, including child associations.Map<QName,ChildAssociationDefinition>
getChildAssociations()
Fetch only child associations for which this is a source type.Set<QName>
getDefaultAspectNames()
List<AspectDefinition>
getDefaultAspects()
List<AspectDefinition>
getDefaultAspects(boolean inherited)
Map<QName,Serializable>
getDefaultValues()
String
getDescription()
Deprecated.The problem identified in MNT-413 will still existString
getDescription(MessageLookup messageLookup)
Boolean
getIncludedInSuperTypeQuery()
ModelDefinition
getModel()
QName
getName()
ClassDefinition
getParentClassDefinition()
Get the parent class definitionQName
getParentName()
Map<QName,PropertyDefinition>
getProperties()
String
getTitle()
Deprecated.The problem identified in MNT-413 will still existString
getTitle(MessageLookup messageLookup)
boolean
isAspect()
boolean
isContainer()
-
-
-
Method Detail
-
getModel
ModelDefinition getModel()
- Returns:
- defining model
-
getName
QName getName()
- Returns:
- the qualified name of the class
-
getTitle
String getTitle()
Deprecated.The problem identified in MNT-413 will still exist
-
getDescription
String getDescription()
Deprecated.The problem identified in MNT-413 will still exist
-
getTitle
String getTitle(MessageLookup messageLookup)
- Returns:
- the human-readable class title
-
getDescription
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
Boolean getArchive()
- Returns:
- Return
true
if the type should be archived on delete,false
if it should be deleted ornull
if not defined.
-
getIncludedInSuperTypeQuery
Boolean getIncludedInSuperTypeQuery()
- Returns:
- Return
true
if the type should be included in supertypes queries,false
if not deleted ornull
if not defined.
-
getProperties
Map<QName,PropertyDefinition> getProperties()
- Returns:
- the properties of the class, including inherited properties
-
getDefaultValues
Map<QName,Serializable> getDefaultValues()
- Returns:
- a map containing the default property values, including inherited properties
-
getAssociations
Map<QName,AssociationDefinition> getAssociations()
Fetch all associations for which this is a source type, including child associations.- Returns:
- the associations including inherited ones
- See Also:
ChildAssociationDefinition
-
isContainer
boolean isContainer()
- Returns:
- true => this class supports child associations
-
getChildAssociations
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
List<AspectDefinition> getDefaultAspects()
- Returns:
- the default aspects associated with this type
-
getDefaultAspectNames
Set<QName> getDefaultAspectNames()
- Returns:
- the set of default aspects names associated with this type
-
getDefaultAspects
List<AspectDefinition> getDefaultAspects(boolean inherited)
- Parameters:
inherited
- include default aspects inherited from super types- Returns:
- the default aspects
-
getAnalyserResourceBundleName
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
-
-