com.ibm.itim.workflow.model
Class WorkflowProcess

java.lang.Object
  |
  +--com.ibm.itim.workflow.model.ExecutionObject
        |
        +--com.ibm.itim.workflow.model.WorkflowProcess
All Implemented Interfaces:
java.lang.Comparable, java.io.Serializable

public class WorkflowProcess
extends ExecutionObject

This class contains general information about a workflow process.

See Also:
Serialized Form

Field Summary
static int NOTIFY_BOTH
          Constant identifying both requester and requestee notification needed.
static int NOTIFY_NONE
          Constant identifying no notification needed.
static int NOTIFY_REQUESTED_FOR
          Constant identifying requestee notification needed.
static int NOTIFY_REQUESTER
          Constant identifying requester notification needed.
 
Fields inherited from class com.ibm.itim.workflow.model.ExecutionObject
ABORTED, BYPASSED, COMPLETED, DEFAULT_PRIORITY, NOTSTARTED, RUNNING, SUSPENDED, TERMINATED
 
Constructor Summary
WorkflowProcess()
           
 
Method Summary
 java.lang.String getComment()
          Returns any comments associated with the process.
 int getNotificationInstructions()
          Returns the notification instructions for the process.
 long getParentProcessId()
          Returns the parent (instantiating) process of this process.
 java.lang.String getProcessType()
          Returns the type of the process.
 DistinguishedName getRequesteeDN()
          Returns the distinguished name (if any) of the requestee of the process.
 java.lang.String getRequesteeName()
          Returns the name of the process requestee.
 ProcessParticipant getRequester()
          Returns the requester of the process.
 java.lang.String getRequesterName()
          Returns the name of the requester.
 java.lang.String getSubject()
          Returns the subject of the process.
 DistinguishedName getTenantDN()
          Returns the distinguished name of the tenant executing the process (multi-tenant deployments).
 java.util.Date getTimeScheduled()
          Returns the date/time the process is/was scheduled for.
 java.util.Date getTimeSubmitted()
          Returns the date/time the process is/was submitted.
 boolean isAbortAllowed()
          Check for abortable status.
 void setComment(java.lang.String comment)
          Changes the comment for the process.
 void setNotificationInstructions(int instructions)
          Changes the notification instructions for the process.
 void setParentProcessId(long id)
          Changes the parent (instantiating) process of this process.
 void setProcessType(java.lang.String processType)
          Changes the type of the process.
 void setRequesteeDN(DistinguishedName requesteeDN)
          Changes the distinguished name (if any) of the requestee of the process.
 void setRequesteeName(java.lang.String name)
          Changes the name of the process requestee.
 void setRequester(ProcessParticipant requester)
          Changes the requester of the process.
 void setRequesterName(java.lang.String name)
          Changes the name of the process requester.
 void setSubject(java.lang.String subject)
          Changes the subject of the process.
 void setTenantDN(DistinguishedName tenantDN)
          Chamges the distinguished name of the tenant executing the process (multi-tenant deployments).
 void setTimeScheduled(java.util.Date timeScheduled)
          Changes the scheduled time for the process.
 void setTimeSubmitted(java.util.Date timeSubmitted)
          Changes the submitted time for the process.
 
Methods inherited from class com.ibm.itim.workflow.model.ExecutionObject
compareTo, getDescription, getId, getLastModified, getName, getPriority, getResult, getResultDetail, getState, getTimeCompleted, getTimeStarted, isFinished, setDescription, setId, setLastModified, setName, setPriority, setResult, setResultDetail, setState, setTimeCompleted, setTimeStarted
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NOTIFY_NONE

public static final int NOTIFY_NONE
Constant identifying no notification needed.

NOTIFY_REQUESTER

public static final int NOTIFY_REQUESTER
Constant identifying requester notification needed.

NOTIFY_REQUESTED_FOR

public static final int NOTIFY_REQUESTED_FOR
Constant identifying requestee notification needed.

NOTIFY_BOTH

public static final int NOTIFY_BOTH
Constant identifying both requester and requestee notification needed.
Constructor Detail

WorkflowProcess

public WorkflowProcess()
Method Detail

getProcessType

public java.lang.String getProcessType()
Returns the type of the process.
Returns:
Process type.

