WorkflowProcess

java.lang.Object
- com.ibm.itim.workflow.model.ExecutionObject
- - com.ibm.itim.workflow.model.WorkflowProcess

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable
```
public class WorkflowProcess
extends ExecutionObject
```
This class contains general information about a workflow process.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`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

Constructors
Constructor and Description

WorkflowProcess()

Constructors
Constructor and Description
`WorkflowProcess()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCanceledJustification()` Returns the reason why the process is canceled.
`java.util.Date`	`getCanceledTime()` Returns the date when the process is canceled.
`DistinguishedName`	`getCancelorDN()` Returns the distinguished name of the person who cancels the process.
`java.lang.String`	`getCancelorName()` Returns the person name who cancels the process.
`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.
`int`	`getSeverityCode()` Returns severity code of the process.
`java.lang.String`	`getSubject()` Returns the subject of the process.
`java.lang.String`	`getSubjectAccessID()` Returns the access DistinguishedName of the subject of the process
`java.lang.String`	`getSubjectAccessName()` Returns the access name of the subject of the process
`java.lang.String`	`getSubjectProfile()` Returns the profile name of the subject of the process.
`java.lang.String`	`getSubjectService()` Returns the subject's service name 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.
`boolean`	`isCanceled()` Determines if the process is canceled
`void`	`setCanceledJustification(java.lang.String justification)` Sets the reason why the process is canceled.
`void`	`setCanceledTime(java.util.Date canceledTime)` Sets the date when the process is canceled.
`void`	`setCancelorDN(DistinguishedName cancelorDN)` Sets the distinguished name of the person who cancels the process.
`void`	`setCancelorName(java.lang.String cancelorName)` Sets the person name who cancels the process.
`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`	`setSeverityCode(int severityCode)` Changes the severity code of the process.
`void`	`setSubject(java.lang.String subject)` Changes the subject of the process.
`void`	`setSubjectAccessID(java.lang.String subjectAccessID)` Changes the subject's access DistinguishedName of the process.
`void`	`setSubjectAccessName(java.lang.String subjectAccessName)` Changes the subject's access name of the process.
`void`	`setSubjectProfile(java.lang.String subjectProfile)` Changes the subject profile name of the process.
`void`	`setSubjectService(java.lang.String subjectService)` Changes the subject's service name of the process.
`void`	`setTenantDN(DistinguishedName tenantDN)` Changes 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.
`java.lang.String`	`toString()`

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, wait, wait, wait

- Field Detail
  - NOTIFY_NONE
```
public static final int NOTIFY_NONE
```
    Constant identifying no notification needed.
    
    See Also:
    
    Constant Field Values
  - NOTIFY_REQUESTER
```
public static final int NOTIFY_REQUESTER
```
    Constant identifying requester notification needed.
    
    See Also:
    
    Constant Field Values
  - NOTIFY_REQUESTED_FOR
```
public static final int NOTIFY_REQUESTED_FOR
```
    Constant identifying requestee notification needed.
    
    See Also:
    
    Constant Field Values
  - NOTIFY_BOTH
```
public static final int NOTIFY_BOTH
```
    Constant identifying both requester and requestee notification needed.
    
    See Also:
    
    Constant Field Values
- 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.
  - getSubjectProfile
```
public java.lang.String getSubjectProfile()
```
    Returns the profile name of the subject of the process.
    
    Returns:
    
    Process subject profile name.
  - getSubjectService
```
public java.lang.String getSubjectService()
```
    Returns the subject's service name of the process.
    
    Returns:
    
    Process subject service name.
  - getSubjectAccessID
```
public java.lang.String getSubjectAccessID()
```
    Returns the access DistinguishedName of the subject of the process
    
    Returns:
    
    Process subject access DistinguishedName.
    
    Since:
    
    ITIM 5.0
  - getSubjectAccessName
