|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Directory
Interface representing a directory in the docstore.
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
Document |
getDocument(java.lang.String name)
Fetches the document with the given name found under this directory. |
Document |
getDocument(java.lang.String name,
boolean forceSync)
Fetches the document with the given name found under this directory. |
PIMCollection<Document> |
getDocuments()
Fetches a collection of all the documents on which the user has view permission in this directory |
java.lang.String |
getPath()
Fetches the path of this directory in the docstore. |
java.util.Collection<Directory> |
getSubDirectories()
Fetches a collection of directories which are present immediately under this directory |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
java.util.Collection<Directory> getSubDirectories()
PIMInternalException
- If an internal error occurs.PIMCollection<Document> getDocuments()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.Document getDocument(java.lang.String name)
name
- The name of the document to be fetched.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.DOCSTORE_VIEW_FILES
java.lang.IllegalArgumentException
- If name is emptyDocument getDocument(java.lang.String name, boolean forceSync)
name
- The name of the document to be fetched.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 occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.DOCSTORE_VIEW_FILES
java.lang.IllegalArgumentException
- If name is empty.java.lang.String getPath()
PIMInternalException
- If an internal error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |