org.nuxeo.ecm.platform.classification

Interface ClassificationActions

All Superinterfaces:

ResultsProviderFarm, Serializable

All Known Implementing Classes:

ClassificationActionsBean

public interface ClassificationActions
extends ResultsProviderFarm, Serializable

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASSIFICATION_ROOTS_PROVIDER_NAME
static String	CURRENT_DOCUMENT_CLASSIFICATIONS_PROVIDER
static String	CURRENT_DOCUMENT_CLASSIFICATIONS_SELECTION
static String	CURRENT_SELECTION_FOR_CLASSIFICATION
static String	CURRENT_SELECTION_FOR_CLASSIFICATION_PAGE
static String	CURRENT_SELECTION_FOR_CLASSIFICATION_PROVIDER
static String	EVENT_CLASSIFICATION_TREE_CHANGED
static String	TREE_PLUGIN_NAME

Method Summary

Methods

Modifier and Type	Method and Description
String	cancelClassification()
String	cancelCurrentSelectionClassificationForm()
String	classify(ClassificationTreeNode node) Classifies current email or envelope in given folder and redirect to current page.
boolean	classify(Collection<DocumentModel> targetDocs, DocumentModel classificationFolder) Classifies given documents in given classification folder.
void	editableClassificationRootSelected(ValueChangeEvent event)
boolean	getCanClassifyFromCurrentSelection()
DocumentModelList	getClassificationRoots()
DocumentModel	getCurrentClassificationRoot()
String	getCurrentClassificationRootId()
DocumentTreeNode	getCurrentClassificationTree()
DocumentModelList	getCurrentDocumentClassifications()
SelectDataModel	getCurrentDocumentClassificationsSelection()
DocumentModel	getCurrentEditableClassificationRoot()
String	getCurrentEditableClassificationRootId()
DocumentTreeNode	getCurrentEditableClassificationTree()
SelectDataModel	getCurrentSelectionEmailsSelection() Returns select data model for selected documents from previous documents selection.
DocumentModelList	getEditableClassificationRoots()
Collection<DocumentModel>	getMassTargetDocuments() Returns selected target documents from a list of email documents.
PagedDocumentsProvider	getResultsProvider(String name) Makes a new, fresh instance of the named results provider.
PagedDocumentsProvider	getResultsProvider(String name, SortInfo sortInfo)
Collection<DocumentModel>	getTargetDocuments() Returns target documents when classifying an envelope.
String	massClassify(ClassificationTreeNode node) Classifies a list of emails in given folder and redirect to current page.
String	navigateToCurrentClassificationRoot()
void	resetClassificationData()
void	resetCurrentDocumentClassifications()
void	setCurrentClassificationRootId(String newRootId) Sets current classification root id, and set it as current document.
void	setCurrentEditableClassificationRootId(String newRootId)
String	showCurrentSelectionClassificationForm(String currentViewId) Returns classification form for selected documents
void	unclassify()
boolean	unclassify(Collection<String> targetDocIds, DocumentModel classificationFolder) Unclassifies given document ids in given classification folder.

Field Detail

EVENT_CLASSIFICATION_TREE_CHANGED

static final String EVENT_CLASSIFICATION_TREE_CHANGED

See Also:

Constant Field Values

CLASSIFICATION_ROOTS_PROVIDER_NAME

static final String CLASSIFICATION_ROOTS_PROVIDER_NAME

See Also:

Constant Field Values

CURRENT_DOCUMENT_CLASSIFICATIONS_PROVIDER

static final String CURRENT_DOCUMENT_CLASSIFICATIONS_PROVIDER

See Also:

Constant Field Values

CURRENT_DOCUMENT_CLASSIFICATIONS_SELECTION

static final String CURRENT_DOCUMENT_CLASSIFICATIONS_SELECTION

See Also:

Constant Field Values

CURRENT_SELECTION_FOR_CLASSIFICATION_PROVIDER

static final String CURRENT_SELECTION_FOR_CLASSIFICATION_PROVIDER

See Also:

Constant Field Values

CURRENT_SELECTION_FOR_CLASSIFICATION

static final String CURRENT_SELECTION_FOR_CLASSIFICATION

See Also:

Constant Field Values

CURRENT_SELECTION_FOR_CLASSIFICATION_PAGE

static final String CURRENT_SELECTION_FOR_CLASSIFICATION_PAGE

See Also:

Constant Field Values

TREE_PLUGIN_NAME

static final String TREE_PLUGIN_NAME

See Also:

Constant Field Values

Method Detail

getCanClassifyFromCurrentSelection

boolean getCanClassifyFromCurrentSelection()
                                           throws ClientException

Throws:

ClientException

getTargetDocuments

Collection<DocumentModel> getTargetDocuments()
                                             throws ClientException

Returns target documents when classifying an envelope.

May take into account only current email, or all emails in current envelope.

Throws:

ClientException

getMassTargetDocuments

Collection<DocumentModel> getMassTargetDocuments()
                                                 throws ClientException

Returns selected target documents from a list of email documents.

Throws:

ClientException

classify

String classify(ClassificationTreeNode node)
                throws ClientException

Classifies current email or envelope in given folder and redirect to current page.

Throws:

ClientException

massClassify

String massClassify(ClassificationTreeNode node)
                    throws ClientException

Classifies a list of emails in given folder and redirect to current page.

Throws:

ClientException

classify

boolean classify(Collection<DocumentModel> targetDocs,
               DocumentModel classificationFolder)
                 throws ClientException

Classifies given documents in given classification folder.

Returns:

true on error

Throws:

ClientException

cancelClassification

String cancelClassification()
                            throws ClientException

Throws:

ClientException

getCurrentClassificationRootId

String getCurrentClassificationRootId()
                                      throws ClientException

Throws:

ClientException

setCurrentClassificationRootId

void setCurrentClassificationRootId(String newRootId)
                                    throws ClientException

Sets current classification root id, and set it as current document.

Throws:

ClientException

navigateToCurrentClassificationRoot

String navigateToCurrentClassificationRoot()
                                           throws ClientException

Throws:

ClientException

getCurrentClassificationRoot

DocumentModel getCurrentClassificationRoot()
                                           throws ClientException

Throws:

ClientException

getCurrentEditableClassificationRootId

String getCurrentEditableClassificationRootId()
                                              throws ClientException

Throws:

ClientException

setCurrentEditableClassificationRootId

void setCurrentEditableClassificationRootId(String newRootId)
                                            throws ClientException

Throws:

ClientException

getCurrentEditableClassificationRoot

DocumentModel getCurrentEditableClassificationRoot()
                                                   throws ClientException

Throws:

ClientException

getCurrentClassificationTree

DocumentTreeNode getCurrentClassificationTree()
                                              throws ClientException

Throws:

ClientException

getCurrentEditableClassificationTree

DocumentTreeNode getCurrentEditableClassificationTree()
                                                      throws ClientException

Throws:

ClientException

getClassificationRoots

DocumentModelList getClassificationRoots()
                                         throws ClientException

Throws:

ClientException

getEditableClassificationRoots

DocumentModelList getEditableClassificationRoots()
                                                 throws ClientException

Throws:

ClientException

editableClassificationRootSelected

void editableClassificationRootSelected(ValueChangeEvent event)
                                        throws ClientException

Throws:

ClientException

resetClassificationData

void resetClassificationData()

resetCurrentDocumentClassifications

void resetCurrentDocumentClassifications()

getResultsProvider

PagedDocumentsProvider getResultsProvider(String name,
                                        SortInfo sortInfo)
                                          throws ClientException,
                                                 ResultsProviderFarmUserException

Specified by:

getResultsProvider in interface ResultsProviderFarm

Parameters:

name - the name of the ResultsProvider instance to create

sortInfo - an object containing the sort details

Throws:

ClientException

ResultsProviderFarmUserException

getResultsProvider

PagedDocumentsProvider getResultsProvider(String name)
                                          throws ClientException,
                                                 ResultsProviderFarmUserException

Description copied from interface: ResultsProviderFarm

Makes a new, fresh instance of the named results provider.

Specified by:

getResultsProvider in interface ResultsProviderFarm

Parameters:

name - the name of the ResultsProvider instance to create

Returns:

a PagedDocumentsProvider

Throws:

ClientException

ResultsProviderFarmUserException

getCurrentDocumentClassifications

DocumentModelList getCurrentDocumentClassifications()
                                                    throws ClientException

Throws:

ClientException

getCurrentDocumentClassificationsSelection

SelectDataModel getCurrentDocumentClassificationsSelection()
                                                           throws ClientException

Throws:

ClientException

showCurrentSelectionClassificationForm

String showCurrentSelectionClassificationForm(String currentViewId)
                                              throws ClientException

Returns classification form for selected documents

Parameters:

currentViewId - the current view id, so that redirection can be done correctly on cancel.

Throws:

ClientException

cancelCurrentSelectionClassificationForm

String cancelCurrentSelectionClassificationForm()
                                                throws ClientException

Throws:

ClientException

getCurrentSelectionEmailsSelection

SelectDataModel getCurrentSelectionEmailsSelection()
                                                   throws ClientException

Returns select data model for selected documents from previous documents selection.

Throws:

ClientException

unclassify

void unclassify()
                throws ClientException

Throws:

ClientException

unclassify

boolean unclassify(Collection<String> targetDocIds,
                 DocumentModel classificationFolder)
                   throws ClientException

Unclassifies given document ids in given classification folder.

Returns:

true on error

Throws:

ClientException