@PublicService
public interface DictionaryService
{
/**
* @return the names of all models that have been registered with the Repository
*/
@NotAuditable
public Collection<QName> getAllModels();
/**
* @param model the model name to retrieve
* @return the specified model (or null, if it doesn't exist)
*/
@NotAuditable
public ModelDefinition getModel(QName model);
/**
* @return the names of all data types that have been registered with the Repository
*/
@NotAuditable
Collection<QName> getAllDataTypes();
/**
* @param model the model to retrieve data types for
* @return the names of all data types defined within the specified model
*/
@NotAuditable
Collection<QName> getDataTypes(QName model);
/**
* @param name the name of the data type to retrieve
* @return the data type definition (or null, if it doesn't exist)
*/
@NotAuditable
DataTypeDefinition getDataType(QName name);
/**
* @param javaClass java class to find datatype for
* @return the data type definition (or null, if a mapping does not exist)
*/
@NotAuditable
DataTypeDefinition getDataType(Class javaClass);
/**
* @return the names of all types that have been registered with the Repository
*/
@NotAuditable
Collection<QName> getAllTypes();
/**
* @param model the model to retrieve types for
* @return the names of all types defined within the specified model
*/
@NotAuditable
Collection<QName> getTypes(QName model);
/**
* @param name the name of the type to retrieve
* @return the type definition (or null, if it doesn't exist)
*/
@NotAuditable
TypeDefinition getType(QName name);
/**
* Construct an anonymous type that combines the definitions of the specified
* type and aspects.
*
* @param type the type to start with
* @param aspects the aspects to combine with the type
* @return the anonymous type definition
*/
@NotAuditable
TypeDefinition getAnonymousType(QName type, Collection<QName> aspects);
/**
* @return the names of all aspects that have been registered with the Repository
*/
@NotAuditable
Collection<QName> getAllAspects();
/**
* @param model the model to retrieve aspects for
* @return the names of all aspects defined within the specified model
*/
@NotAuditable
Collection<QName> getAspects(QName model);
/**
* @param name the name of the aspect to retrieve
* @return the aspect definition (or null, if it doesn't exist)
*/
@NotAuditable
AspectDefinition getAspect(QName name);
/**
* @param name the name of the class (type or aspect) to retrieve
* @return the class definition (or null, if it doesn't exist)
*/
@NotAuditable
ClassDefinition getClass(QName name);
/**
* Determines whether a class is a sub-class of another class
*
* @param className the sub-class to test
* @param ofClassName the class to test against
* @return true => the class is a sub-class (or itself)
*/
@NotAuditable
boolean isSubClass(QName className, QName ofClassName);
/**
* Gets the definition of the property as defined by the specified Class.
*
* Note: A sub-class may override the definition of a property that's
* defined in a super-class.
*
* @param className the class name
* @param propertyName the property name
* @return the property definition (or null, if it doesn't exist)
*/
@NotAuditable
PropertyDefinition getProperty(QName className, QName propertyName);
/**
* Gets the definition of the property as defined by its owning Class.
*
* @param propertyName the property name
* @return the property definition (or null, if it doesn't exist)
*/
@NotAuditable
PropertyDefinition getProperty(QName propertyName);
/**
* Get all properties defined across all models with the given data type.
*
* Note that DataTypeDefinition.ANY will only match this type and can not be used as get all properties.
*
* If dataType is null then this method will return *ALL* properties regardless of data type.
*
* @param dataType
* @return
*/
@NotAuditable
Collection<QName> getAllProperties(QName dataType);
/**
* Get all properties defined for the given model with the given data type.
*
* Note that DataTypeDefinition.ANY will only match this type and can not be used as get all properties.
*
* If dataType is null then this method will return *ALL* properties regardless of data type.
*
* @param dataType
* @return
*/
@NotAuditable
Collection<QName> getProperties(QName model, QName dataType);
/**
* Get all poroperties for the specified model
*
* @param model
* @return
*/
Collection<QName> getProperties(QName model);
/**
* Gets the definition of the association as defined by its owning Class.
*
* @param associationName the property name
* @return the association definition (or null, if it doesn't exist)
*/
@NotAuditable
AssociationDefinition getAssociation(QName associationName);
// TODO: Behaviour definitions
}
Content from pre 2016 and from language groups that have been closed.
Content is read-only.
By using this site, you are agreeing to allow us to collect and use cookies as outlined in Alfresco’s Cookie Statement and Terms of Use (and you have a legitimate interest in Alfresco and our products, authorizing us to contact you in such methods). If you are not ok with these terms, please do not use this website.