|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocstoreManager
Interface for the manager of docstore. The docstore acts as a repository for all documents in the PIM system.
Field Summary |
---|
Fields inherited from interface com.ibm.pim.common.Manager |
---|
copyright |
Method Summary | |
---|---|
Document |
createAndPersistDocument(java.lang.String documentPath)
Creates an empty document at the specified documentPath and persists it. |
Document |
createAndPersistDocument(java.lang.String documentPath,
AccessControlGroup accessControlGroup)
Creates an empty document at the specified documentPath and sets the given access control group for the document. |
Directory |
getDirectory(java.lang.String directoryPath)
Fetches the directory at the given directoryPath. |
Document |
getDocument(java.lang.String documentPath)
Fetches the document which exists at the given documentPath. |
Document |
getDocument(java.lang.String documentPath,
boolean forceSync)
Fetches the document which exists at the given documentPath. |
Directory |
getRootDirectory()
Fetches the root directory of the docstore. |
Methods inherited from interface com.ibm.pim.common.Manager |
---|
getManagerName |
Method Detail |
---|
Document createAndPersistDocument(java.lang.String documentPath)
documentPath
- The path at which the new document will be created, including
the file name.
PIMInternalException
- If an internal error occurred.
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If the documentPath is empty or null.Document createAndPersistDocument(java.lang.String documentPath, AccessControlGroup accessControlGroup)
documentPath
- The path at which the new document will be created, including
the file name.accessControlGroup
- The accessControlGroup for the document.
PIMInternalException
- If an internal error occurred.
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If the documentPath is empty or null or accessControlGroup is
null
java.lang.IllegalStateException
- If the access control group has not been persistedDocument getDocument(java.lang.String documentPath)
documentPath
- The path of the document, including the file name.
PIMInternalException
- If an internal error occurred.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.DOCSTORE_VIEW_FILES
java.lang.IllegalArgumentException
- If the documentPath is empty or nullDocument getDocument(java.lang.String documentPath, boolean forceSync)
documentPath
- The path of the document, including the file name.forceSync
- When forceSync is true, a document is created in the docstore
if it is present in the file system.
PIMInternalException
- If an internal error occurred.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.DOCSTORE_VIEW_FILES
java.lang.IllegalArgumentException
- If the documentPath is empty or nullDirectory getRootDirectory()
PIMInternalException
- If an internal error occurred.
PIMAuthorizationException
- Reserved for future use.Directory getDirectory(java.lang.String directoryPath)
directoryPath
- The path of a directory in the docstore. Ends with a slash.
PIMInternalException
- If an internal error occurred.
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If the directoryPath is empty or null.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |