com.uc4.communication.requests

Class TaskPromptSetNames

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.TaskPromptSetNames

All Implemented Interfaces:

Iterable<TaskPromptSetName>

public class TaskPromptSetNames
extends XMLRequest
implements Iterable<TaskPromptSetName>

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
UC4ObjectName[]	getPromptSets() Deprecated.
int	getRunID() Get RunID.
String	getTimezoneText() Returns the timezone information.
Iterator<TaskPromptSetName>	iterator()
int	size() Returns the number of prompt elements.

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

TaskPromptSetNames

public TaskPromptSetNames(int runID)

Creates a new GetTaskPromptSetNames request.

Parameters:

runID - RunID of the task

Method Detail

getTimezoneText

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

Returns a list of PromptSet names. If there are no prompt sets an array of length 0 is returned. Use the iterator() method instead.

Returns:

Name of Prompt Objects never null

iterator

public Iterator<TaskPromptSetName> iterator()

Specified by:

iterator in interface Iterable<TaskPromptSetName>