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 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, List<String> objectTypes) Constructs a new FolderList to list the content of the specified folder.

Method Summary

Modifier and Type	Method and Description
FolderListItem	findByName(String name) Returns a FolderListItem for the specified name or null if the name was not found.
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

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

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 Detail

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