Package com.uc4.communication.requests
Class FolderList
- java.lang.Object
-
- com.uc4.communication.requests.XMLRequest
-
- com.uc4.communication.requests.FolderList
-
- All Implemented Interfaces:
java.lang.Iterable<FolderListItem>
public class FolderList extends XMLRequest implements java.lang.Iterable<FolderListItem>
Lists the content of a folder.
-
-
Constructor Summary
Constructors Constructor Description FolderList(IFolder folder)
Constructs a newFolderList
to list the content of the specified folder.FolderList(IFolder folder, boolean executableOnly)
Constructs a newFolderList
to list the content of the specified folder.FolderList(IFolder folder, java.util.List<java.lang.String> objectTypes)
Constructs a newFolderList
to list the content of the specified folder.
-
Method Summary
All Methods Instance Methods Concrete Methods 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.FolderListItem
findByName(java.lang.String name)
Returns aFolderListItem
for the specified name ornull
if the name was not found.protected java.lang.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.java.util.Iterator<FolderListItem>
iterator()
Returns an iterator overFolderListItem
.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
-
-
-
-
Constructor Detail
-
FolderList
public FolderList(IFolder folder)
Constructs a newFolderList
to list the content of the specified folder.- Parameters:
folder
- Folder
-
FolderList
public FolderList(IFolder folder, boolean executableOnly)
Constructs a newFolderList
to list the content of the specified folder.- Parameters:
folder
- FolderexecutableOnly
- If this flag is true only executable objects will be returned
-
FolderList
public FolderList(IFolder folder, java.util.List<java.lang.String> objectTypes)
Constructs a newFolderList
to list the content of the specified folder.- Parameters:
folder
- FolderobjectTypes
- List of object types, for example JOBP, JOBS, JOBI
-
-
Method Detail
-
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 classXMLRequest
- Parameters:
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the session
-
isAllowedInClientZero
protected boolean isAllowedInClientZero()
Description copied from class:XMLRequest
This method is used internally. Tests if thisXMLRequest
is allowed in client 0. The default implementation returnsfalse
, subclasses may override.- Overrides:
isAllowedInClientZero
in classXMLRequest
- Returns:
true
if this request is allowed in client 0,false
otherwise
-
getSrc
protected java.lang.String getSrc()
Description copied from class:XMLRequest
Returns the request source. This method is used internally.- Specified by:
getSrc
in classXMLRequest
- 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 classXMLRequest
- Parameters:
doc
- XML Documentsession
- Info about the user session
-
findByName
public FolderListItem findByName(java.lang.String name)
Returns aFolderListItem
for the specified name ornull
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 java.util.Iterator<FolderListItem> iterator()
Returns an iterator overFolderListItem
. EachFolderListItem
represents an entry in this folder list.- Specified by:
iterator
in interfacejava.lang.Iterable<FolderListItem>
- Returns:
- iterator over FolderListItem
-
-