Classification Web Service

From AlfrescoWiki

Back to Alfresco Content Management Web Services.

This service provides support for classifying content resources.

Contents 1 Change Log 2 Types 2.1 CategoriesResult 2.2 AppliedCategory 3 Methods 3.1 getClassifications 3.2 getChildCategories 3.3 getCategories 3.4 setCategories 3.5 describeClassification

[edit] Change Log

• Classification Web Service Future Additions

[edit] Types

[edit] CategoriesResult

Encapsulates the details of categories applied to a reference.

• Reference node - the reference
• AppliedCategory[] categories - the category values applied to the reference

[edit] AppliedCategory

Encapsulates the values of a classification that has been applied.

• Name classification - the name of the classification
• Reference[] categories - the category values applied

[edit] Methods

[edit] getClassifications

Get available classifications.

Classification[] getClassifications(Store store)

Parameters:

• store - the store

Return:

• The available classifications.

[edit] getChildCategories

Get child categories for the specified parent category.

Category[] getChildCategories(Reference parentCategory)

[edit] getCategories

Get the categories applied to the specified content resource.

CategoriesResult[] getCategories(Predicate items)

[edit] setCategories

Modify the categories applied to the specified content resource.

CategoriesResult[] setCategories(Predicate items, AppliedCategory[] categories)

[edit] describeClassification

Describe a classification in terms of how it is represented in the meta model i.e. is it an aspect, which property holds the applied category.

ClassDefinition describeClassification(Name classification)