public class FolderTree extends XMLRequest
Constructor and Description |
---|
FolderTree() |
Modifier and Type | Method and Description |
---|---|
IFolder |
getFavoritesFolder()
Returns an
IFolder object which represents the "Favorites Folder". |
IFolder |
getFolder(java.lang.String path)
Returns the folder for the given path or
null
if the folder was not found. |
IFolder |
getFolderByID(java.lang.String id)
Returns an folder object with the specified ID or
null if not found. |
IFolder |
getNoFolder()
Returns an
IFolder object which represents the "No Folder". |
IFolder |
getRecentObjects()
Returns an
IFolder object which represents the "Recent Objects" folder. |
IFolder |
getRecycleBin()
Returns an
IFolder object which represents the "Recycle Bin" folder. |
IFolder |
getTransportFolder()
Returns an
IFolder object which represents the transport case folder. |
IFolder |
getVersionManagement()
Returns an
IFolder object which represents the "Version Management" folder. |
IFolder |
root()
Returns the root folder of the client.
|
getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send
public IFolder getFolder(java.lang.String path)
null
if the folder was not found.
The folders are separated by forward slashes.
Example:
/FOLDER1/FOLDER2 ... returns FOLDER2. FOLDER1 must be directly under the root folder.path
- pathnull
if not foundpublic IFolder getTransportFolder()
IFolder
object which represents the transport case folder.
The returned instance can be used to list the content of this folder.null
if the priviledge is not heldpublic IFolder getRecentObjects()
IFolder
object which represents the "Recent Objects" folder.
The returned instance can be used to list the content of this folder.public IFolder getRecycleBin()
IFolder
object which represents the "Recycle Bin" folder.
The returned instance can be used to list the content of this folder.null
if the priviledge is not heldpublic IFolder getVersionManagement()
IFolder
object which represents the "Version Management" folder.
The returned instance can be used to list the content of this folder.null
if the priviledge is not heldpublic IFolder getNoFolder()
IFolder
object which represents the "No Folder".
The returned instance can be used to list the content of this folder.null
if the priviledge is not heldpublic IFolder getFavoritesFolder()
IFolder
object which represents the "Favorites Folder".public IFolder root()
public IFolder getFolderByID(java.lang.String id)
null
if not found.id
- ID of the folder