Package com.uc4.communication.requests

Class TaskPromptSetNames

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.TaskPromptSetNames

All Implemented Interfaces:

java.lang.Iterable<TaskPromptSetName>

public class TaskPromptSetNames
extends XMLRequest
implements java.lang.Iterable<TaskPromptSetName>

This request reads a list of Prompt Set Objects of a specified task.

Constructor Summary

Constructors

Constructor	Description
TaskPromptSetNames(int runID)	Creates a new GetTaskPromptSetNames request.

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.
UC4ObjectName[]	getPromptSets()	Deprecated. Use the iterator() method instead.
int	getRunID()	Get RunID.
protected java.lang.String	getSrc()	Returns the request source.
java.lang.String	getTimezoneText()	Returns the timezone information.
protected void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)	Sub classes extract the values from the XML document and provide public getter methods.
java.util.Iterator<TaskPromptSetName>	iterator()
int	size()	Returns the number of prompt elements.

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, isAllowedInClientZero, 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 Detail

TaskPromptSetNames

public TaskPromptSetNames(int runID)

Creates a new GetTaskPromptSetNames request.

Parameters:

runID - RunID of the task

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 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

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

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

getTimezoneText

public java.lang.String getTimezoneText()

Returns the timezone information. This is the same text as is displayed in the User Interface.

Returns:

Text containing the name of the timezone

getRunID

public int getRunID()

Get RunID.

Returns:

RunID

size

public int size()

Returns the number of prompt elements.

Returns:

Number of elements

getPromptSets

@Deprecated
public UC4ObjectName[] getPromptSets()

Deprecated.

Use the iterator() method instead.

Returns a list of PromptSet names. If there are no prompt sets an array of length 0 is returned.

Returns:

Name of Prompt Objects never null

iterator

public java.util.Iterator<TaskPromptSetName> iterator()

Specified by:

iterator in interface java.lang.Iterable<TaskPromptSetName>