Package com.uc4.communication.requests
Class TaskPromptSetNames
java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.TaskPromptSetNames
- All Implemented Interfaces:
Iterable<TaskPromptSetName>
This request reads a list of Prompt Set Objects of a specified task.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
createRequest
(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo) Creates the XML Document for the request.Deprecated.int
getRunID()
Get RunID.protected String
getSrc()
Returns the request source.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.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 Details
-
TaskPromptSetNames
public TaskPromptSetNames(int runID) Creates a newGetTaskPromptSetNames
request.- Parameters:
runID
- RunID of the task
-
-
Method Details
-
createRequest
protected void createRequest(com.uc4.util.XMLDocument doc, 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
-
getSrc
Description copied from class:XMLRequest
Returns the request source. This method is used internally.- Specified by:
getSrc
in classXMLRequest
- Returns:
- Source
-
handleContent
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
-
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.Use theiterator()
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
- Specified by:
iterator
in interfaceIterable<TaskPromptSetName>
-
iterator()
method instead.