|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocumentsListsManager
Seam component used to manage named lists of documents.
Managing the DM lists into this component insteed of directly inside the Seam context offers the following advantages:
Field Summary | |
---|---|
static java.lang.String |
CLIPBOARD
List identifier: Clipboard list. |
static java.lang.String |
CURRENT_DOCUMENT_SECTION_SELECTION
List identifier: Stores the current selection of published documents. |
static java.lang.String |
CURRENT_DOCUMENT_SELECTION
List identifier: Stores the current selection of documents. |
static java.lang.String |
CURRENT_DOCUMENT_TRASH_SELECTION
List identifier: Stores the current selection of deleted documents. |
static java.lang.String |
DEFAULT_WORKING_LIST
List identifier: Default working list. |
Method Summary | |
---|---|
java.util.List<DocumentModel> |
addToWorkingList(DocumentModel doc)
Adds one document to the default list. |
java.util.List<DocumentModel> |
addToWorkingList(java.util.List<DocumentModel> docList)
Adds a list of DocumentModels to the default list. |
java.util.List<DocumentModel> |
addToWorkingList(java.lang.String listName,
DocumentModel doc)
Adds one document to the list listName. |
java.util.List<DocumentModel> |
addToWorkingList(java.lang.String listName,
java.util.List<DocumentModel> docList)
Adds a list of DocumentModels to the list ListName. |
java.util.List<DocumentModel> |
addToWorkingList(java.lang.String listName,
java.util.List<DocumentModel> docList,
java.lang.Boolean forceAppend)
Adds a list of DocumentModels to the list ListName. |
void |
createWorkingList(java.lang.String listName,
DocumentsListDescriptor descriptor)
Creates (declares) a new named list of documents. |
void |
destroy()
|
java.util.List<DocumentModel> |
getWorkingList()
Returns the default list. |
java.util.List<DocumentModel> |
getWorkingList(java.lang.String listName)
Returns the list listName. |
DocumentsListDescriptor |
getWorkingListDescriptor()
Gets the descriptor (meta-data) of a default list. |
DocumentsListDescriptor |
getWorkingListDescriptor(java.lang.String listName)
Gets the descriptor (meta-data) of a given list. |
java.util.List<java.lang.String> |
getWorkingListNamesForCategory(java.lang.String categoryName)
Returns the availables lists names for a given category. |
java.util.List<java.lang.String> |
getWorkingListTypes()
Returns the list of document types contained in the default list. |
java.util.List<java.lang.String> |
getWorkingListTypes(java.lang.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(java.lang.String listName)
Check is list listName is empty. |
void |
refreshLists(DocumentModel currentDocument)
Method called by Seam event service to reset lists. |
void |
removeFromAllLists(java.util.List<DocumentModel> documentsToRemove)
Removes documentsToRemove from all lists. |
java.util.List<DocumentModel> |
removeFromWorkingList(DocumentModel doc)
Removes one DocumentModel from the default list. |
java.util.List<DocumentModel> |
removeFromWorkingList(java.lang.String listName,
DocumentModel doc)
Removes one DocumentModel from the list ListName. |
java.util.List<DocumentModel> |
removeFromWorkingList(java.lang.String listName,
java.util.List<DocumentModel> lst)
|
java.util.List<DocumentModel> |
resetWorkingList()
Removes DocumentModels from the default list. |
java.util.List<DocumentModel> |
resetWorkingList(java.util.List<DocumentModel> newDocList)
Resets default list and fills it with newDocList. |
java.util.List<DocumentModel> |
resetWorkingList(java.lang.String listName)
Removes DocumentModels from the list ListName. |
java.util.List<DocumentModel> |
resetWorkingList(java.lang.String listName,
java.util.List<DocumentModel> newDocList)
Resets list listName and fill it with newDocList. |
void |
setWorkingList(java.util.List<DocumentModel> docList)
Updates the default list. |
void |
setWorkingList(java.lang.String listName,
java.util.List<DocumentModel> docList)
Updates the list listName. |
Field Detail |
---|
static final java.lang.String DEFAULT_WORKING_LIST
static final java.lang.String CLIPBOARD
static final java.lang.String CURRENT_DOCUMENT_SELECTION
static final java.lang.String CURRENT_DOCUMENT_TRASH_SELECTION
static final java.lang.String CURRENT_DOCUMENT_SECTION_SELECTION
Method Detail |
---|
void createWorkingList(java.lang.String listName, DocumentsListDescriptor descriptor)
listName
- Name of the listjava.util.List<DocumentModel> getWorkingList(java.lang.String listName)
listName
- Name of the list
java.util.List<DocumentModel> getWorkingList()
java.util.List<java.lang.String> getWorkingListTypes(java.lang.String listName)
listName
- Name of the list to retrieve
java.util.List<java.lang.String> getWorkingListTypes()
void setWorkingList(java.lang.String listName, java.util.List<DocumentModel> docList)
listName
- Name of the list to updatedocList
- the DocumentModel list to store in the list ListNamevoid setWorkingList(java.util.List<DocumentModel> docList)
docList
- the DocumentModel list to store in the default listjava.util.List<DocumentModel> addToWorkingList(java.lang.String listName, DocumentModel doc)
listName
- the name of the list to updatedoc
- the doc to append
java.util.List<DocumentModel> addToWorkingList(DocumentModel doc)
doc
-
java.util.List<DocumentModel> addToWorkingList(java.lang.String listName, java.util.List<DocumentModel> docList)
listName
- the name of the list to updatedocList
- the DocumentModels list to append
java.util.List<DocumentModel> addToWorkingList(java.lang.String listName, java.util.List<DocumentModel> docList, java.lang.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 reset
java.util.List<DocumentModel> addToWorkingList(java.util.List<DocumentModel> docList)
docList
-
java.util.List<DocumentModel> removeFromWorkingList(java.lang.String listName, DocumentModel doc)
listName
- doc
-
java.util.List<DocumentModel> removeFromWorkingList(java.lang.String listName, java.util.List<DocumentModel> lst)
java.util.List<DocumentModel> removeFromWorkingList(DocumentModel doc)
doc
-
java.util.List<DocumentModel> resetWorkingList(java.lang.String listName)
listName
-
java.util.List<DocumentModel> resetWorkingList()
java.util.List<DocumentModel> resetWorkingList(java.lang.String listName, java.util.List<DocumentModel> newDocList)
listName
- newDocList
-
java.util.List<DocumentModel> resetWorkingList(java.util.List<DocumentModel> newDocList)
newDocList
-
boolean isWorkingListEmpty(java.lang.String listName)
listName
-
boolean isWorkingListEmpty()
@Observer(value="documentSelectionChanged", create=false) void refreshLists(DocumentModel currentDocument)
void removeFromAllLists(java.util.List<DocumentModel> documentsToRemove)
documentsToRemove
- void initListManager()
java.util.List<java.lang.String> getWorkingListNamesForCategory(java.lang.String categoryName)
categoryName
-
DocumentsListDescriptor getWorkingListDescriptor(java.lang.String listName)
listName
-
DocumentsListDescriptor getWorkingListDescriptor()
@Destroy void destroy()
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |