wt.workflow.engine
Class WfEventConfiguration

java.lang.Object
  wt.workflow.engine.WfEventConfiguration

All Implemented Interfaces:

Externalizable, Serializable

public class WfEventConfiguration

extends Object

implements Externalizable

WfEventConfiguration controls the execution behavior of the obejct. For example, it holds information about which events are recorded and/or emitted. The execution behavior is represented by a set of boolean flags (true/false) and stored as bits in a long integer. The position of the bit determines its function. It is used both by the WfExecutionObject and WfProcessTemplate classes.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static boolean	ABORT_ON_EXCEPTION
private static boolean	ABORT_PROCESS_ON_EXCEPTION
private static long	abortOnException
private static long	abortProcessOnException
private static boolean	ACT_ON_OVERDUE
private static long	actOnOverdue
private static boolean	ASYNCHRONOUS_EXECUTION
private static long	asynchronousExecution
private static String	CLASSNAME
private static boolean	COMPLETE_ON_OVERDUE
private static long	completeOnOverdue
private long	configuration
private static boolean	CREATE_INSTANCE
private static long	createInstance
private static boolean	DEDICATED_QUEUE
private static long	dedicatedQueue
private static boolean	DOMAIN_BASED_WORKFLOW
private static long	domainBasedWorkflow
private static boolean	EMIT_ACTIVITY_DATA_CHANGE
private static boolean	EMIT_ACTIVITY_STATE_CHANGE
private static boolean	EMIT_ASSIGNEE_CHANGE
private static boolean	EMIT_EXCEPTION
private static boolean	EMIT_PROCESS_CREATION
private static boolean	EMIT_PROCESS_DATA_CHANGE
private static boolean	EMIT_PROCESS_STATE_CHANGE
private static long	emitActivityDataChange
private static long	emitActivityStateChange
private static long	emitAssigneeChange
private static long	emitException
private static long	emitProcessCreation
private static long	emitProcessDataChange
private static long	emitProcessStateChange
static long	EXTERNALIZATION_VERSION_UID
private static boolean	IGNORE_UNRESOLVED_ROLE
private static long	ignoreUnresolvedRole
private static boolean	NOTIFY_ON_ABORT
private static boolean	NOTIFY_ON_APPROACHING_DEADLINE
private static boolean	NOTIFY_ON_COMPLETE
private static boolean	NOTIFY_ON_EXCEPTION
private static boolean	NOTIFY_ON_OVERDUE
private static boolean	NOTIFY_ON_PAST_DEADLINE
private static long	notifyOnAbort
private static long	notifyOnApproachingDeadline
private static long	notifyOnComplete
private static long	notifyOnException
private static long	notifyOnOverdue
private static long	notifyOnPastDeadline
protected static long	OLD_FORMAT_VERSION_UID
private static boolean	REASSIGN_ON_OVERDUE
private static long	reassignOnOverdue
private static boolean	RECORD_ACTIVITY_DATA_CHANGE
private static boolean	RECORD_ACTIVITY_STATE_CHANGE
private static boolean	RECORD_ASSIGNEE_CHANGE
private static boolean	RECORD_EXCEPTION
private static boolean	RECORD_PROCESS_CREATION
private static boolean	RECORD_PROCESS_DATA_CHANGE
private static boolean	RECORD_PROCESS_STATE_CHANGE
private static boolean	RECORD_VOTING
private static long	recordActivityDataChange
private static long	recordActivityStateChange
private static long	recordAssigneeChange
private static long	recordException
private static long	recordProcessCreation
private static long	recordProcessDataChange
private static long	recordProcessStateChange
private static long	recordVoting
private static String	RESOURCE
(package private) static long	serialVersionUID
private static boolean	SKIP_ON_OVERDUE
private static long	skipOnOverdue
private static boolean	START_COMPUTED
private static long	startComputed

Constructor Summary

WfEventConfiguration()
Constructs an event configuration object according to the default configuration specified in the wt.properties file.

WfEventConfiguration(long configuration)


Supported API: false

Method Summary

WfEventConfiguration	copy() Returns a copy of the event configuration.
private String	getEmit(long b1, long b2) Returns "E" if there is a match between parameters; "" if not.
private String	getRecord(long b1, long b2) Returns "R" if there is a match between parameters; "" if not.
boolean	isAsynchronousExecution() Returns true if execution object doesn't terminate when the process in which it is embedded finishes; false otherwise.
boolean	isCreateInstance() Returns whether the execution instance is to be reused or a new one created when a node is visited.
boolean	isDedicatedQueue() Returns true if the execution object has dedicated queues; false otherwise.
boolean	isDomainBasedWorkflow() Returns whether the process instances will run in workflow folders of their PBO or process template - as opposed to the System domain.
boolean	isEventEmitted(WfEventAuditType event_type) Returns whether or the event of the type passed as argument is or not emitted.
boolean	isEventRecorded(WfEventAuditType event_type) Returns whether or the event of the type passed as argument is or not recorded.
boolean	isExceptionAction(WfExceptionActionType action_type) Supported API: false
boolean	isIgnoreUnresolvedRole() Returns true if the unresolved roles in assigned activities should be ignored (no workitem generated); false otherwise.
boolean	isNotifyOnApproachingDeadline() Returns true if notification is sent to responsible role when some pre-specified time before deadline is reached; false otherwise.
boolean	isNotifyOnComplete() Returns true if notification is sent to responsible role when execution object completes; false otherwise.
boolean	isNotifyOnPastDeadline() Returns true if notification is sent to responsible role when some pre-sepecified time after deadline is reached; false otherwise.
boolean	isOverdueAction() Returns true if any of the overdue actions is set; false otherwise.
boolean	isOverdueAction(WfOverdueActionType action_type) Supported API: false
boolean	isStartComputed() Returns whether the time to start is entered (false) or computed (true).
boolean	isVotingRecorded() Supported API: false
long	longValue() Returns permission mask.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(WfEventConfiguration thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAsynchronousExecution(boolean asynch) Sets execution synchonicity to the value passed as argument.
void	setCreateInstance(boolean create) Set whether the execution instance is to be reused or a new one created when a node is visited.
void	setDedicatedQueue(boolean dedicated) Sets dedicated queue attribute to the value passed as argument.
void	setDomainBasedWorkflow(boolean domFolders) Sets whether the process instances will run in workflow folders of their PBO or process template - as opposed to the System domain.
void	setEventEmitted(WfEventAuditType event_type, boolean emit) Sets whether or not emit the event of the type passed as argument.
void	setEventRecorded(WfEventAuditType event_type, boolean record) Sets whether or not record the event of the type passed as argument.
void	setExceptionAction(WfExceptionActionType action_type, boolean act) Supported API: false
void	setIgnoreUnresolvedRole(boolean ignore) Sets the properties that controls whether unresolved roles in assigned activities should be ignored (no workitem generated).
void	setNotifyOnApproachingDeadline(boolean notify) Sets notification on approaching deadline attribute to the value passed as argument.
void	setNotifyOnComplete(boolean notify) Sets completion notification attribute to the value passed as argument.
void	setNotifyOnPastDeadline(boolean notify) Sets notification on past deadline attribute to the value passed as argument.
void	setOverdueAction(WfOverdueActionType action_type, boolean act) Supported API: false
void	setStartComputed(boolean computed) Sets whether the time to start is entered (false) or computed (true).
void	setVotingRecorded(boolean record) Supported API: false
String	toString() Returns a string representation of the connector object.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

configuration

private long configuration

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

recordProcessStateChange

private static final long recordProcessStateChange

See Also:

Constant Field Values

RECORD_PROCESS_STATE_CHANGE

private static final boolean RECORD_PROCESS_STATE_CHANGE

emitProcessStateChange

private static final long emitProcessStateChange

See Also:

Constant Field Values

EMIT_PROCESS_STATE_CHANGE

private static final boolean EMIT_PROCESS_STATE_CHANGE

recordActivityStateChange

private static final long recordActivityStateChange

See Also:

Constant Field Values

RECORD_ACTIVITY_STATE_CHANGE

private static final boolean RECORD_ACTIVITY_STATE_CHANGE

emitActivityStateChange

private static final long emitActivityStateChange

See Also:

Constant Field Values

EMIT_ACTIVITY_STATE_CHANGE

private static final boolean EMIT_ACTIVITY_STATE_CHANGE

recordProcessDataChange

private static final long recordProcessDataChange

See Also:

Constant Field Values

RECORD_PROCESS_DATA_CHANGE

private static final boolean RECORD_PROCESS_DATA_CHANGE

emitProcessDataChange

private static final long emitProcessDataChange

See Also:

Constant Field Values

EMIT_PROCESS_DATA_CHANGE

private static final boolean EMIT_PROCESS_DATA_CHANGE

recordActivityDataChange

private static final long recordActivityDataChange

See Also:

Constant Field Values

RECORD_ACTIVITY_DATA_CHANGE

private static final boolean RECORD_ACTIVITY_DATA_CHANGE

emitActivityDataChange

private static final long emitActivityDataChange

See Also:

Constant Field Values

EMIT_ACTIVITY_DATA_CHANGE

private static final boolean EMIT_ACTIVITY_DATA_CHANGE

recordProcessCreation

private static final long recordProcessCreation

See Also:

Constant Field Values

RECORD_PROCESS_CREATION

private static final boolean RECORD_PROCESS_CREATION

emitProcessCreation

private static final long emitProcessCreation

See Also:

Constant Field Values

EMIT_PROCESS_CREATION

private static final boolean EMIT_PROCESS_CREATION

recordAssigneeChange

private static final long recordAssigneeChange

See Also:

Constant Field Values

RECORD_ASSIGNEE_CHANGE

private static final boolean RECORD_ASSIGNEE_CHANGE

emitAssigneeChange

private static final long emitAssigneeChange

See Also:

Constant Field Values

EMIT_ASSIGNEE_CHANGE

private static final boolean EMIT_ASSIGNEE_CHANGE

recordException

private static final long recordException

See Also:

Constant Field Values

RECORD_EXCEPTION

private static final boolean RECORD_EXCEPTION

emitException

private static final long emitException

See Also:

Constant Field Values

EMIT_EXCEPTION

private static final boolean EMIT_EXCEPTION

notifyOnException

private static final long notifyOnException

See Also:

Constant Field Values

NOTIFY_ON_EXCEPTION

private static final boolean NOTIFY_ON_EXCEPTION

notifyOnAbort

private static final long notifyOnAbort

See Also:

Constant Field Values

NOTIFY_ON_ABORT

private static final boolean NOTIFY_ON_ABORT

abortOnException

private static final long abortOnException

See Also:

Constant Field Values

ABORT_ON_EXCEPTION

private static final boolean ABORT_ON_EXCEPTION

abortProcessOnException

private static final long abortProcessOnException

See Also:

Constant Field Values

ABORT_PROCESS_ON_EXCEPTION

private static final boolean ABORT_PROCESS_ON_EXCEPTION

notifyOnOverdue

private static final long notifyOnOverdue

See Also:

Constant Field Values

NOTIFY_ON_OVERDUE

private static final boolean NOTIFY_ON_OVERDUE

actOnOverdue

private static final long actOnOverdue

See Also:

Constant Field Values

ACT_ON_OVERDUE

private static final boolean ACT_ON_OVERDUE

reassignOnOverdue

private static final long reassignOnOverdue

See Also:

Constant Field Values

REASSIGN_ON_OVERDUE

private static final boolean REASSIGN_ON_OVERDUE

completeOnOverdue

private static final long completeOnOverdue

See Also:

Constant Field Values

COMPLETE_ON_OVERDUE

private static final boolean COMPLETE_ON_OVERDUE

skipOnOverdue

private static final long skipOnOverdue

See Also:

Constant Field Values

SKIP_ON_OVERDUE

private static final boolean SKIP_ON_OVERDUE

notifyOnComplete

private static final long notifyOnComplete

See Also:

Constant Field Values

NOTIFY_ON_COMPLETE

private static final boolean NOTIFY_ON_COMPLETE

notifyOnApproachingDeadline

private static final long notifyOnApproachingDeadline

See Also:

Constant Field Values

NOTIFY_ON_APPROACHING_DEADLINE

private static final boolean NOTIFY_ON_APPROACHING_DEADLINE

notifyOnPastDeadline

private static final long notifyOnPastDeadline

See Also:

Constant Field Values

NOTIFY_ON_PAST_DEADLINE

private static final boolean NOTIFY_ON_PAST_DEADLINE

asynchronousExecution

private static final long asynchronousExecution

See Also:

Constant Field Values

ASYNCHRONOUS_EXECUTION

private static final boolean ASYNCHRONOUS_EXECUTION

dedicatedQueue

private static final long dedicatedQueue

See Also:

Constant Field Values

DEDICATED_QUEUE

private static final boolean DEDICATED_QUEUE

ignoreUnresolvedRole

private static final long ignoreUnresolvedRole

See Also:

Constant Field Values

IGNORE_UNRESOLVED_ROLE

private static final boolean IGNORE_UNRESOLVED_ROLE

startComputed

private static final long startComputed

See Also:

Constant Field Values

START_COMPUTED

private static final boolean START_COMPUTED

domainBasedWorkflow

private static final long domainBasedWorkflow

See Also:

Constant Field Values

DOMAIN_BASED_WORKFLOW

private static final boolean DOMAIN_BASED_WORKFLOW

createInstance

private static final long createInstance

See Also:

Constant Field Values

CREATE_INSTANCE

private static final boolean CREATE_INSTANCE

recordVoting

private static final long recordVoting

See Also:

Constant Field Values

RECORD_VOTING

private static final boolean RECORD_VOTING

Constructor Detail

WfEventConfiguration

public WfEventConfiguration()

Constructs an event configuration object according to the default configuration specified in the wt.properties file.

Supported API: false

WfEventConfiguration

public WfEventConfiguration(long configuration)

Supported API: false

Parameters:

configuration -

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WfEventConfiguration thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

setEventEmitted

public void setEventEmitted(WfEventAuditType event_type,
                            boolean emit)

Sets whether or not emit the event of the type passed as argument.

Note that the event types are mapped to the following classes of audit events: process creation, process state change, process data change, activity state change, activity data change, assignment change and execution error.

Supported API: false

Parameters:

event_type -

emit -

setEventRecorded

public void setEventRecorded(WfEventAuditType event_type,
                             boolean record)

Sets whether or not record the event of the type passed as argument.

Note that the event types are mapped to the following classes of audit events: process creation, state change, data change, assignment change and execution error.

Supported API: false

Parameters:

event_type -

record -

isEventEmitted

public boolean isEventEmitted(WfEventAuditType event_type)

Returns whether or the event of the type passed as argument is or not emitted.

Note that the event types are mapped to the following classes of audit events: process creation, process state change, process data change, activity state change, activity data change, assignment change and execution error.

Supported API: false

Parameters:

event_type -

Returns:

boolean

isEventRecorded

public boolean isEventRecorded(WfEventAuditType event_type)

Returns whether or the event of the type passed as argument is or not recorded.

Note that the event types are mapped to the following classes of audit events: process creation, process state change, process data change, activity state change, activity data change, assignment change and execution error.

Supported API: false

Parameters:

event_type -

Returns:

boolean

toString

public String toString()

Returns a string representation of the connector object. Used mostly for debugging purposes: not appropriate for GUI use.

Supported API: false

Returns:

String

copy

public WfEventConfiguration copy()
                          throws WTException

Returns a copy of the event configuration.

Supported API: false

Returns:

WfEventConfiguration

Throws:

WTException

setExceptionAction

public void setExceptionAction(WfExceptionActionType action_type,
                               boolean act)

Supported API: false

Parameters:

action_type -

act -

isExceptionAction

public boolean isExceptionAction(WfExceptionActionType action_type)

Supported API: false

Parameters:

action_type -

Returns:

boolean

setOverdueAction

public void setOverdueAction(WfOverdueActionType action_type,
                             boolean act)

Supported API: false

Parameters:

action_type -

act -

isOverdueAction

public boolean isOverdueAction(WfOverdueActionType action_type)

Supported API: false

Parameters:

action_type -

Returns:

boolean

isOverdueAction

public boolean isOverdueAction()

Returns true if any of the overdue actions is set; false otherwise.

Supported API: false

Returns:

boolean

isAsynchronousExecution

public boolean isAsynchronousExecution()

Returns true if execution object doesn't terminate when the process in which it is embedded finishes; false otherwise.

Supported API: false

Returns:

boolean

setAsynchronousExecution

public void setAsynchronousExecution(boolean asynch)

Sets execution synchonicity to the value passed as argument.

Supported API: false

Parameters:

asynch -

isNotifyOnComplete

public boolean isNotifyOnComplete()

Returns true if notification is sent to responsible role when execution object completes; false otherwise.

Supported API: false

Returns:

boolean

setNotifyOnComplete

public void setNotifyOnComplete(boolean notify)

Sets completion notification attribute to the value passed as argument.

Supported API: false

Parameters:

notify -

isNotifyOnApproachingDeadline

public boolean isNotifyOnApproachingDeadline()

Returns true if notification is sent to responsible role when some pre-specified time before deadline is reached; false otherwise.

Supported API: false

Returns:

boolean

setNotifyOnApproachingDeadline

public void setNotifyOnApproachingDeadline(boolean notify)

Sets notification on approaching deadline attribute to the value passed as argument.

Supported API: false

Parameters:

notify -

isNotifyOnPastDeadline

public boolean isNotifyOnPastDeadline()

Returns true if notification is sent to responsible role when some pre-sepecified time after deadline is reached; false otherwise.

Supported API: false

Returns:

boolean

setNotifyOnPastDeadline

public void setNotifyOnPastDeadline(boolean notify)

Sets notification on past deadline attribute to the value passed as argument.

Supported API: false

Parameters:

notify -

isDedicatedQueue

public boolean isDedicatedQueue()

Returns true if the execution object has dedicated queues; false otherwise. This property is applicable only to processes.

Supported API: false

Returns:

boolean

setDedicatedQueue

public void setDedicatedQueue(boolean dedicated)

Sets dedicated queue attribute to the value passed as argument. This property is applicable only to processes. This is to say that setting dedicated queue true for an activity has no effect on whether or not dedicated queues will be used.

Supported API: false

Parameters:

dedicated -

isIgnoreUnresolvedRole

public boolean isIgnoreUnresolvedRole()

Returns true if the unresolved roles in assigned activities should be ignored (no workitem generated); false otherwise.

Supported API: false

Returns:

boolean

setIgnoreUnresolvedRole

public void setIgnoreUnresolvedRole(boolean ignore)

Sets the properties that controls whether unresolved roles in assigned activities should be ignored (no workitem generated). True means they should be ignore; false they shouldn't.

Supported API: false

Parameters:

ignore -

isStartComputed

public boolean isStartComputed()

Returns whether the time to start is entered (false) or computed (true). Default is entered (false). The time to start flag controls whether the object waits or not for the time to start to arrive or not.

Supported API: false

Returns:

boolean

setStartComputed

public void setStartComputed(boolean computed)

Sets whether the time to start is entered (false) or computed (true). The time to start flag controls whether the object waits or not for the time to start to arrive or not. Default is entered (false).

Supported API: false

Parameters:

computed -

longValue

public long longValue()

Returns permission mask.

Supported API: false

Returns:

long

isDomainBasedWorkflow

public boolean isDomainBasedWorkflow()

Returns whether the process instances will run in workflow folders of their PBO or process template - as opposed to the System domain.

Supported API: false

Returns:

boolean

setDomainBasedWorkflow

public void setDomainBasedWorkflow(boolean domFolders)

Sets whether the process instances will run in workflow folders of their PBO or process template - as opposed to the System domain.

Supported API: false

Parameters:

domFolders -

isCreateInstance

public boolean isCreateInstance()

Returns whether the execution instance is to be reused or a new one created when a node is visited. 'true' means that a new instance is create, while 'false' means that the instance is reused. Default is 'false'.

Supported API: false

Returns:

boolean

setCreateInstance

public void setCreateInstance(boolean create)

Set whether the execution instance is to be reused or a new one created when a node is visited. Default is 'false'.

Supported API: false

Parameters:

create -

isVotingRecorded

public boolean isVotingRecorded()

Supported API: false

Returns:

boolean

setVotingRecorded

public void setVotingRecorded(boolean record)

Supported API: false

Parameters:

record -

getRecord

private String getRecord(long b1,
                         long b2)

Returns "R" if there is a match between parameters; "" if not. Used by the toString method to obtain a condensed representation of the configuration.

getEmit

private String getEmit(long b1,
                       long b2)

Returns "E" if there is a match between parameters; "" if not. Used by the toString method to obtain a condensed representation of the configuration.