public class TaskPromptSetContent extends XMLRequest implements java.lang.Iterable<PromptElement>
Constructor and Description |
---|
TaskPromptSetContent(PromptSet promptSet)
Preview of a prompt set object.
|
TaskPromptSetContent(PromptSetDefinition promptSetDef)
Deprecated.
|
TaskPromptSetContent(PromptSetDefinition promptSetDef,
ITaskItem task)
Creates a request to get the content of a PromptSet of a JOBP task.
|
TaskPromptSetContent(PromptSetDefinition promptSetDef,
JobPlanMonitor.Task task)
Creates a request to get the content of a PromptSet of a JOBP task that was executed.
|
TaskPromptSetContent(PromptSetDefinition promptSetDef,
UC4Object obj)
Creates a request to get the content of a PromptSet of an object.
|
TaskPromptSetContent(TaskPromptSetName promptSetName,
int runID)
Creates a request to get the content of a PromptSet for execution.
|
TaskPromptSetContent(UC4ObjectName promptSetName,
int runID)
Deprecated.
|
TaskPromptSetContent(UC4ObjectName promptSetName,
ITaskItem task)
Creates a request to get the content of a PromptSet of a JOBP task.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getPromptSetID() |
UC4ObjectName |
getPromptSetName()
Returns the name of the PromptSet.
|
UC4HostName |
getRaAgentName()
Returns the name of the Agent if this is an RA panel.
|
java.lang.String |
getRaCaption()
Returns the caption of the tab if this is an RA prompt.
|
java.lang.String |
getRaJobtype()
Returns the job type if this is an RA panel.
|
java.lang.String |
getRaSubtype()
Returns the sub type of the Job if this is an RA panel.
|
java.lang.String |
getText()
Returns the caption of the prompt set.
|
java.lang.String |
getType()
Returns the type of this prompt.
|
java.util.Iterator<PromptElement> |
iterator()
The returned Iterator can be used to set values of PromptElements the
execution of an executable object.
|
OCVPanel |
ocvValues()
This method provides access to the RA Job values.
|
int |
size()
Returns the number of PromptElements.
|
getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send
@Deprecated public TaskPromptSetContent(UC4ObjectName promptSetName, int runID)
Use the constructor
TaskPromptSetContent(TaskPromptSetName promptSetName, int runID)
instead.
promptSetName
- Name of the PromptSetrunID
- RunID of the taskpublic TaskPromptSetContent(PromptSet promptSet)
promptSet
- Prompt Setpublic TaskPromptSetContent(TaskPromptSetName promptSetName, int runID)
promptSetName
- Name of the PromptSetrunID
- RunID of the task@Deprecated public TaskPromptSetContent(PromptSetDefinition promptSetDef)
promptSetDef
- Prompt Set definitionpublic TaskPromptSetContent(PromptSetDefinition promptSetDef, UC4Object obj)
promptSetDef
- Prompt Set definitionobj
- UC4 Objectpublic TaskPromptSetContent(PromptSetDefinition promptSetDef, ITaskItem task)
promptSetDef
- Prompt Set definitiontask
- Workflow taskpublic TaskPromptSetContent(PromptSetDefinition promptSetDef, JobPlanMonitor.Task task)
promptSetDef
- Prompt Set definitiontask
- The JobPlanMonitor taskpublic TaskPromptSetContent(UC4ObjectName promptSetName, ITaskItem task)
promptSetName
- Name of the promptSettask
- Workflow taskpublic UC4HostName getRaAgentName()
null
public java.lang.String getRaJobtype()
null
is returned.null
if this is not an RA panelpublic java.lang.String getRaSubtype()
null
is returned.null
if this is not an RA panelpublic java.lang.String getRaCaption()
null
if this is not an RA panelpublic java.util.Iterator<PromptElement> iterator()
SubmitPrompt
is used to send the
values to the Automation Engine. It is not possible to remove
PromptElements by using the Iterator.remove()
method. An
Exception will be thrown in this case.iterator
in interface java.lang.Iterable<PromptElement>
PromptElement
public java.lang.String getText()
public OCVPanel ocvValues()
null
.null
if this prompt has not the type "RA"public UC4ObjectName getPromptSetName()
public int size()
public java.lang.String getType()
ocvValues()
can be used to read and modify values.public java.lang.String getPromptSetID()