|
WebLogic Integration | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.bea.wlpi.common.InstanceInfo
Holds information about a workflow instance.
Objects of this class override the boolean equals(Object)
and
implement the comparable
interface. Homogeneous collections
containing objects of this class may, therefore, be searched and sorted using
the Collection.contains(Object), List.indexOf(Object),
Collections.sort(List)
methods.
Field Summary | |
static int |
WORKFLOW_STATE_ACTIVE
Workflow instance is running normally. |
static int |
WORKFLOW_STATE_SUSPENDED
Workflow instance has been suspended. |
Constructor Summary | |
InstanceInfo(java.lang.String id,
java.lang.String templateId,
java.lang.String templateDefinitionId,
java.lang.String name,
java.lang.String initiator,
java.lang.String parentId,
java.sql.Timestamp started,
java.sql.Timestamp completed,
java.lang.String idString,
int state,
java.lang.String comment)
Create a new InstanceInfo object. |
|
InstanceInfo(java.lang.String id,
java.lang.String templateId,
java.lang.String templateDefinitionId,
java.lang.String name,
java.lang.String initiator,
java.lang.String parentId,
java.sql.Timestamp started,
java.sql.Timestamp completed,
java.lang.String idString,
int state,
java.lang.String comment,
java.util.Map pluginData)
Create a new InstanceInfo object. |
Method Summary | |
int |
compareTo(java.lang.Object o)
Compare two InstanceInfo objects. |
boolean |
equals(java.lang.Object obj)
Test two InstanceInfo objects for equality. |
java.lang.String |
getComment()
Return the human-readable workflow instance comment. |
java.sql.Timestamp |
getCompleted()
Return the date/time at which the workflow was completed. |
java.lang.String |
getId()
Return the workflow instance ID. |
java.lang.String |
getIdString()
Return a human-readable workflow instance label. |
java.lang.String |
getInitiator()
Return the workflow initiator ID. |
java.lang.String |
getName()
Return the template definition name. |
java.lang.String |
getParentId()
Return the parent workflow instance ID. |
java.lang.Object |
getPluginInstanceData(java.lang.String pluginName)
Retrieve the plugin-supplied data associated with the workflow instance. |
java.sql.Timestamp |
getStarted()
Return the date/time at which the workflow was instantiated. |
int |
getState()
Return the workflow instance state. |
java.lang.String |
getTemplateDefinitionId()
Return the workflow template definition ID. |
java.lang.String |
getTemplateId()
Return the workflow template ID. |
java.lang.String |
toString()
Return a string representation of the object. |
Methods inherited from class java.lang.Object |
clone,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
public static final int WORKFLOW_STATE_SUSPENDED
public static final int WORKFLOW_STATE_ACTIVE
Constructor Detail |
public InstanceInfo(java.lang.String id, java.lang.String templateId, java.lang.String templateDefinitionId, java.lang.String name, java.lang.String initiator, java.lang.String parentId, java.sql.Timestamp started, java.sql.Timestamp completed, java.lang.String idString, int state, java.lang.String comment)
InstanceInfo
object.
id
- The workflow instance ID.templateId
- The ID of the workflow template.templateDefinitionId
- The ID of the workflow template definition.name
- The template definition name.initiator
- The ID of the workflow initiator.parentId
- The ID of the parent workflow instance (when started
programmatically as a sub-workflow).started
- The date/time at which the workflow was instantiated.completed
- The date/time at which the workflow was completed.idString
- The human-readable workflow instance label.state
- The workflow instance state:
WORKFLOW_STATE_SUSPENDED
or WORKFLOW_STATE_ACTIVE
.comment
- Human-readable workflow instance comment.public InstanceInfo(java.lang.String id, java.lang.String templateId, java.lang.String templateDefinitionId, java.lang.String name, java.lang.String initiator, java.lang.String parentId, java.sql.Timestamp started, java.sql.Timestamp completed, java.lang.String idString, int state, java.lang.String comment, java.util.Map pluginData)
InstanceInfo
object.
id
- The workflow instance ID.templateId
- The ID of the workflow template.templateDefinitionId
- The ID of the workflow template definition.name
- The template definition name.initiator
- The ID of the workflow initiator.parentId
- The ID of the parent workflow instance (when started
programmatically as a sub-workflow).started
- The date/time at which the workflow was instantiated.completed
- The date/time at which the workflow was completed.idString
- The human-readable workflow instance label.state
- The workflow instance state:
WORKFLOW_STATE_SUSPENDED
or WORKFLOW_STATE_ACTIVE
.comment
- Human-readable workflow instance comment.pluginData
- A collection of plugin-defined instance data. The
map is keyed on plugin name, and each element is a plugin-defined
instance datum.Method Detail |
public final java.lang.String getId()
public final java.lang.String getTemplateId()
public final java.lang.String getTemplateDefinitionId()
public final java.lang.String getName()
public java.lang.Object getPluginInstanceData(java.lang.String pluginName)
pluginName
- The name of the plugin.public final java.lang.String getInitiator()
public final java.lang.String getParentId()
public final java.sql.Timestamp getStarted()
public final java.sql.Timestamp getCompleted()
public final java.lang.String getIdString()
public final int getState()
WORKFLOW_STATE_SUSPENDED
or WORKFLOW_STATE_ACTIVE
.public final java.lang.String getComment()
public boolean equals(java.lang.Object obj)
InstanceInfo
objects for equality.
obj
- The Object with which to compare this one.true
if obj
is an instance of
InstanceInfo
with the same ID as this one.compareTo(java.lang.Object)
public int compareTo(java.lang.Object o)
InstanceInfo
objects.
obj
- Object with which to compare this one. Must be
null
or an instance of InstanceInfo
.started
members using the Date.compareTo(Object)
method.o
is not an instance of
InstanceInfo
.equals(java.lang.Object)
public java.lang.String toString()
|
WebLogic Integration | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |