org.nuxeo.ecm.classification.api

Interface ClassificationService

All Known Implementing Classes:

ClassificationServiceImpl

public interface ClassificationService

Classification service is used to register classifiable Document Types.

Author:

ldoguin

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClassificationService.CLASSIFY_STATE
static class	ClassificationService.UNCLASSIFY_STATE

Method Summary

Methods

Modifier and Type	Method and Description
ClassificationResult<ClassificationService.CLASSIFY_STATE>	classify(DocumentModel classificationFolder, Collection<DocumentModel> targetDocs) Try to classify targets document into the classificationFolder.
ClassificationResult<ClassificationService.CLASSIFY_STATE>	classify(DocumentModel classificationFolder, String resolver, Collection<DocumentModel> targetDocs) Classify a list of documents associated them a resolver to perform complex resolution.
List<String>	getClassifiableDocumentTypes() Deprecated.
boolean	isClassifiable(DocumentModel doc) If this document is classifiable
boolean	isClassifiable(String docType) Deprecated.
String	resolveClassification(CoreSession session, String name, String targetDocId) Resolve the expected document id using the resolver contributed as name.
ClassificationResult<ClassificationService.UNCLASSIFY_STATE>	unClassify(DocumentModel classificationFolder, Collection<String> targetDocs) Try to unclassify targets document into the classificationFolder.
ClassificationResult<ClassificationService.UNCLASSIFY_STATE>	unClassifyFrom(Collection<DocumentModel> classificationFolders, String targetId) Try to unclassify targetId from classificationFolders.

Method Detail

getClassifiableDocumentTypes

@Deprecated
List<String> getClassifiableDocumentTypes()

Deprecated.

This will return only the document types that was contributed as classifiable. It is recommanded to use the facet Classifiable instead of the contribution.

Returns:

the list of registered Document Types as String

isClassifiable

@Deprecated
boolean isClassifiable(String docType)

Deprecated.

If this type of document is classifiable. It is recommanded to use isClassifiable(DocumentModel) and to addResolver the facet Classifiable to the classifiable document instead of use the contribution.

Parameters:

docType -

Returns:

true if the given doc type is registered.

isClassifiable

boolean isClassifiable(DocumentModel doc)

If this document is classifiable

Parameters:

doc -

Returns:

classify

ClassificationResult<ClassificationService.CLASSIFY_STATE> classify(DocumentModel classificationFolder,
                                                                  Collection<DocumentModel> targetDocs)
                                                                    throws ClientException

Try to classify targets document into the classificationFolder. Method return an object containing references to classified documents, already classified documents or invalid documents. Lists are not initialized until there is at least one corresponding documents.

Parameters:

classificationFolder - expected classification folder

targetDocs - documents wanted to be classified

Throws:

ClientException

Since:

5.7

classify

ClassificationResult<ClassificationService.CLASSIFY_STATE> classify(DocumentModel classificationFolder,
                                                                  String resolver,
                                                                  Collection<DocumentModel> targetDocs)
                                                                    throws ClientException

Classify a list of documents associated them a resolver to perform complex resolution.

Throws:

ClientException

Since:

5.7

unClassify

ClassificationResult<ClassificationService.UNCLASSIFY_STATE> unClassify(DocumentModel classificationFolder,
                                                                      Collection<String> targetDocs)
                                                                        throws ClientException

Try to unclassify targets document into the classificationFolder. Method return an object containing references to unclassified documents and not classified. Lists are not initialized until there is at least one corresponding documents.

Parameters:

classificationFolder - expected classification folder

targetDocs - documents id wanted to be unclassified

Throws:

ClientException

Since:

5.7

unClassifyFrom

ClassificationResult<ClassificationService.UNCLASSIFY_STATE> unClassifyFrom(Collection<DocumentModel> classificationFolders,
                                                                          String targetId)
                                                                            throws ClientException

Try to unclassify targetId from classificationFolders. Method return an object containing references to unclassified documents and not classified. Lists are not initialized until there is at least one corresponding documents.

Parameters:

targetId - whanted to be unclassified from specific container

Throws:

ClientException

Since:

5.7

resolveClassification

String resolveClassification(CoreSession session,
                           String name,
                           String targetDocId)
                             throws ClientException

Resolve the expected document id using the resolver contributed as name. Resolution is made with an Unrestricted session to prevent from document rights problem.

Throws:

ClientException

Since:

5.7