com.ebasetech.xi.api.workflow

Class ExecutionDescriptor

java.lang.Object

com.ebasetech.xi.api.workflow.ExecutionDescriptor

All Implemented Interfaces:

java.io.Serializable

public class ExecutionDescriptor
extends java.lang.Object
implements java.io.Serializable

This interface represents the activity configured for a workflow interactive task. It contains all the information for clients to start the associated Interactive Activity and has methods that return the various configurable parts of an interactive task.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExecutionDescriptor(com.ebasetech.ufs.workflow.server.enactment.InteractiveTaskEnactment enactment, com.ebasetech.ufs.kernel.IUFSServletContextProxy proxy, java.lang.String language)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActivityType() Returns the activity type for the Interactive Activity linked with the interactive task represented by this ExecutionDescriptor.
java.util.List<java.lang.String>	getCompletions() Returns a list of the completion states configured for the Interactive Activity linked with the interactive task represented by this ExecutionDescriptor.
java.lang.String	getDescription() Returns the description configured for the interactive task represented by this ExecutionDescriptor
java.util.Map<java.lang.String,java.lang.Object>	getInParameters() Returns a map of the input parameters and their values configured for the Interactive Activity linked with the interactive task represented by this ExecutionDescriptor.
java.util.List<java.lang.String>	getOutParameters() Returns a list of the output parameters configured for the Interactive Activity linked with the interactive task represented by this ExecutionDescriptor.
java.util.Map<java.lang.String,java.lang.String>	getStartupParameters() Returns a map of the startup parameters and their values configured for the Interactive Activity linked with the interactive task represented by this ExecutionDescriptor.
java.lang.String	getTaskEnactmentDescriptor() Returns the unique task descriptor id for the task

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExecutionDescriptor

public ExecutionDescriptor(com.ebasetech.ufs.workflow.server.enactment.InteractiveTaskEnactment enactment,
                           com.ebasetech.ufs.kernel.IUFSServletContextProxy proxy,
                           java.lang.String language)
                    throws com.ebasetech.ufs.utility.PersistenceException,
                           com.ebasetech.ufs.kernel.SetupPropertiesException,
                           com.ebasetech.ufs.workflow.resource.ResourceManagementException

Throws:

com.ebasetech.ufs.utility.PersistenceException

com.ebasetech.ufs.kernel.SetupPropertiesException

com.ebasetech.ufs.workflow.resource.ResourceManagementException

Method Detail

getDescription

public java.lang.String getDescription()

Returns the description configured for the interactive task represented by this ExecutionDescriptor

getActivityType

public java.lang.String getActivityType()

Returns the activity type for the Interactive Activity linked with the interactive task represented by this ExecutionDescriptor. The types for the activity types supplied with the system are:

• Ebase Form Activity - "EbaseFormActivity"
• Custom Activity - "CustomActivityType"
• Manual Task Activity - "ManualTaskActivity"

getStartupParameters

public java.util.Map<java.lang.String,java.lang.String> getStartupParameters()

Returns a map of the startup parameters and their values configured for the Interactive Activity linked with the interactive task represented by this ExecutionDescriptor.

getInParameters

public java.util.Map<java.lang.String,java.lang.Object> getInParameters()

Returns a map of the input parameters and their values configured for the Interactive Activity linked with the interactive task represented by this ExecutionDescriptor.

getOutParameters

public java.util.List<java.lang.String> getOutParameters()

Returns a list of the output parameters configured for the Interactive Activity linked with the interactive task represented by this ExecutionDescriptor.

getCompletions

public java.util.List<java.lang.String> getCompletions()

Returns a list of the completion states configured for the Interactive Activity linked with the interactive task represented by this ExecutionDescriptor.

getTaskEnactmentDescriptor

public java.lang.String getTaskEnactmentDescriptor()

Returns the unique task descriptor id for the task