Package com.uc4.communication.requests

Class GetDynamicComboList

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetDynamicComboList

All Implemented Interfaces:

java.lang.Iterable<java.lang.String>

public class GetDynamicComboList
extends XMLRequest
implements java.lang.Iterable<java.lang.String>

Returns a list of elements for a combo element, radio list or checklist in a PromptSet. This request should be used to get a list of values if the dynamic property of the prompt element is set to true

In this case the content of the prompt element depends on the values of other prompt elements. Therefore all prompt elements need to be passed in the constructor of this class. The values are sent to the Automation Engine in order to create a list of values.

Constructor Summary

Constructors

Constructor	Description
GetDynamicComboList(java.lang.String variableName, UC4ObjectName promptSet, int runID, TaskPromptSetContent... content)	Creates a new GetDynamicComboList request in order to get the list of values of a dynamic ComboElement in a prompt.
GetDynamicComboList(java.lang.String variableName, UC4ObjectName promptSet, ITaskItem task, TaskPromptSetContent... content)	Creates a new GetDynamicComboList request in order to get the list of values of a dynamic ComboElement in a prompt.
GetDynamicComboList(java.lang.String variableName, UC4ObjectName promptSet, UC4Object object, TaskPromptSetContent... content)	Creates a new GetDynamicComboList request in order to get the list of values of a dynamic ComboElement in a prompt.

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.
protected java.lang.String	getSrc()	Returns the request source.
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<java.lang.String>	iterator()	Returns an Iterator to get the valus of a dynamic Combo Box.
int	size()	Returns the number of elements in the Combo Box.

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

GetDynamicComboList

public GetDynamicComboList(java.lang.String variableName,
                           UC4ObjectName promptSet,
                           int runID,
                           TaskPromptSetContent... content)

Creates a new GetDynamicComboList request in order to get the list of values of a dynamic ComboElement in a prompt.

Parameters:

variableName - Name of the Variable (ComboElement)

promptSet - Name of the PromptSet which contains the variable

runID - RunID of the task

content - Content of all PromptSets

GetDynamicComboList

public GetDynamicComboList(java.lang.String variableName,
                           UC4ObjectName promptSet,
                           UC4Object object,
                           TaskPromptSetContent... content)

Creates a new GetDynamicComboList request in order to get the list of values of a dynamic ComboElement in a prompt.

Parameters:

variableName - Name of the Variable (ComboElement)

promptSet - Name of the PromptSet which contains the variable

object - Object

content - Content of all PromptSets

GetDynamicComboList

public GetDynamicComboList(java.lang.String variableName,
                           UC4ObjectName promptSet,
                           ITaskItem task,
                           TaskPromptSetContent... content)

Creates a new GetDynamicComboList request in order to get the list of values of a dynamic ComboElement in a prompt.

Parameters:

variableName - Name of the Variable (ComboElement)

promptSet - Name of the PromptSet which contains the variable

task - Task in a Workflow

content - Content of all PromptSets

Method Detail

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

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

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

iterator

public java.util.Iterator<java.lang.String> iterator()

Returns an Iterator to get the valus of a dynamic Combo Box.

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>

Returns:

Iterator

size

public int size()

Returns the number of elements in the Combo Box.

Returns:

Number of elements