com.uc4.communication.requests

Class TaskPromptSetContent

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.TaskPromptSetContent

All Implemented Interfaces:

java.lang.Iterable<PromptElement>

public class TaskPromptSetContent
extends XMLRequest
implements java.lang.Iterable<PromptElement>

This request reads the content of a PromptSet (List of PromptElements) for a specified task. Sample for read and modify PromptSet: TaskPromptSetContent prompt = null; TaskPromptSetNames names = new TaskPromptSetNames(runID); connection.sendRequestAndWait(names); Iterator<TaskPromptSetName> it = names.iterator(); while (it.hasNext()) { TaskPromptSetName promptName = (TaskPromptSetName) it.next(); if( promptName.getName().getName().compareTo("JOBS.FTP.LS") == 0 ) { prompt = new TaskPromptSetContent(promptName, runID); connection.sendRequestAndWait(prompt); prompt.ocvValues().changeValue("prompt_0_sourceDir", "/bin"); SubmitPrompt sumbit = new SubmitPrompt(names, prompt); connection.sendRequestAndWait(sumbit); break; } }

Constructor Summary

Constructors

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.

Method Summary

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.

Methods inherited from class com.uc4.communication.requests.XMLRequest

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send

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

TaskPromptSetContent

@Deprecated
public TaskPromptSetContent(UC4ObjectName promptSetName,
                                        int runID)

Deprecated.

Creates a request to get the content of a PromptSet for execution.

Use the constructor TaskPromptSetContent(TaskPromptSetName promptSetName, int runID) instead.

Parameters:

promptSetName - Name of the PromptSet

runID - RunID of the task

TaskPromptSetContent

public TaskPromptSetContent(PromptSet promptSet)

Preview of a prompt set object.

Parameters:

promptSet - Prompt Set

TaskPromptSetContent

public TaskPromptSetContent(TaskPromptSetName promptSetName,
                            int runID)

Creates a request to get the content of a PromptSet for execution.

Parameters:

promptSetName - Name of the PromptSet

runID - RunID of the task

TaskPromptSetContent

@Deprecated
public TaskPromptSetContent(PromptSetDefinition promptSetDef)

Deprecated.

Creates a request to get the content of a PromptSet of a JOBP task.

Parameters:

promptSetDef - Prompt Set definition Deprecated: Use TaskPromptSetContent(PromptSetDefinition promptSetDef, UC4Object obj) instead

TaskPromptSetContent

public TaskPromptSetContent(PromptSetDefinition promptSetDef,
                            UC4Object obj)

Creates a request to get the content of a PromptSet of an object.

Parameters:

promptSetDef - Prompt Set definition

obj - UC4 Object

TaskPromptSetContent

public TaskPromptSetContent(PromptSetDefinition promptSetDef,
                            ITaskItem task)

Creates a request to get the content of a PromptSet of a JOBP task.

Parameters:

promptSetDef - Prompt Set definition

task - Workflow task

TaskPromptSetContent

public TaskPromptSetContent(PromptSetDefinition promptSetDef,
                            JobPlanMonitor.Task task)

Creates a request to get the content of a PromptSet of a JOBP task that was executed.

Parameters:

promptSetDef - Prompt Set definition

task - The JobPlanMonitor task

TaskPromptSetContent

public TaskPromptSetContent(UC4ObjectName promptSetName,
                            ITaskItem task)

Creates a request to get the content of a PromptSet of a JOBP task.

Parameters:

promptSetName - Name of the promptSet

task - Workflow task

Method Detail

getRaAgentName

public UC4HostName getRaAgentName()

Returns the name of the Agent if this is an RA panel.

Returns:

Name of the Agent or an empty UC4HostName instance, never null

getRaJobtype

public java.lang.String getRaJobtype()

Returns the job type if this is an RA panel. Otherwise null is returned.

Returns:

Job type or null if this is not an RA panel

getRaSubtype

public java.lang.String getRaSubtype()

Returns the sub type of the Job if this is an RA panel. Otherwise null is returned.

Returns:

RA Job sub type or null if this is not an RA panel

getRaCaption

public java.lang.String getRaCaption()

Returns the caption of the tab if this is an RA prompt.

Returns:

Caption or null if this is not an RA panel

iterator

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

The returned Iterator can be used to set values of PromptElements the execution of an executable object. After all values are set (the method setValue() has been called for all PromptElements which are returned by this Iterator) the request 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.

Specified by:

iterator in interface java.lang.Iterable<PromptElement>

Returns:

Iterator over PromptElement

getText

public java.lang.String getText()

Returns the caption of the prompt set.

Returns:

Caption

ocvValues

public OCVPanel ocvValues()

This method provides access to the RA Job values. If this Prompt is not a RA prompt the return value is null.

Returns:

Values or null if this prompt has not the type "RA"

getPromptSetName

public UC4ObjectName getPromptSetName()

Returns the name of the PromptSet.

Returns:

Name of the PromptSet

size

public int size()

Returns the number of PromptElements.

Returns:

Number of Prompt

getType

public java.lang.String getType()

Returns the type of this prompt. If "RA" is returned the method ocvValues() can be used to read and modify values.

Returns:

"PROMPTSET" or "RA"

getPromptSetID

public java.lang.String getPromptSetID()

Returns:

ID of the PromptSet