IBM BPM API for Web Service Clients v8.0.0

com.lombardisoftware.webapi
Class ProcessInstance

java.lang.Object
  extended by com.lombardisoftware.webapi.ProcessInstance
All Implemented Interfaces:
java.io.Serializable

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

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).

See Also:
Serialized Form

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

ProcessInstance

public ProcessInstance()

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

getDueDate

public java.util.Calendar getDueDate()
Gets the dueDate value for this ProcessInstance.

Returns:
dueDate * The due date of the process instance. Can be missing or nil if the ProcessInstance is only partially loaded.

setDueDate

public void setDueDate(java.util.Calendar dueDate)
Sets the dueDate value for this ProcessInstance.

Parameters:
dueDate - * The due date of the process instance. Can be missing or nil if the ProcessInstance is only partially loaded.

getId

public long getId()
Gets the id value for this ProcessInstance.

Returns:
id * The environment identifier of this process instance.

setId

public void setId(long id)
Sets the id value for this ProcessInstance.

Parameters:
id - * The environment identifier of this process instance.

getName

public java.lang.String getName()
Gets the name value for this ProcessInstance.

Returns:
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.

setName

public void setName(java.lang.String name)
Sets the name value for this ProcessInstance.

Parameters:
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.

getStatus

public java.lang.String getStatus()
Gets the status value for this ProcessInstance.

Returns:
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.

setStatus

public void setStatus(java.lang.String status)
Sets the status value for this ProcessInstance.

Parameters:
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.

getTasks

public Task[] getTasks()
Gets the tasks value for this ProcessInstance.

Returns:
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.

setTasks

public void setTasks(Task[] tasks)
Sets the tasks value for this ProcessInstance.

Parameters:
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.

getProcess

public Process getProcess()
Gets the process value for this ProcessInstance.

Returns:
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.

setProcess

public void setProcess(Process process)
Sets the process value for this ProcessInstance.

Parameters:
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.

getSharepointSiteUrl

public java.lang.String getSharepointSiteUrl()
Gets the sharepointSiteUrl value for this ProcessInstance.

Returns:
sharepointSiteUrl * For use by WLE for Sharepoint

setSharepointSiteUrl

public void setSharepointSiteUrl(java.lang.String sharepointSiteUrl)
Sets the sharepointSiteUrl value for this ProcessInstance.

Parameters:
sharepointSiteUrl - * For use by WLE for Sharepoint

getBusinessData

public BusinessData getBusinessData()
Gets the businessData value for this ProcessInstance.

Returns:
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.

setBusinessData

public void setBusinessData(BusinessData businessData)
Sets the businessData value for this ProcessInstance.

Parameters:
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.

getCreateDate

public java.util.Calendar getCreateDate()
Gets the createDate value for this ProcessInstance.

Returns:
createDate * The create date of the process instance. Can be missing or nil if the ProcessInstance is only partially loaded.

setCreateDate

public void setCreateDate(java.util.Calendar createDate)
Sets the createDate value for this ProcessInstance.

Parameters:
createDate - * The create date of the process instance. Can be missing or nil if the ProcessInstance is only partially loaded.

getModifyDate

public java.util.Calendar getModifyDate()
Gets the modifyDate value for this ProcessInstance.

Returns:
modifyDate * The modify date of the process instance. Can be missing or nil if the ProcessInstance is only partially loaded.

setModifyDate

public void setModifyDate(java.util.Calendar modifyDate)
Sets the modifyDate value for this ProcessInstance.

Parameters:
modifyDate - * The modify date of the process instance. Can be missing or nil if the ProcessInstance is only partially loaded.

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()
Return type metadata object


getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)
Get Custom Serializer


getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)
Get Custom Deserializer


IBM BPM API for Web Service Clients v8.0.0

(C) Copyright IBM Corporation 2011. All Rights Reserved.