```
public java.lang.String getSubjectAccessName()
```
    Returns the access name of the subject of the process
    
    Returns:
    
    Process subject access name.
    
    Since:
    
    ITIM 5.0
  - 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 - WorkflowRequester(Subclass of 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.
  - setSubjectProfile
```
public void setSubjectProfile(java.lang.String subjectProfile)
```
    Changes the subject profile name of the process.
    
    Parameters:
    
    subjectProfile - Subject profile name of the process.
  - setSubjectService
```
public void setSubjectService(java.lang.String subjectService)
```
    Changes the subject's service name of the process.
    
    Parameters:
    
    subjectService - Subject's service name of the process.
  - setSubjectAccessID
```
public void setSubjectAccessID(java.lang.String subjectAccessID)
```
    Changes the subject's access DistinguishedName of the process.
    
    Parameters:
    
    subjectAccessID - Subject's access DistinguishedName of the process.
    
    Since:
    
    ITIM 5.0
  - setSubjectAccessName
```
public void setSubjectAccessName(java.lang.String subjectAccessName)
```
    Changes the subject's access name of the process.
    
    Parameters:
    
    subjectAccessName - Subject's access name of the process.
    
    Since:
    
    ITIM 5.0
  - setTenantDN
```
public void setTenantDN(DistinguishedName tenantDN)
```
    Changes the distinguished name of the tenant executing the process (multi-tenant deployments).
    
    Parameters:
    
    tenantDN - The DistinguishedName of the new tenant DN to use.
  - 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.
  - setSeverityCode
```
public void setSeverityCode(int severityCode)
```
    Changes the severity code of the process. Severity code of a process is mapped to it's result summary field.
    
    Parameters:
    
    severityCode - The severityCode to set.
  - getSeverityCode
```
public int getSeverityCode()
```
    Returns severity code of the process. Severity code of a process is mapped to it's result summary field.
    
    Returns:
    
    severityCode Severity code of the process mapped to result summary.
  - isAbortAllowed
```
public boolean isAbortAllowed()
```
    Check for abortable status.
    
    Returns:
    
    True if workflow process in running, suspended, or not started.
  - getCancelorDN
```
public DistinguishedName getCancelorDN()
```
    Returns the distinguished name of the person who cancels the process.
    
    Returns:
    
    DistinguishedName of the cancelor.
  - isCanceled
```
public boolean isCanceled()
```
    Determines if the process is canceled
    
    Returns:
    
    true if the process is canceled. Otherwise, return false.
  - setCancelorDN
```
public void setCancelorDN(DistinguishedName cancelorDN)
```
    Sets the distinguished name of the person who cancels the process.
  - getCancelorName
```
public java.lang.String getCancelorName()
```
    Returns the person name who cancels the process.
    
    Returns:
    
    the cancelor name.
  - setCancelorName
```
public void setCancelorName(java.lang.String cancelorName)
```
    Sets the person name who cancels the process.
  - getCanceledJustification
```
public java.lang.String getCanceledJustification()
```
    Returns the reason why the process is canceled.
    
    Returns:
    
    the justification for cancelling the process.
  - setCanceledJustification
```
public void setCanceledJustification(java.lang.String justification)
```
    Sets the reason why the process is canceled.
  - getCanceledTime
```
public java.util.Date getCanceledTime()
```
    Returns the date when the process is canceled.
    
    Returns:
    
    the canceled date.
  - setCanceledTime
```
public void setCanceledTime(java.util.Date canceledTime)
```
    Sets the date when the process is canceled.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class ExecutionObject

Fields inherited from class com.ibm.itim.workflow.model.ExecutionObject

Methods inherited from class com.ibm.itim.workflow.model.ExecutionObject

Methods inherited from class java.lang.Object

NOTIFY_NONE

NOTIFY_REQUESTER

NOTIFY_REQUESTED_FOR

NOTIFY_BOTH

WorkflowProcess

getProcessType

getRequester

getRequesterName

getComment

getRequesteeName

getSubject

getSubjectProfile

getSubjectService

getSubjectAccessID

getSubjectAccessName

getTimeSubmitted

getTimeScheduled

getNotificationInstructions

getTenantDN

getParentProcessId

setComment

setNotificationInstructions

setProcessType

setRequesteeName

setRequester

setRequesterName

setSubject

setSubjectProfile

setSubjectService

setSubjectAccessID

setSubjectAccessName

setTenantDN

setTimeSubmitted

setTimeScheduled

setParentProcessId

setRequesteeDN

getRequesteeDN

setSeverityCode

getSeverityCode

isAbortAllowed

getCancelorDN

isCanceled

setCancelorDN

getCancelorName

setCancelorName

getCanceledJustification

setCanceledJustification

getCanceledTime

setCanceledTime

toString