public class FolderList extends XMLRequest implements java.lang.Iterable<FolderListItem>
Constructor and 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,
java.util.List<java.lang.String> objectTypes)
Constructs a new
FolderList to list the
content of the specified folder. |
Modifier and Type | Method and 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 a
FolderListItem for the specified name or
null 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) |
protected boolean |
isAllowedInClientZero()
This method is used internally.
|
java.util.Iterator<FolderListItem> |
iterator()
Returns an iterator over
FolderListItem . |
int |
size()
Returns the number of objects in this folder.
|
assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification
public FolderList(IFolder folder)
FolderList
to list the
content of the specified folder.folder
- Folderpublic FolderList(IFolder folder, boolean executableOnly)
FolderList
to list the
content of the specified folder.folder
- FolderexecutableOnly
- If this flag is true only executable objects will be returnedpublic FolderList(IFolder folder, java.util.List<java.lang.String> objectTypes)
FolderList
to list the
content of the specified folder.folder
- FolderobjectTypes
- List of object types, for example JOBP, JOBS, JOBIprotected void createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)
XMLRequest
createRequest
in class XMLRequest
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the sessionprotected boolean isAllowedInClientZero()
XMLRequest
XMLRequest
is allowed in client 0.
The default implementation returns false
, subclasses may override.isAllowedInClientZero
in class XMLRequest
true
if this request is allowed in client 0, false
otherwiseprotected java.lang.String getSrc()
XMLRequest
getSrc
in class XMLRequest
protected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
handleContent
in class XMLRequest
public FolderListItem findByName(java.lang.String name)
FolderListItem
for the specified name or
null
if the name was not found.name
- Name of the UC4 Objectpublic int size()
public java.util.Iterator<FolderListItem> iterator()
FolderListItem
.
Each FolderListItem
represents an entry in this folder list.iterator
in interface java.lang.Iterable<FolderListItem>