Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.alfresco.service.cmr.dictionary
Interface ClassDefinition
All Known Subinterfaces:
AspectDefinition, TypeDefinition

@org.alfresco.api.AlfrescoPublicApi
public interface ClassDefinition
Read-only definition of a Class.
Author:
David Caruana

Method Summary
getAnalyserResourceBundleName()
          Get the name of the property bundle that defines analyser mappings for this class (keyed by the type of the property)
getArchive()
getAssociations()
          Fetch all associations for which this is a source type, including child associations.
getChildAssociations()
          Fetch only child associations for which this is a source type.
getDefaultAspectNames()
getDefaultAspects()
getDefaultAspects(boolean inherited)
getDefaultValues()
getDescription()
          Deprecated. The problem identified in MNT-413 will still exist
getDescription(MessageLookup messageLookup)
getIncludedInSuperTypeQuery()
getModel()
getName()
getParentClassDefinition()
          Get the parent class definition
getParentName()
getProperties()
getTitle()
          Deprecated. The problem identified in MNT-413 will still exist
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 or null if not defined.

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

getProperties
Map<QName,PropertyDefinitiongetProperties()
Returns:
the properties of the class, including inherited properties

getDefaultValues
Map<QName,SerializablegetDefaultValues()
Returns:
a map containing the default property values, including inherited properties

getAssociations
Map<QName,AssociationDefinitiongetAssociations()
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,ChildAssociationDefinitiongetChildAssociations()
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<AspectDefinitiongetDefaultAspects()
Returns:
the default aspects associated with this type

getDefaultAspectNames
Set<QNamegetDefaultAspectNames()
Returns:
the set of default aspects names associated with this type

getDefaultAspects
List<AspectDefinitiongetDefaultAspects(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

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2005–2018 Alfresco Software. All rights reserved.

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.