com.ibm.itim.workflow.model
Class InitialProcessContext

java.lang.Object
  |
  +--com.ibm.itim.workflow.model.InitialProcessContext

All Implemented Interfaces:

java.io.Serializable

public class InitialProcessContext

extends java.lang.Object

implements java.io.Serializable

Class that holds the intitial context of a workflow process, including the type of the process, the scheduled time of the process, the relevant data to be used as the process runtime context, and other configuable items that define how the process will execute.

See Also:

Serialized Form

Constructor Summary

InitialProcessContext(DistinguishedName tenantDN, java.lang.String type)
Constructs with a tenant as the namespace of the process and the process type.

InitialProcessContext(DistinguishedName tenantDN, java.lang.String type, java.util.List processContext)
Constructs with a tenant as the namespace of the process, the process type, and context data.

InitialProcessContext(java.lang.String type)
Constructs with the process type only.

InitialProcessContext(java.lang.String type, java.util.List processContext)
Constructs with the process type and context data.

Method Summary

java.lang.String	getComment() Returns the comment about the workflow process.
java.lang.String	getDescription() Returns the description of the workflow process.
int	getNotificationInstruction() Returns who will receive an email notification at process completion.
java.util.List	getProcessContext() Returns the process context data.
java.util.Date	getScheduledTime() Returns the date/time the process is scheduled to start.
DistinguishedName	getTenantDN() Returns the tenant namespace of the process.
java.lang.String	getType() Returns the type of the workflow process.
void	setComment(java.lang.String comment) Changes the comment about the workflow process.
void	setDescription(java.lang.String description) Changes the description of the workflow process.
void	setNotificationInstruction(int instruction) Determines who will receive an email notification at process completion.
void	setProcessContext(java.util.List processContext) Changes the process context data.
void	setScheduledTime(java.util.Date scheduledTime) Changes the scheduled date/time of the process.
void	setTenantDN(DistinguishedName tenantDN) Changes the tenant namespace of the process.
void	setType(java.lang.String type) Changes the type of the workflow process.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InitialProcessContext

public InitialProcessContext(java.lang.String type)

Constructs with the process type only. The scheduled time will be immediate by default.

Parameters:

type - Type of the process. This process type must be registered with the workflow engine.

InitialProcessContext

public InitialProcessContext(DistinguishedName tenantDN,
                             java.lang.String type)

Constructs with a tenant as the namespace of the process and the process type. This is for multi-tenant deployments. The scheduled time will be immediate by default.

Parameters:

tenantDN - DistinguishedName of tenant that provides the namespace in which the process will execute.

type - Type of the process. This process type must be registered with the workflow engine.

InitialProcessContext

public InitialProcessContext(java.lang.String type,
                             java.util.List processContext)

Constructs with the process type and context data. The scheduled time will be immediate by default.

Parameters:

type - Type of the process. This process type must be registered with the workflow engine.

processContext - List of RelevantDataItems representing the process context to initialize with.

InitialProcessContext

public InitialProcessContext(DistinguishedName tenantDN,
                             java.lang.String type,
                             java.util.List processContext)

Constructs with a tenant as the namespace of the process, the process type, and context data. This is for multi-tenant deployments. The scheduled time will be immediate by default.

Parameters:

tenantDN - DistinguishedName of tenant that provides the namespace in which the process will execute.

type - Type of the process. This process type must be registered with the workflow engine.

processContext - List of RelevantDataItems representing the process context to initialize with.

Method Detail

setScheduledTime

public void setScheduledTime(java.util.Date scheduledTime)

Changes the scheduled date/time of the process. If null, the process will be started immediately.

Parameters:

scheduledTime - The scheduled starting time of the process. If null, the process will start immediately. In case this method is invoked remotely, passing this parameter as the current data/time of the client machine is not a safe technique to use, since the date/time of the client machine may not be the same as the date/time of the ITIM server machine.

getScheduledTime

public java.util.Date getScheduledTime()

Returns the date/time the process is scheduled to start.

Returns:

Date holding the date/time the process is scheduled to start.

getTenantDN

public DistinguishedName getTenantDN()

Returns the tenant namespace of the process. This is used in multi-tenant deployments.

Returns:

DistinguishedName of the tenant.

setTenantDN

public void setTenantDN(DistinguishedName tenantDN)

Changes the tenant namespace of the process. This is used in multi-tenant deployments.

Parameters:

tenantDN - DistinguishedName of the tenant.

setType

public void setType(java.lang.String type)

Changes the type of the workflow process. This type must be registered with the workflow engine.

Parameters:

type - String representing the process type.

getType

public java.lang.String getType()

Returns the type of the workflow process.

Returns:

Type of the process.

setDescription

public void setDescription(java.lang.String description)

Changes the description of the workflow process.

Parameters:

description - Process description.

getDescription

public java.lang.String getDescription()

Returns the description of the workflow process.

Returns:

Process description.

setComment

public void setComment(java.lang.String comment)

Changes the comment about the workflow process.

Parameters:

comment - Descriptive comment about the process.

getComment

public java.lang.String getComment()

Returns the comment about the workflow process.

Returns:

Descriptive comment about the process.

setNotificationInstruction

public void setNotificationInstruction(int instruction)

Determines who will receive an email notification at process completion. The default is WorkflowProcess.NOTIFY_NONE.

Parameters:

instruction - Enumeration indicating who to notify. The values are: WorkflowProcess.NOTIFY_NONE, WorkflowProcess.NOTIFY_REQUESTER, WorkflowProcess.NOTIFY_REQUESTED_FOR, WorkflowProcess.NOTIFY_BOTH.

getNotificationInstruction

public int getNotificationInstruction()

Returns who will receive an email notification at process completion.

Returns:

Enumeration indicating who to notify. The values are WorkflowProcess.NOTIFY_NONE, WorkflowProcess.NOTIFY_REQUESTER, WorkflowProcess.NOTIFY_REQUESTED_FOR, and WorkflowProcess.NOTIFY_BOTH.

getProcessContext

public java.util.List getProcessContext()

Returns the process context data.

Returns:

List of RelevantDataItems representing the process context data.

setProcessContext

public void setProcessContext(java.util.List processContext)

Changes the process context data.

Parameters:

processContext - List of RelevantDataItems representing the process context data.