@AlfrescoPublicApi public interface DictionaryService extends MessageLookup
Modifier and Type | Method and Description |
---|---|
Collection<QName> |
getAllAspects() |
Collection<QName> |
getAllAspects(boolean includeInherited) |
Collection<QName> |
getAllAssociations()
Get all the association definitions
|
Collection<QName> |
getAllAssociations(boolean includeInherited) |
Collection<QName> |
getAllDataTypes() |
Collection<QName> |
getAllModels() |
Collection<QName> |
getAllProperties(QName dataType)
Get all properties defined across all models with the given data type.
|
Collection<QName> |
getAllTypes() |
Collection<QName> |
getAllTypes(boolean includeInherited) |
TypeDefinition |
getAnonymousType(QName name)
Creates an anonymous
TypeDefinition with all the mandatory Aspects applied. |
TypeDefinition |
getAnonymousType(QName type,
Collection<QName> aspects)
Construct an anonymous type that combines the definitions of the specified
type and aspects.
|
AspectDefinition |
getAspect(QName name) |
Collection<QName> |
getAspects(QName model) |
AssociationDefinition |
getAssociation(QName associationName)
Gets the definition of the association as defined by its owning Class.
|
Collection<QName> |
getAssociations(QName model) |
ClassDefinition |
getClass(QName name) |
ConstraintDefinition |
getConstraint(QName constraintQName)
Gets the definition of the constraint
|
Collection<ConstraintDefinition> |
getConstraints(QName model)
Get constraints for the specified model
|
Collection<ConstraintDefinition> |
getConstraints(QName model,
boolean referenceableDefsOnly)
Get constraints for the specified model
Optionally return referenceable (ie.
|
DataTypeDefinition |
getDataType(Class<?> javaClass) |
DataTypeDefinition |
getDataType(QName name) |
Collection<QName> |
getDataTypes(QName model) |
ModelDefinition |
getModel(QName model) |
ModelDefinition |
getModelByNamespaceUri(String uri) |
Collection<QName> |
getProperties(QName model)
Get all properties for the specified model
|
Collection<QName> |
getProperties(QName model,
QName dataType)
Get all properties defined for the given model with the given data type.
|
PropertyDefinition |
getProperty(QName propertyName)
Gets the definition of the property as defined by its owning Class.
|
PropertyDefinition |
getProperty(QName className,
QName propertyName)
Gets the definition of the property as defined by the specified Class.
|
Map<QName,PropertyDefinition> |
getPropertyDefs(QName className)
Gets the definitions of the properties defined by the specified Class.
|
Collection<QName> |
getSubAspects(QName aspect,
boolean follow) |
Collection<QName> |
getSubTypes(QName type,
boolean follow)
Get the sub types of the type.
|
TypeDefinition |
getType(QName name) |
Collection<QName> |
getTypes(QName model) |
boolean |
isSubClass(QName className,
QName ofClassName)
Determines whether a class is a sub-class of another class
|
getMessage, getMessage, getMessage, getMessage
@NotAuditable Collection<QName> getAllModels()
@NotAuditable ModelDefinition getModel(QName model)
model
- the model name to retrieve@NotAuditable Collection<QName> getAllDataTypes()
@NotAuditable Collection<QName> getDataTypes(QName model)
model
- the model to retrieve data types for@NotAuditable DataTypeDefinition getDataType(QName name)
name
- the name of the data type to retrieve@NotAuditable DataTypeDefinition getDataType(Class<?> javaClass)
javaClass
- java class to find datatype for@NotAuditable Collection<QName> getAllTypes()
@NotAuditable Collection<QName> getAllTypes(boolean includeInherited)
@NotAuditable Collection<QName> getSubTypes(QName type, boolean follow)
type
- the qualified name of the typefollow
- true => all sub-type descendants, false => immediate sub-type children@NotAuditable Collection<QName> getTypes(QName model)
model
- the model to retrieve types for@NotAuditable TypeDefinition getType(QName name)
name
- the name of the type to retrieve@NotAuditable TypeDefinition getAnonymousType(QName type, Collection<QName> aspects)
type
- the type to start withaspects
- the aspects to combine with the typeTypeDefinition getAnonymousType(QName name)
TypeDefinition
with all the mandatory Aspects
applied.
This collapses all mandatory Aspects
into a single TypeDefinition
.name
- the name of the type definition.@NotAuditable Collection<QName> getAllAspects()
@NotAuditable Collection<QName> getAllAspects(boolean includeInherited)
@NotAuditable Collection<QName> getSubAspects(QName aspect, boolean follow)
aspect
- QNamefollow
- true => follow up the super-class hierarchy, false => immediate sub aspects only@NotAuditable Collection<QName> getAspects(QName model)
model
- the model to retrieve aspects for@NotAuditable Collection<QName> getAssociations(QName model)
model
- the model to retrieve associations for@NotAuditable AspectDefinition getAspect(QName name)
name
- the name of the aspect to retrieve@NotAuditable ClassDefinition getClass(QName name)
name
- the name of the class (type or aspect) to retrieve@NotAuditable boolean isSubClass(QName className, QName ofClassName)
className
- the sub-class to testofClassName
- the class to test against@NotAuditable PropertyDefinition getProperty(QName className, QName propertyName)
className
- the class namepropertyName
- the property name@NotAuditable Map<QName,PropertyDefinition> getPropertyDefs(QName className)
className
- the class name@NotAuditable PropertyDefinition getProperty(QName propertyName)
propertyName
- the property name@NotAuditable Collection<QName> getAllProperties(QName dataType)
dataType
- QName@NotAuditable Collection<QName> getProperties(QName model, QName dataType)
model
- QNamedataType
- QNameCollection<QName> getProperties(QName model)
model
- QName@NotAuditable AssociationDefinition getAssociation(QName associationName)
associationName
- the property name@NotAuditable Collection<QName> getAllAssociations()
@NotAuditable Collection<QName> getAllAssociations(boolean includeInherited)
@NotAuditable ConstraintDefinition getConstraint(QName constraintQName)
constraintQName
- the constraint nameCollection<ConstraintDefinition> getConstraints(QName model)
model
- QNameCollection<ConstraintDefinition> getConstraints(QName model, boolean referenceableDefsOnly)
model
- QNamereferenceableDefsOnly
- booleanModelDefinition getModelByNamespaceUri(String uri)
uri
- the namespace uri for search forCopyright © 2005–2016 Alfresco Software. All rights reserved.