|
IBM BPM API for Web Service Clients v8.0.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lombardisoftware.webapi.ProcessInstance
public class ProcessInstance
A ProcessInstance contains information about an instance of a process. Check the documentation for the operation that returns a ProcessInstance to see what elements are available since a ProcessInstance may be partially loaded (usually just the Id element is present and all the other element are not set or are nil in that case).
Constructor Summary | |
---|---|
ProcessInstance()
|
|
ProcessInstance(java.util.Calendar dueDate,
long id,
java.lang.String name,
java.lang.String status,
Task[] tasks,
Process process,
java.lang.String sharepointSiteUrl,
BusinessData businessData,
java.util.Calendar createDate,
java.util.Calendar modifyDate)
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
|
BusinessData |
getBusinessData()
Gets the businessData value for this ProcessInstance. |
java.util.Calendar |
getCreateDate()
Gets the createDate value for this ProcessInstance. |
static org.apache.axis.encoding.Deserializer |
getDeserializer(java.lang.String mechType,
java.lang.Class _javaType,
javax.xml.namespace.QName _xmlType)
Get Custom Deserializer |
java.util.Calendar |
getDueDate()
Gets the dueDate value for this ProcessInstance. |
long |
getId()
Gets the id value for this ProcessInstance. |
java.util.Calendar |
getModifyDate()
Gets the modifyDate value for this ProcessInstance. |
java.lang.String |
getName()
Gets the name value for this ProcessInstance. |
Process |
getProcess()
Gets the process value for this ProcessInstance. |
static org.apache.axis.encoding.Serializer |
getSerializer(java.lang.String mechType,
java.lang.Class _javaType,
javax.xml.namespace.QName _xmlType)
Get Custom Serializer |
java.lang.String |
getSharepointSiteUrl()
Gets the sharepointSiteUrl value for this ProcessInstance. |
java.lang.String |
getStatus()
Gets the status value for this ProcessInstance. |
Task[] |
getTasks()
Gets the tasks value for this ProcessInstance. |
static org.apache.axis.description.TypeDesc |
getTypeDesc()
Return type metadata object |
int |
hashCode()
|
void |
setBusinessData(BusinessData businessData)
Sets the businessData value for this ProcessInstance. |
void |
setCreateDate(java.util.Calendar createDate)
Sets the createDate value for this ProcessInstance. |
void |
setDueDate(java.util.Calendar dueDate)
Sets the dueDate value for this ProcessInstance. |
void |
setId(long id)
Sets the id value for this ProcessInstance. |
void |
setModifyDate(java.util.Calendar modifyDate)
Sets the modifyDate value for this ProcessInstance. |
void |
setName(java.lang.String name)
Sets the name value for this ProcessInstance. |
void |
setProcess(Process process)
Sets the process value for this ProcessInstance. |
void |
setSharepointSiteUrl(java.lang.String sharepointSiteUrl)
Sets the sharepointSiteUrl value for this ProcessInstance. |
void |
setStatus(java.lang.String status)
Sets the status value for this ProcessInstance. |
void |
setTasks(Task[] tasks)
Sets the tasks value for this ProcessInstance. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ProcessInstance()
public ProcessInstance(java.util.Calendar dueDate, long id, java.lang.String name, java.lang.String status, Task[] tasks, Process process, java.lang.String sharepointSiteUrl, BusinessData businessData, java.util.Calendar createDate, java.util.Calendar modifyDate)
Method Detail |
---|
public java.util.Calendar getDueDate()
public void setDueDate(java.util.Calendar dueDate)
dueDate
- * The due date of the process instance.
Can be missing or nil if the ProcessInstance is only
partially loaded.public long getId()
public void setId(long id)
id
- * The environment identifier of this process instance.public java.lang.String getName()
public void setName(java.lang.String name)
name
- * The instance name as defined by the instance name expression
in the process model.
Can be missing or nil if the ProcessInstance is only
partially loaded.public java.lang.String getStatus()
public void setStatus(java.lang.String status)
status
- * The status of a process instance can be one of the following
values: Active,
Completed, Failed, Terminated, Did_Not_Start, Suspended.
These values are
available via the ProcessInstanceStatus enumeration
for the convenience of
the client developer.
Note that the Status of a process instance will not
change immediately
after completing a task via the CompleteTask operation
since notifications
to the process engine are processed asynchronously.
Can be missing or nil if the ProcessInstance is only
partially loaded.public Task[] getTasks()
public void setTasks(Task[] tasks)
tasks
- * Tasks contains all tasks for the process instance. Tasks in
this collection will
have their ProcessInstance property set to a ProcessInstance
object that only
has its Id set. If it is desired to hook up this property
to the parent object,
the client should do it after retrieving the process
instance(s).
This element will be missing or nil when the ProcessInstance
has been
returned from GetProcessInstancesForSavedSearch or as
part of a Task returned from
GetTasksForSavedSearch (since that operation is task
centric).
The GetProcessInstance operation will return the ProcessInstance
with this
element populated.public Process getProcess()
public void setProcess(Process process)
process
- * The process definition for this process instance. When multiple
process instances
are retrieved, there may be multiple copies of the same
process definition information.
Typically, the Process will have its Id and Name defined
when it is partially loaded.
Can be missing or nil if the ProcessInstance is only
partially loaded.public java.lang.String getSharepointSiteUrl()
public void setSharepointSiteUrl(java.lang.String sharepointSiteUrl)
sharepointSiteUrl
- * For use by WLE for Sharepointpublic BusinessData getBusinessData()
public void setBusinessData(BusinessData businessData)
businessData
- * The BusinessData requested as part of a search or saved search
when that search is organized
by ProcessInstance instead of by Task. This does not
include all the variables used by the
associated process instance - only those specified as
search columns and/or constraints.
Can be missing or nil if the ProcessInstance is only
partially loaded
or if the ProcessInstance was loaded via some other
means besides a saved search.public java.util.Calendar getCreateDate()
public void setCreateDate(java.util.Calendar createDate)
createDate
- * The create date of the process instance.
Can be missing or nil if the ProcessInstance is only
partially loaded.public java.util.Calendar getModifyDate()
public void setModifyDate(java.util.Calendar modifyDate)
modifyDate
- * The modify date of the process instance.
Can be missing or nil if the ProcessInstance is only
partially loaded.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public static org.apache.axis.description.TypeDesc getTypeDesc()
public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
|
IBM BPM API for Web Service Clients v8.0.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |