org.alfresco.service.cmr.dictionary

Interface ClassDefinition

All Known Subinterfaces:

AspectDefinition, TypeDefinition

@AlfrescoPublicApi
public interface ClassDefinition

Read-only definition of a Class.

Method Summary

Methods

Modifier and Type	Method and Description
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)
java.lang.Boolean	getArchive()
java.util.Map	getAssociations() Fetch all associations for which this is a source type, including child associations.
java.util.Map	getChildAssociations() Fetch only child associations for which this is a source type.
java.util.Set	getDefaultAspectNames()
java.util.List	getDefaultAspects()
java.util.List	getDefaultAspects(boolean inherited)
java.util.Map	getDefaultValues()
java.lang.String	getDescription() Deprecated. The problem identified in MNT-413 will still exist
java.lang.String	getDescription(MessageLookup messageLookup)
java.lang.Boolean	getIncludedInSuperTypeQuery()
ModelDefinition	getModel()
QName	getName()
ClassDefinition	getParentClassDefinition() Get the parent class definition
QName	getParentName()
java.util.Map	getProperties()
java.lang.String	getTitle() Deprecated. The problem identified in MNT-413 will still exist
java.lang.String	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

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 getProperties()

Returns:

the properties of the class, including inherited properties

getDefaultValues

java.util.Map getDefaultValues()

Returns:

a map containing the default property values, including inherited properties

getAssociations

java.util.Map 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

java.util.Map 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 getDefaultAspects()

Returns:

the default aspects associated with this type

getDefaultAspectNames

java.util.Set getDefaultAspectNames()

Returns:

the set of default aspects names associated with this type

getDefaultAspects

java.util.List 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: