Package com.uc4.communication.requests

Class FolderList

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.FolderList

All Implemented Interfaces:

Iterable<FolderListItem>

public class FolderList
extends XMLRequest
implements Iterable<FolderListItem>

Lists the content of a folder.

Constructor Summary

Constructors

Constructor	Description
FolderList(IFolder folder)	Constructs a new FolderList to list the content of the specified folder.
FolderList(IFolder folder, boolean executableOnly)	Constructs a new FolderList to list the content of the specified folder.
FolderList(IFolder folder, List<String> objectTypes)	Constructs a new FolderList to list the content of the specified folder.

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
FolderListItem	findByName(String name)	Returns a FolderListItem for the specified name or null if the name was not found.
protected String	getSrc()	Returns the request source.
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.
Iterator<FolderListItem>	iterator()	Returns an iterator over FolderListItem.
int	size()	Returns the number of objects in this folder.

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

FolderList

public FolderList(IFolder folder)

Constructs a new FolderList to list the content of the specified folder.

Parameters:

folder - Folder

FolderList

public FolderList(IFolder folder,
 boolean executableOnly)

Constructs a new FolderList to list the content of the specified folder.

Parameters:

folder - Folder

executableOnly - If this flag is true only executable objects will be returned

FolderList

public FolderList(IFolder folder,
 List<String> objectTypes)

Constructs a new FolderList to list the content of the specified folder.

Parameters:

folder - Folder

objectTypes - List of object types, for example JOBP, JOBS, JOBI

Method Details

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
 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

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

getSrc

protected String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source

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

findByName

public FolderListItem findByName(String name)

Returns a FolderListItem for the specified name or null if the name was not found.

Parameters:

name - Name of the UC4 Object

Returns:

FolderListItem or null if not found

size

public int size()

Returns the number of objects in this folder.

Returns:

Number of objects

iterator

public Iterator<FolderListItem> iterator()

Returns an iterator over FolderListItem. Each FolderListItem represents an entry in this folder list.

Specified by:

iterator in interface Iterable<FolderListItem>

Returns:

iterator over FolderListItem