Interface ClassDefinition
- All Known Subinterfaces:
AspectDefinition
,TypeDefinition
Read-only definition of a Class.
- Author:
- David Caruana
-
Method Summary
Modifier and TypeMethodDescriptionFetch all associations for which this is a source type, including child associations.Fetch only child associations for which this is a source type.getDefaultAspects
(boolean inherited) Deprecated.The problem identified in MNT-413 will still existgetDescription
(MessageLookup messageLookup) getModel()
getName()
Get the parent class definitiongetTitle()
Deprecated.The problem identified in MNT-413 will still existgetTitle
(MessageLookup messageLookup) boolean
isAspect()
boolean
-
Method Details
-
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
- Returns:
- the human-readable class title
-
getDescription
- 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:
-
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
- Returns:
- the set of default aspects names associated with this type
-
getDefaultAspects
- Parameters:
inherited
- include default aspects inherited from super types- Returns:
- the default aspects
-
getParentClassDefinition
ClassDefinition getParentClassDefinition()Get the parent class definition- Returns:
- ClassDefinition
-