|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CollectionManager
The CollectionManager is responsible for all tasks related to collection management (creation, deletion, listing).
Collections are named sets of documents. The same document can be part of multiple collections, thus collections can overlap.
Assigning documents to collections is done through the
Document
API.
Method Summary | |
---|---|
DocumentCollection |
createCollection(java.lang.String name)
Creates a new collection. |
void |
deleteCollection(long collectionId)
Deletes a collection from the repository. |
DocumentCollection |
getCollection(long collectionId,
boolean updateable)
Retrieves a collection by its ID. |
DocumentCollection |
getCollection(java.lang.String collection,
boolean updateable)
Retrieves a collection by ID or by name depending on whether the collection parameter starts with a digit. |
DocumentCollection |
getCollectionByName(java.lang.String name,
boolean updateable)
Retrieves a collection by its name. |
DocumentCollections |
getCollections(boolean updateable)
Gets all collections, in no specific order. |
Method Detail |
---|
DocumentCollection createCollection(java.lang.String name) throws RepositoryException
name
- the name of the new collection
RepositoryException
DocumentCollection getCollection(long collectionId, boolean updateable) throws RepositoryException
RepositoryException
DocumentCollection getCollection(java.lang.String collection, boolean updateable) throws RepositoryException
RepositoryException
DocumentCollection getCollectionByName(java.lang.String name, boolean updateable) throws RepositoryException
RepositoryException
void deleteCollection(long collectionId) throws RepositoryException
If any documents were associated with (contained by) this collection, these associations will be removed, but the documents themselves are not removed. Note that this can be done even if there are locks on documents contained by this collection, and that the last modified timestamp of the documents will remain untouched.
collectionId
- the ID of the collection to remove
RepositoryException
DocumentCollections getCollections(boolean updateable) throws RepositoryException
RepositoryException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |