Classification Web Service

[resplin]

Obsolete Pages{{Obsolete}}

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

Web Services
Back to Alfresco Content Management Web Services.

This service provides support for classifying content resources.

Table of 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
  
  

Change Log

• Classification Web Service Future Additions
  

Types

CategoriesResult

Encapsulates the details of categories applied to a reference.

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

AppliedCategory

Encapsulates the values of a classification that has been applied.

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

Methods

getClassifications

Get available classifications.

Classification[] getClassifications(Store store)

Parameters:

• store - the store
  

Return:

• The available classifications.
  

getChildCategories

Get child categories for the specified parent category.

Category[] getChildCategories(Reference parentCategory)

getCategories

Get the categories applied to the specified content resource.

CategoriesResult[] getCategories(Predicate items)

setCategories

Modify the categories applied to the specified content resource.

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

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)