public interface DocumentsListsManager
Managing the DM lists into this component insteed of directly inside the Seam context offers the following advantages:
Modifier and Type | Field and Description |
---|---|
static String |
CLIPBOARD
List identifier: Clipboard list.
|
static String |
CURRENT_DOCUMENT_SECTION_SELECTION
List identifier: Stores the current selection of published documents.
|
static String |
CURRENT_DOCUMENT_SELECTION
List identifier: Stores the current selection of documents.
|
static String |
CURRENT_DOCUMENT_TRASH_SELECTION
List identifier: Stores the current selection of deleted documents.
|
static String |
CURRENT_VERSION_SELECTION
List identifier: Stores the current selection of versions.
|
static String |
DEFAULT_WORKING_LIST
List identifier: Default working list.
|
Modifier and Type | Method and Description |
---|---|
List<DocumentModel> |
addToWorkingList(DocumentModel doc)
Adds one document to the default list.
|
List<DocumentModel> |
addToWorkingList(List<DocumentModel> docList)
Adds a list of DocumentModels to the default list.
|
List<DocumentModel> |
addToWorkingList(String listName,
DocumentModel doc)
Adds one document to the list listName.
|
List<DocumentModel> |
addToWorkingList(String listName,
List<DocumentModel> docList)
Adds a list of DocumentModels to the list ListName.
|
List<DocumentModel> |
addToWorkingList(String listName,
List<DocumentModel> docList,
Boolean forceAppend)
Adds a list of DocumentModels to the list ListName.
|
void |
createWorkingList(String listName,
DocumentsListDescriptor descriptor)
Creates (declares) a new named list of documents.
|
List<DocumentModel> |
getWorkingList()
Returns the default list.
|
List<DocumentModel> |
getWorkingList(String listName)
Returns the list listName.
|
DocumentsListDescriptor |
getWorkingListDescriptor()
Gets the descriptor (meta-data) of a default list.
|
DocumentsListDescriptor |
getWorkingListDescriptor(String listName)
Gets the descriptor (meta-data) of a given list.
|
List<String> |
getWorkingListNamesForCategory(String categoryName)
Returns the availables lists names for a given category.
|
List<String> |
getWorkingListTypes()
Returns the list of document types contained in the default list.
|
List<String> |
getWorkingListTypes(String listName)
Returns the list of document types contained into the list ListName.
|
void |
initListManager()
Init Method (replaces for now Registry initialization that will be done by the extension point and the Runtime).
|
boolean |
isWorkingListEmpty()
Checks if default list is empty.
|
boolean |
isWorkingListEmpty(String listName)
Check is list listName is empty.
|
void |
refreshLists(DocumentModel currentDocument)
Method called by Seam event service to reset lists.
|
void |
removeFromAllLists(List<DocumentModel> documentsToRemove)
Removes documentsToRemove from all lists.
|
List<DocumentModel> |
removeFromWorkingList(DocumentModel doc)
Removes one DocumentModel from the default list.
|
List<DocumentModel> |
removeFromWorkingList(String listName,
DocumentModel doc)
Removes one DocumentModel from the list ListName.
|
List<DocumentModel> |
removeFromWorkingList(String listName,
List<DocumentModel> lst) |
List<DocumentModel> |
resetWorkingList()
Removes DocumentModels from the default list.
|
List<DocumentModel> |
resetWorkingList(List<DocumentModel> newDocList)
Resets default list and fills it with newDocList.
|
List<DocumentModel> |
resetWorkingList(String listName)
Removes DocumentModels from the list ListName.
|
List<DocumentModel> |
resetWorkingList(String listName,
List<DocumentModel> newDocList)
Resets list listName and fill it with newDocList.
|
void |
setWorkingList(List<DocumentModel> docList)
Updates the default list.
|
void |
setWorkingList(String listName,
List<DocumentModel> docList)
Updates the list listName.
|
static final String DEFAULT_WORKING_LIST
static final String CLIPBOARD
static final String CURRENT_DOCUMENT_SELECTION
static final String CURRENT_DOCUMENT_TRASH_SELECTION
static final String CURRENT_DOCUMENT_SECTION_SELECTION
static final String CURRENT_VERSION_SELECTION
void createWorkingList(String listName, DocumentsListDescriptor descriptor)
listName
- Name of the listList<DocumentModel> getWorkingList(String listName)
listName
- Name of the listList<DocumentModel> getWorkingList()
List<String> getWorkingListTypes(String listName)
listName
- Name of the list to retrieveList<String> getWorkingListTypes()
void setWorkingList(String listName, List<DocumentModel> docList)
listName
- Name of the list to updatedocList
- the DocumentModel list to store in the list ListNamevoid setWorkingList(List<DocumentModel> docList)
docList
- the DocumentModel list to store in the default listList<DocumentModel> addToWorkingList(String listName, DocumentModel doc)
listName
- the name of the list to updatedoc
- the doc to appendList<DocumentModel> addToWorkingList(DocumentModel doc)
doc
- List<DocumentModel> addToWorkingList(String listName, List<DocumentModel> docList)
listName
- the name of the list to updatedocList
- the DocumentModels list to appendList<DocumentModel> addToWorkingList(String listName, List<DocumentModel> docList, Boolean forceAppend)
listName
- the name of the list to updatedocList
- the DocumentModels list to appendforceAppend
- force the new elements to be appened even if the list default behaviour is resetList<DocumentModel> addToWorkingList(List<DocumentModel> docList)
docList
- List<DocumentModel> removeFromWorkingList(String listName, DocumentModel doc)
listName
- doc
- List<DocumentModel> removeFromWorkingList(String listName, List<DocumentModel> lst)
List<DocumentModel> removeFromWorkingList(DocumentModel doc)
doc
- List<DocumentModel> resetWorkingList(String listName)
listName
- List<DocumentModel> resetWorkingList()
List<DocumentModel> resetWorkingList(String listName, List<DocumentModel> newDocList)
listName
- newDocList
- List<DocumentModel> resetWorkingList(List<DocumentModel> newDocList)
newDocList
- boolean isWorkingListEmpty(String listName)
listName
- boolean isWorkingListEmpty()
@Observer(value="documentSelectionChanged", create=false) void refreshLists(DocumentModel currentDocument)
void removeFromAllLists(List<DocumentModel> documentsToRemove)
documentsToRemove
- void initListManager()
List<String> getWorkingListNamesForCategory(String categoryName)
categoryName
- DocumentsListDescriptor getWorkingListDescriptor(String listName)
listName
- DocumentsListDescriptor getWorkingListDescriptor()
Copyright © 2015 Nuxeo SA. All rights reserved.