Dictionary Web Service

Document created by resplin Employee on Jun 6, 2015
Version 1Show Document
  • View in full screen mode

Obsolete Pages{{Obsolete}}

The official documentation is at: http://docs.alfresco.com



Web ServicesBack to Alfresco Content Management Web Services.




The Dictionary web service.


Data Types


ClassPredicate


A ClassPredicate provides control of which classes are returned.


  • xsd:string[] classNames - restrict to the list of explicitly specified class names
  • xsd:boolean followSubClass - follow sub-classes and include in returned list
  • xsd:boolean followSuperClass - follow super-classes and include in returned list

Methods


getClasses


Get a list of type and aspect definitions from the dictionary.

ClassDefinition[] getClasses(ClassPredicate types, ClassPredicate aspects)

Parameters:


  • types - the predicate for controlling the types returned, or null to return all types
  • aspects - the predicate for controlling the aspects returned, or null to return all aspects

Return:


  • a list of class definitions that relate to the requested types.

getProperties


Gets a list of property definitions.

PropertyDefinition[] getProperties(xsd:string[] propertyNames)

Parameters:


  • propertyNames - a list of the names of the properties for which defintions are required. 

Return:


  • a list of the requested property defintions.

getAssociations


Gets a list of association definitions.

AssociationDefinition[] getAssociationDefinition(xsd:string[] associationNames)

Parameters:


  • associationNames - the qualified name of the associations to request defintions for

Returns:


  • list of the requested association definitions

isSubClass


Indicates whether a type (or aspect) is a sub class of another type (or aspect).

xsd:boolean isSubClassOf(xsd:string className, xsd:string isSubClassOfName)

Parameters:


  • className - the qualified name of the type or aspect to test.
  • isSubClassOf - the qualified name of the type or aspect that the other class is being tested as being a sub class of.

Return:


  • true indicates that the class is a sub-class of the other

Attachments

    Outcomes