Package com.uc4.communication.requests

Class FolderTree

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.FolderTree

public class FolderTree
extends XMLRequest

Returns the folder structure of the UC4 client.

Constructor Summary

Constructors

Constructor	Description
FolderTree()

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
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.
protected java.lang.String	getSrc()	Returns the request source.
IFolder	getTransportFolder()	Returns an IFolder object which represents the transport case folder.
IFolder	getVersionManagement()	Returns an IFolder object which represents the "Version Management" folder.
protected void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)	Sub classes extract the values from the XML document and provide public getter methods.
protected boolean	isAllowedInClientZero()	This method is used internally.
IFolder	root()	Returns the root folder of the client.

Methods inherited from class com.uc4.communication.requests.XMLRequest

assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderTree

public FolderTree()

Method Detail

getSrc

protected java.lang.String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
                             org.w3c.dom.Element request,
                             ConnectionAttributes sessionInfo)

Description copied from class: XMLRequest

Creates the XML Document for the request. This method is used internally.

Specified by:

createRequest in class XMLRequest

Parameters:

doc - Document, used to create new Elements

request - Request Element - classes append information to this request element

sessionInfo - Information about the session

handleContent

protected void handleContent(com.uc4.util.XMLDocument doc,
                             ConnectionAttributes session)

Description copied from class: XMLRequest

Sub classes extract the values from the XML document and provide public getter methods.

Overrides:

handleContent in class XMLRequest

Parameters:

doc - XML Document

session - Info about the user session

getFolder

public IFolder getFolder(java.lang.String path)

Returns the folder for the given path or 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.

Parameters:

path - path

Returns:

folder or null if not found

getTransportFolder

public IFolder getTransportFolder()

Returns an IFolder object which represents the transport case folder. The returned instance can be used to list the content of this folder.

Returns:

IFolder or null if the priviledge is not held

getRecentObjects

public IFolder getRecentObjects()

Returns an IFolder object which represents the "Recent Objects" folder. The returned instance can be used to list the content of this folder.

Returns:

IFolder instance

getRecycleBin

public IFolder getRecycleBin()

Returns an IFolder object which represents the "Recycle Bin" folder. The returned instance can be used to list the content of this folder.

Returns:

IFolder or null if the priviledge is not held

getVersionManagement

public IFolder getVersionManagement()

Returns an IFolder object which represents the "Version Management" folder. The returned instance can be used to list the content of this folder.

Returns:

IFolder or null if the priviledge is not held

getNoFolder

public IFolder getNoFolder()

Returns an IFolder object which represents the "No Folder". The returned instance can be used to list the content of this folder.

Returns:

IFolder or null if the priviledge is not held

getFavoritesFolder

public IFolder getFavoritesFolder()

Returns an IFolder object which represents the "Favorites Folder".

Returns:

IFolder instance

root

public IFolder root()

Returns the root folder of the client.

Returns:

Root folder

getFolderByID

public IFolder getFolderByID(java.lang.String id)

Returns an folder object with the specified ID or null if not found.

Parameters:

id - ID of the folder

Returns:

folder object or null

isAllowedInClientZero

protected boolean isAllowedInClientZero()

Description copied from class: XMLRequest

This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.

Overrides:

isAllowedInClientZero in class XMLRequest

Returns:

true if this request is allowed in client 0, false otherwise