org.alfresco.repo.webservice.classification

Class ClassificationWebService

java.lang.Object

org.alfresco.repo.webservice.AbstractWebService

org.alfresco.repo.webservice.classification.ClassificationWebService

All Implemented Interfaces:

Remote, ClassificationServiceSoapPort

public class ClassificationWebService
extends AbstractWebService
implements ClassificationServiceSoapPort

Web service implementation of the ClassificationService. The WSDL for this service can be accessed from http://localhost:8080/alfresco/wsdl/classification-service.wsdl

Author:

gavinc

Field Summary

Fields inherited from class org.alfresco.repo.webservice.AbstractWebService

contentService, namespaceService, nodeService, querySessionCache, searchService, serviceRegistry

Constructor Summary

Constructors

Constructor and Description
ClassificationWebService()

Method Summary

Methods

Modifier and Type	Method and Description
ClassDefinition	describeClassification(String classification) Describe a classification in terms of how it is represented in the meta model i.e.
CategoriesResult[]	getCategories(Predicate items) Gets the categories applied to the specified content resource.
Category[]	getChildCategories(Reference parentCategory) Gets child categories for the specified parent category.
Classification[]	getClassifications(Store store) Gets available classifications.
CategoriesResult[]	setCategories(Predicate items, AppliedCategory[] categories) Modifies the categories applied to the specified content resource.
void	setCategoryService(CategoryService categoryService) Set the category service
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService) Set the dictionary service
void	setTransactionService(TransactionService transactionService) Set the transaction service

Methods inherited from class org.alfresco.repo.webservice.AbstractWebService

setContentService, setNamespaceService, setNodeService, setQuerySessionCache, setSearchService, setServiceRegistry

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClassificationWebService

public ClassificationWebService()

Method Detail

setCategoryService

public void setCategoryService(CategoryService categoryService)

Set the category service

Parameters:

categoryService - the category service

setTransactionService

public void setTransactionService(TransactionService transactionService)

Set the transaction service

Parameters:

transactionService - the transaction service

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

Set the dictionary service

Overrides:

setDictionaryService in class AbstractWebService

Parameters:

dictionaryService - the dictionary service

getClassifications

public Classification[] getClassifications(Store store)
                                    throws RemoteException,
                                           ClassificationFault

Description copied from interface: ClassificationServiceSoapPort

Gets available classifications.

Specified by:

getClassifications in interface ClassificationServiceSoapPort

Throws:

RemoteException

ClassificationFault

See Also:

org.alfresco.repo.webservice.classification.ClassificationServiceSoapPort#getClassifications()

getChildCategories

public Category[] getChildCategories(Reference parentCategory)
                              throws RemoteException,
                                     ClassificationFault

Description copied from interface: ClassificationServiceSoapPort

Gets child categories for the specified parent category.

Specified by:

getChildCategories in interface ClassificationServiceSoapPort

Throws:

RemoteException

ClassificationFault

See Also:

ClassificationServiceSoapPort.getChildCategories(org.alfresco.repo.webservice.types.Reference)

getCategories

public CategoriesResult[] getCategories(Predicate items)
                                 throws RemoteException,
                                        ClassificationFault

Description copied from interface: ClassificationServiceSoapPort

Gets the categories applied to the specified content resource.

Specified by:

getCategories in interface ClassificationServiceSoapPort

Throws:

RemoteException

ClassificationFault

See Also:

ClassificationServiceSoapPort.getCategories(org.alfresco.repo.webservice.types.Predicate)

setCategories

public CategoriesResult[] setCategories(Predicate items,
                               AppliedCategory[] categories)
                                 throws RemoteException,
                                        ClassificationFault

Description copied from interface: ClassificationServiceSoapPort

Modifies the categories applied to the specified content resource.

Specified by:

setCategories in interface ClassificationServiceSoapPort

Throws:

RemoteException

ClassificationFault

See Also:

ClassificationServiceSoapPort.setCategories(org.alfresco.repo.webservice.types.Predicate, org.alfresco.repo.webservice.classification.AppliedCategory[])

describeClassification

public ClassDefinition describeClassification(String classification)
                                       throws RemoteException,
                                              ClassificationFault

Description copied from interface: ClassificationServiceSoapPort

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.

Specified by:

describeClassification in interface ClassificationServiceSoapPort

Throws:

RemoteException

ClassificationFault

See Also:

org.alfresco.repo.webservice.classification.ClassificationServiceSoapPort#describeClassification(org.alfresco.repo.webservice.types.Reference)