org.nuxeo.ecm.collections.core

Class CollectionManagerImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.collections.core.CollectionManagerImpl

All Implemented Interfaces:

CollectionManager, Adaptable, Component, Extensible, TimestampedService

public class CollectionManagerImpl
extends DefaultComponent
implements CollectionManager

Since:

5.9.3

Constructor Summary

Constructors

Constructor and Description
CollectionManagerImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addToCollection(DocumentModel collection, DocumentModel documentToBeAdded, CoreSession session) Add a document to a collection.
void	addToCollection(DocumentModel collection, List<DocumentModel> documentListToBeAdded, CoreSession session) Add a list of document to a collection.
void	addToNewCollection(String newTitle, String newDescription, DocumentModel documentToBeAdded, CoreSession session) Add a document to a new collection.
void	addToNewCollection(String newTitle, String newDescription, List<DocumentModel> documentListToBeAdded, CoreSession session) Add a list of document to a new collection.
boolean	canAddToCollection(DocumentModel collection, CoreSession session) Check that a document is a collection and that the given core session has permission to add document inside.
boolean	canManage(DocumentModel collection, CoreSession session) Check that the given core session has permission to manage the collection.
void	checkCanAddToCollection(DocumentModel collection, DocumentModel documentToBeAdded, CoreSession session)
DocumentModel	createCollection(CoreSession session, String title, String description, String path) Create a collection with a given name, description and path.
void	doRemoveFromCollection(DocumentModel documentToBeRemoved, String collectionId, CoreSession session)
DocumentModel	getUserDefaultCollections(DocumentModel context, CoreSession session) Get user collections root document.
List<DocumentModel>	getVisibleCollection(DocumentModel collectionMember, CoreSession session) Get the list of collection of a document.
List<DocumentModel>	getVisibleCollection(DocumentModel collectionMember, int maxResult, CoreSession session) Get the list of collection of a document.
boolean	hasVisibleCollection(DocumentModel collectionMember, CoreSession session) Check that the given core session has READ permission on at least one collection of the given document.
boolean	isCollectable(DocumentModel doc) Check that a document can be added to a collection.
boolean	isCollected(DocumentModel doc) Check that a document has already been added to a collection.
boolean	isCollection(DocumentModel doc) Check that a document is a collection.
boolean	isInCollection(DocumentModel collection, DocumentModel document, CoreSession session) Check whether a document is in a given collection.
void	processCopiedCollection(DocumentModel collection) Update all documents referenced by a collection to add a reference back the collection.
void	processRemovedCollection(DocumentModel collection) Update all documents referenced by a collection to remove the reference to the collection.
void	processRemovedCollectionMember(DocumentModel collectionMember) Update all collections referenced by a document.
void	removeAllFromCollection(DocumentModel collection, List<DocumentModel> documentListToBeRemoved, CoreSession session) Remove a list of document from a given collection.
void	removeFromCollection(DocumentModel collection, DocumentModel documentToBeRemoved, CoreSession session) Remove a document from a collection.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerContribution, registerExtension, setLastModified, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionManagerImpl

public CollectionManagerImpl()

Method Detail

addToCollection

public void addToCollection(DocumentModel collection,
                   DocumentModel documentToBeAdded,
                   CoreSession session)
                     throws ClientException,
                            DocumentSecurityException

Description copied from interface: CollectionManager

Add a document to a collection.

Specified by:

addToCollection in interface CollectionManager

Parameters:

collection - the collection

documentToBeAdded - the document to be added

session - the core session

Throws:

ClientException

DocumentSecurityException

addToCollection

public void addToCollection(DocumentModel collection,
                   List<DocumentModel> documentListToBeAdded,
                   CoreSession session)
                     throws ClientException

Description copied from interface: CollectionManager

Add a list of document to a collection.

Specified by:

addToCollection in interface CollectionManager

Parameters:

collection - the collection

documentListToBeAdded - the list of document to be added

session - the core session

Throws:

ClientException

addToNewCollection

public void addToNewCollection(String newTitle,
                      String newDescription,
                      DocumentModel documentToBeAdded,
                      CoreSession session)
                        throws ClientException

Description copied from interface: CollectionManager

Add a document to a new collection.

Specified by:

addToNewCollection in interface CollectionManager

Parameters:

newTitle - the title of the new collection

newDescription - the description of the new collection

documentToBeAdded - the document to be added

session - the core session

Throws:

ClientException

addToNewCollection

public void addToNewCollection(String newTitle,
                      String newDescription,
                      List<DocumentModel> documentListToBeAdded,
                      CoreSession session)
                        throws ClientException

Description copied from interface: CollectionManager

Add a list of document to a new collection.

Specified by:

addToNewCollection in interface CollectionManager

Parameters:

newTitle - the title of the new collection

newDescription - the description of the new collection

documentListToBeAdded - the list of document to be added

Throws:

ClientException

canAddToCollection

public boolean canAddToCollection(DocumentModel collection,
                         CoreSession session)
                           throws ClientException

Description copied from interface: CollectionManager

Check that a document is a collection and that the given core session has permission to add document inside.

Specified by:

canAddToCollection in interface CollectionManager

Parameters:

collection - the collection

session - the core session

Returns:

true if the given document is a Collection and the core session has permission to add document inside, false otherwise

Throws:

ClientException

canManage

public boolean canManage(DocumentModel collection,
                CoreSession session)
                  throws ClientException

Description copied from interface: CollectionManager

Check that the given core session has permission to manage the collection.

Specified by:

canManage in interface CollectionManager

Parameters:

collection - the collection

session - the core session

Returns:

true if the core session has permission to manage the collection

Throws:

ClientException

checkCanAddToCollection

public void checkCanAddToCollection(DocumentModel collection,
                           DocumentModel documentToBeAdded,
                           CoreSession session)
                             throws ClientException

Throws:

ClientException

getUserDefaultCollections

public DocumentModel getUserDefaultCollections(DocumentModel context,
                                      CoreSession session)
                                        throws ClientException

Description copied from interface: CollectionManager

Get user collections root document.

Specified by:

getUserDefaultCollections in interface CollectionManager

Parameters:

context - contextual document

session - the core session

Returns:

the user collections root document

Throws:

ClientException

getVisibleCollection

public List<DocumentModel> getVisibleCollection(DocumentModel collectionMember,
                                       CoreSession session)
                                         throws ClientException

Description copied from interface: CollectionManager

Get the list of collection of a document. The resulting list will only contain the collections visible by the given core session (i.e. the collections on which the given core session has at least READ permission).

Specified by:

getVisibleCollection in interface CollectionManager

Parameters:

collectionMember - the document

session - the core session

Returns:

the list of visible collections the collectionMember belong to

Throws:

ClientException

getVisibleCollection

public List<DocumentModel> getVisibleCollection(DocumentModel collectionMember,
                                       int maxResult,
                                       CoreSession session)
                                         throws ClientException

Description copied from interface: CollectionManager

Get the list of collection of a document. The resulting list will only contain the collections visible by the given core session (i.e. the collections on which the given core session has at least READ permission). The resulting list's size will be limited to masResult.

Specified by:

getVisibleCollection in interface CollectionManager

Parameters:

collectionMember - the document

maxResult - the limit

session - the core session

Returns:

the list of maxResult first visible collections the collectionMember belong to

Throws:

ClientException

hasVisibleCollection

public boolean hasVisibleCollection(DocumentModel collectionMember,
                           CoreSession session)
                             throws ClientException

Description copied from interface: CollectionManager

Check that the given core session has READ permission on at least one collection of the given document.

Specified by:

hasVisibleCollection in interface CollectionManager

Parameters:

collectionMember - the document

session - the core session

Returns:

true if collectionMember has at least one collection on which the session has READ permission

Throws:

ClientException

isCollectable

public boolean isCollectable(DocumentModel doc)

Description copied from interface: CollectionManager

Check that a document can be added to a collection.

Specified by:

isCollectable in interface CollectionManager

Parameters:

doc - the document

Returns:

true if the document can be added to the collection

isCollected

public boolean isCollected(DocumentModel doc)

Description copied from interface: CollectionManager

Check that a document has already been added to a collection.

Specified by:

isCollected in interface CollectionManager

Parameters:

doc - the document

Returns:

true if the document has already been added to a collection

isCollection

public boolean isCollection(DocumentModel doc)

Description copied from interface: CollectionManager

Check that a document is a collection.

Specified by:

isCollection in interface CollectionManager

Parameters:

doc - the document

Returns:

true if the document is a collection

isInCollection

public boolean isInCollection(DocumentModel collection,
                     DocumentModel document,
                     CoreSession session)
                       throws ClientException

Description copied from interface: CollectionManager

Check whether a document is in a given collection.

Specified by:

isInCollection in interface CollectionManager

Parameters:

collection - the collection

document - the document to check

session - the session

Throws:

ClientException

processCopiedCollection

public void processCopiedCollection(DocumentModel collection)
                             throws ClientException

Description copied from interface: CollectionManager

Update all documents referenced by a collection to add a reference back the collection. This is used when a creation is created by copy in order to tell the members of a copied collection that they also belongs to the newly created collection.

Specified by:

processCopiedCollection in interface CollectionManager

Parameters:

collection - the collection

Throws:

ClientException

processRemovedCollection

public void processRemovedCollection(DocumentModel collection)

Description copied from interface: CollectionManager

Update all documents referenced by a collection to remove the reference to the collection. This is used after the complete deletion of a collection.

Specified by:

processRemovedCollection in interface CollectionManager

Parameters:

collection - the collection

processRemovedCollectionMember

public void processRemovedCollectionMember(DocumentModel collectionMember)

Description copied from interface: CollectionManager

Update all collections referenced by a document. This is used after the complete deletion of a document to remove its reference from all collections it belongs to.

Specified by:

processRemovedCollectionMember in interface CollectionManager

Parameters:

collectionMember - the document

removeAllFromCollection

public void removeAllFromCollection(DocumentModel collection,
                           List<DocumentModel> documentListToBeRemoved,
                           CoreSession session)
                             throws ClientException

Description copied from interface: CollectionManager

Remove a list of document from a given collection.

Specified by:

removeAllFromCollection in interface CollectionManager

Parameters:

collection - the collection

documentListToBeRemoved - the document to be removed

session - the core session

Throws:

ClientException

removeFromCollection

public void removeFromCollection(DocumentModel collection,
                        DocumentModel documentToBeRemoved,
                        CoreSession session)
                          throws ClientException

Description copied from interface: CollectionManager

Remove a document from a collection.

Specified by:

removeFromCollection in interface CollectionManager

Parameters:

collection - the collection

documentToBeRemoved - the document to be removed

session - the core session

Throws:

ClientException

doRemoveFromCollection

public void doRemoveFromCollection(DocumentModel documentToBeRemoved,
                          String collectionId,
                          CoreSession session)

Specified by:

doRemoveFromCollection in interface CollectionManager

createCollection

public DocumentModel createCollection(CoreSession session,
                             String title,
                             String description,
                             String path)
                               throws ClientException

Description copied from interface: CollectionManager

Create a collection with a given name, description and path.

Specified by:

createCollection in interface CollectionManager

Returns:

Throws:

ClientException