getRequester

public ProcessParticipant getRequester()
Returns the requester of the process. If the process was requested by the system through automation caused by a parent process, this value will be the parent process activity id. If the process was requested by the system through automation caused by a recurring schedule task, this value will be the null DN value.
Returns:
ProcessParticipant representing the requestor of the process.

getRequesterName

public java.lang.String getRequesterName()
Returns the name of the requester.
Returns:
Name of the requester.

getComment

public java.lang.String getComment()
Returns any comments associated with the process.
Returns:
Process comments.

getRequesteeName

public java.lang.String getRequesteeName()
Returns the name of the process requestee. It returns null if there is no requestee associated with the process
Returns:
Name of the requestee.

getSubject

public java.lang.String getSubject()
Returns the subject of the process.
Returns:
Process subject.

getTimeSubmitted

public java.util.Date getTimeSubmitted()
Returns the date/time the process is/was submitted.
Returns:
Date the process is/was submitted.

getTimeScheduled

public java.util.Date getTimeScheduled()
Returns the date/time the process is/was scheduled for.
Returns:
Date the process is/was scheduled for.

getNotificationInstructions

public int getNotificationInstructions()
Returns the notification instructions for the process.
Returns:
Enumerated int representing instructions, NOTIFY_NONE, NOTIFY_REQUESTER, NOTIFY_REQUESTED_FOR, NOTIFY_BOTH.

getTenantDN

public DistinguishedName getTenantDN()
Returns the distinguished name of the tenant executing the process (multi-tenant deployments).
Returns:
DistinguishedName of the tenant.

getParentProcessId

public long getParentProcessId()
Returns the parent (instantiating) process of this process.
Returns:
Identifier of the parent process.

setComment

public void setComment(java.lang.String comment)
Changes the comment for the process.
Parameters:
comment - New comment.

setNotificationInstructions

public void setNotificationInstructions(int instructions)
Changes the notification instructions for the process.
Parameters:
instructions - Enumerated int representing instructions, NOTIFY_NONE, NOTIFY_REQUESTER, NOTIFY_REQUESTED_FOR, NOTIFY_BOTH.

setProcessType

public void setProcessType(java.lang.String processType)
Changes the type of the process.
Parameters:
processType - String name of the process type.

setRequesteeName

public void setRequesteeName(java.lang.String name)
Changes the name of the process requestee.
Parameters:
name - Name of the process requestee.

setRequester

public void setRequester(ProcessParticipant requester)
Changes the requester of the process.
Parameters:
requester - ProcessParticipant representing the requestor of the process.

setRequesterName

public void setRequesterName(java.lang.String name)
Changes the name of the process requester.
Parameters:
name - Name of the process requester.

setSubject

public void setSubject(java.lang.String subject)
Changes the subject of the process.
Parameters:
subject - Subject of the process.

setTenantDN

public void setTenantDN(DistinguishedName tenantDN)
Chamges the distinguished name of the tenant executing the process (multi-tenant deployments).
Returns:
DistinguishedName of the tenant.

setTimeSubmitted

public void setTimeSubmitted(java.util.Date timeSubmitted)
Changes the submitted time for the process.
Parameters:
timeSubmitted - Date holding the submitted time for the process.

setTimeScheduled

public void setTimeScheduled(java.util.Date timeScheduled)
Changes the scheduled time for the process.
Parameters:
timeScheduled - Date holding the scheduled time for the process.

setParentProcessId

public void setParentProcessId(long id)
Changes the parent (instantiating) process of this process.
Parameters:
id - Identifier of the parent process.

setRequesteeDN

public void setRequesteeDN(DistinguishedName requesteeDN)
Changes the distinguished name (if any) of the requestee of the process.
Parameters:
requesteeDN - DistinguishedName of the requestee.

getRequesteeDN

public DistinguishedName getRequesteeDN()
Returns the distinguished name (if any) of the requestee of the process.
Returns:
DistinguishedName of the requestee. Not all processes are requested by a human entity with a distinguished name. The process may have been requested by the system. If no human requested the process, null will be returned.

isAbortAllowed

public boolean isAbortAllowed()
Check for abortable status.
Returns:
True if workflow process in running, suspended, or not started.