org.nuxeo.ecm.platform.classification

Class ClassificationActionsBean

java.lang.Object

org.nuxeo.ecm.platform.classification.ClassificationActionsBean

All Implemented Interfaces:

Serializable, ClassificationActions, ResultsProviderFarm

@Name(value="classificationActions")
@Scope(value=CONVERSATION)
public class ClassificationActionsBean
extends Object
implements ClassificationActions

Handles classification actions

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOCUMENTS_PAGE_SIZE_PROPERTY_NAME

Fields inherited from interface org.nuxeo.ecm.platform.classification.ClassificationActions

CLASSIFICATION_ROOTS_PROVIDER_NAME, CURRENT_DOCUMENT_CLASSIFICATIONS_PROVIDER, CURRENT_DOCUMENT_CLASSIFICATIONS_SELECTION, CURRENT_SELECTION_FOR_CLASSIFICATION, CURRENT_SELECTION_FOR_CLASSIFICATION_PAGE, CURRENT_SELECTION_FOR_CLASSIFICATION_PROVIDER, EVENT_CLASSIFICATION_TREE_CHANGED, TREE_PLUGIN_NAME

Constructor Summary

Constructors

Constructor and Description
ClassificationActionsBean()

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.
static int	getDocumentBatchSize()
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.

Methods inherited from class java.lang.Object

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

Field Detail

DOCUMENTS_PAGE_SIZE_PROPERTY_NAME

public static final String DOCUMENTS_PAGE_SIZE_PROPERTY_NAME

See Also:

Constant Field Values

Constructor Detail

ClassificationActionsBean

public ClassificationActionsBean()

Method Detail

getCanClassifyFromCurrentSelection

public boolean getCanClassifyFromCurrentSelection()
                                           throws ClientException

Specified by:

getCanClassifyFromCurrentSelection in interface ClassificationActions

Throws:

ClientException

getTargetDocuments

public Collection<DocumentModel> getTargetDocuments()
                                             throws ClientException

Description copied from interface: ClassificationActions

Returns target documents when classifying an envelope.

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

Specified by:

getTargetDocuments in interface ClassificationActions

Throws:

ClientException

classify

public String classify(ClassificationTreeNode node)
                throws ClientException

Description copied from interface: ClassificationActions

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

Specified by:

classify in interface ClassificationActions

Throws:

ClientException

getMassTargetDocuments

public Collection<DocumentModel> getMassTargetDocuments()
                                                 throws ClientException

Description copied from interface: ClassificationActions

Returns selected target documents from a list of email documents.

Specified by:

getMassTargetDocuments in interface ClassificationActions

Throws:

ClientException

massClassify

public String massClassify(ClassificationTreeNode node)
                    throws ClientException

Description copied from interface: ClassificationActions

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

Specified by:

massClassify in interface ClassificationActions

Throws:

ClientException

classify

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

Classifies given documents in given classification folder.

Specified by:

classify in interface ClassificationActions

Returns:

true on error

Throws:

ClientException

cancelClassification

public String cancelClassification()
                            throws ClientException

Specified by:

cancelClassification in interface ClassificationActions

Throws:

ClientException

getCurrentClassificationRootId

public String getCurrentClassificationRootId()
                                      throws ClientException

Specified by:

getCurrentClassificationRootId in interface ClassificationActions

Throws:

ClientException

setCurrentClassificationRootId

public void setCurrentClassificationRootId(String newRootId)
                                    throws ClientException

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

Specified by:

setCurrentClassificationRootId in interface ClassificationActions

Throws:

ClientException

navigateToCurrentClassificationRoot

public String navigateToCurrentClassificationRoot()
                                           throws ClientException

Specified by:

navigateToCurrentClassificationRoot in interface ClassificationActions

Throws:

ClientException

getCurrentClassificationRoot

public DocumentModel getCurrentClassificationRoot()
                                           throws ClientException

Specified by:

getCurrentClassificationRoot in interface ClassificationActions

Throws:

ClientException

getCurrentEditableClassificationRootId

@Factory(value="currentEditableClassificationRootId",
         scope=EVENT)
public String getCurrentEditableClassificationRootId()
                                              throws ClientException

Specified by:

getCurrentEditableClassificationRootId in interface ClassificationActions

Throws:

ClientException

setCurrentEditableClassificationRootId

public void setCurrentEditableClassificationRootId(String newRootId)
                                            throws ClientException

Specified by:

setCurrentEditableClassificationRootId in interface ClassificationActions

Throws:

ClientException

getCurrentEditableClassificationRoot

public DocumentModel getCurrentEditableClassificationRoot()
                                                   throws ClientException

Specified by:

getCurrentEditableClassificationRoot in interface ClassificationActions

Throws:

ClientException

getCurrentClassificationTree

@Factory(value="currentClassificationTree",
         scope=EVENT)
public DocumentTreeNode getCurrentClassificationTree()
                                              throws ClientException

Specified by:

getCurrentClassificationTree in interface ClassificationActions

Throws:

ClientException

getCurrentEditableClassificationTree

@Factory(value="currentEditableClassificationTree",
         scope=EVENT)
public DocumentTreeNode getCurrentEditableClassificationTree()
                                                      throws ClientException

Specified by:

getCurrentEditableClassificationTree in interface ClassificationActions

Throws:

ClientException

getClassificationRoots

@Factory(value="classificationRoots",
         scope=EVENT)
public DocumentModelList getClassificationRoots()
                                         throws ClientException

Specified by:

getClassificationRoots in interface ClassificationActions

Throws:

ClientException

getEditableClassificationRoots

@Factory(value="editableClassificationRoots",
         scope=EVENT)
public DocumentModelList getEditableClassificationRoots()
                                                 throws ClientException

Specified by:

getEditableClassificationRoots in interface ClassificationActions

Throws:

ClientException

editableClassificationRootSelected

public void editableClassificationRootSelected(ValueChangeEvent event)
                                        throws ClientException

Specified by:

editableClassificationRootSelected in interface ClassificationActions

Throws:

ClientException

resetClassificationData

@Observer(value={"goHome","domainSelectionChanged","documentChanged","documentSecurityChanged","documentChildrenChanged"},
          create=false)
public void resetClassificationData()

Specified by:

resetClassificationData in interface ClassificationActions

resetCurrentDocumentClassifications

@Observer(value={"goHome","domainSelectionChanged","documentSelectionChanged"},
          create=false)
public void resetCurrentDocumentClassifications()

Specified by:

resetCurrentDocumentClassifications in interface ClassificationActions

getResultsProvider

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

Specified by:

getResultsProvider in interface ClassificationActions

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

public 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 ClassificationActions

Specified by:

getResultsProvider in interface ResultsProviderFarm

Parameters:

name - the name of the ResultsProvider instance to create

Returns:

a PagedDocumentsProvider

Throws:

ClientException

ResultsProviderFarmUserException

getCurrentDocumentClassifications

@Factory(value="currentDocumentClassifications",
         scope=EVENT)
public DocumentModelList getCurrentDocumentClassifications()
                                                    throws ClientException

Specified by:

getCurrentDocumentClassifications in interface ClassificationActions

Throws:

ClientException

getCurrentDocumentClassificationsSelection

@Factory(value="currentDocumentClassificationsSelection",
         scope=EVENT)
public SelectDataModel getCurrentDocumentClassificationsSelection()
                                                           throws ClientException

Specified by:

getCurrentDocumentClassificationsSelection in interface ClassificationActions

Throws:

ClientException

showCurrentSelectionClassificationForm

public String showCurrentSelectionClassificationForm(String currentViewId)
                                              throws ClientException

Returns classification form for selected documents

Specified by:

showCurrentSelectionClassificationForm in interface ClassificationActions

Parameters:

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

Throws:

ClientException

cancelCurrentSelectionClassificationForm

public String cancelCurrentSelectionClassificationForm()
                                                throws ClientException

Specified by:

cancelCurrentSelectionClassificationForm in interface ClassificationActions

Throws:

ClientException

getCurrentSelectionEmailsSelection

@Factory(value="currentSelectionEmailsSelection",
         scope=EVENT)
public SelectDataModel getCurrentSelectionEmailsSelection()
                                                   throws ClientException

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

Specified by:

getCurrentSelectionEmailsSelection in interface ClassificationActions

Throws:

ClientException

unclassify

public void unclassify()
                throws ClientException

Specified by:

unclassify in interface ClassificationActions

Throws:

ClientException

unclassify

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

Unclassifies given document ids in given classification folder.

Specified by:

unclassify in interface ClassificationActions

Returns:

true on error

Throws:

ClientException

getDocumentBatchSize

public static int getDocumentBatchSize()