psdi.workflow

Class WFInstance

java.lang.Object

psdi.mbo.Mbo

psdi.workflow.WFInstance

All Implemented Interfaces:

java.rmi.Remote, MboConstants, MboRemote, MaxRemoteProxy, WFInstanceRemote

public class WFInstance
extends Mbo
implements WFInstanceRemote

Mbo to represent WFInstance object.

This is a system level object.

The key attribute for this object is WfId.

The attributes in this object are as follows:

Attribute Name	Description
Active	Is this the active instance for the record.
CurrTaskStartTime	The time the current task of the instance was initialized.
Originator	PersonID of the user that initiated workflow.
OwnerID	Unique key of the Mbo controlled by the instance.
OwnerTable	Name of Mbo controlled by the instance.
Revision	Revision of main process type.
StartTime	The time when workflow is started on a record.
WfId	Unique identifier of the workflow instance.

Field Summary

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

Fields inherited from interface psdi.mbo.MboConstants

ALLROWS, CHANGEDBY_USER, COUNT_ADDITIONS, COUNT_AFTERSAVE, COUNT_DATABASE, COUNT_DELETED, COUNT_EXISTING, DBCONFIG, DELAYVALIDATION, DELAYVALIDATIONONLY, DISCARDABLE, GOTCOMPLETEWHERE, HIDDEN, NO_RELATEDMBOS_OF_OWNERSCHILDREN_FETCH, NOACCESSCHECK, NOACTION, NOADD, NOCOMMIT, NODELETE, NONE, NOOVERWRITE, NOSAVE, NOSETVALUE, NOUPDATE, NOVALIDATION, NOVALIDATION_AND_NOACTION, NOVALIDATION_AND_NOACTION_ALLOWCROSSOVER, READONLY, REBUILD, REQUIRED, SAMEVALUEVALIDATION, SETBYPARENT, USER

Constructor Summary

Constructors

Constructor and Description
WFInstance(MboSet ms)

Method Summary

Modifier and Type	Method and Description
void	add() Sets Mbo defaults of a new WFInstance.
void	applyWorkflowAction(int actionID) Apply the workflow action choice.
void	applyWorkflowAction(int actionID, java.lang.String memo) Apply the workflow action choice.
boolean	atInteraction() Tells whether this workflow instance is at an interactive node.
boolean	atStoppingPoint() Return true if the instance is at a Stop, Wait, or Task.
boolean	canAutoCompleteInteraction() Called when at an interaction, returns true if the next node after the interaction is a stop, there's no action to perform on the way to the stop, and the stop will stop the process, i.e.
void	cancelWorkflowAssignment(WFAssignmentRemote assignment, java.lang.String actionMemo) Cancels the Workflow Assignment.
void	completeWorkflowAssignment(int assignment, int action, java.lang.String memo) Mark the workflow assignment complete and perform the action chosen.
void	completeWorkflowAssignment(java.lang.String assignment, int action, java.lang.String memo)
void	delete(long accessModifier) Delete the instance.
void	escalateAssignment(int assignID, java.lang.String memo) Escalate the assignment
void	escalateAssignment(java.lang.String assignID, java.lang.String memo)
WFActionSetRemote	getActions() Gets the set of WFActions for the instance.
MboRemote	getControlledMbo() Get a link to the controlled Mbo.
WFNode	getCurrentNode() Get the current node where the instance is in the process
WFInteractionRemote	getInteraction() Returns the detail information for the current WFInteraction node.
WFViewInfo	getWFDiagramInfo(int callSeq) Get the gif for the processes which make of this instance.
void	init() Make fields read-only.
void	initiateWorkflow(java.lang.String memo, WFProcess wfProcess) Gets the CallStackSet and calls initiateWorkflow on it.
void	interactionComplete() Called to tell the instance that the user is done with the interaction.
void	setControlledMbo(MboRemote mbo) Set the link to the controlled Mbo.
void	stopWorkflow(java.lang.String memo) Stops the workflow instance.
void	waitComplete() Called to tell the instance that one of the events it was waiting for occured.

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, canDelete, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, checkSiteOrgAccessForSave, clear, clearRelatedSets, clearRelatedSets, commit, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, deleteDoclinks, determineRequiredFieldsFromERM, duplicate, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, fireEvent, generateAutoKey, generateContentUID, getAlwaysFlags, getAttrRestrictionFlag, getAttrRestrictions, getBoolean, getByte, getBytes, getCheckpoint, getClientLocale, getClientTimeZone, getCommLogOwnerNameAndUniqueId, getCondition, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainFilterWhere, getDomainIDs, getDouble, getESId, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertOrgForSite, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboCtx, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSet, getMboSetInfo, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRecordType, getRelatedSets, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getTenantIdForNoMboRecordData, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAppLockEnabled, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isDuringInit, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNoSql, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, save, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDatabaseDefaultValues, setDatabaseDefaultValues, setDefaultValue, setDefaultValues, setDeleted, setDuringInit, setEAuditFieldModified, setESId, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMboCtx, setMLValue, setModified, setModifiedForIntegrationOnly, setNewMbo, setNoSql, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setRecordType, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, setTenantIdForNoMboRecordData, setUniqueIDValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromSequence, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, skipCopyField, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, throwRequiredException, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, undeleteDoclinks, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.mbo.MboRemote

addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, duplicate, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, generateAutoKey, getBoolean, getByte, getBytes, getCommLogOwnerNameAndUniqueId, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainIDs, getDouble, getExistingMboSet, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInt, getKeyValue, getLinesRelationship, getList, getLockedByDisplayName, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboInitialValue, getMboList, getMboSet, getMboSet, getMboSet, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getPropagateKeyFlag, getRecordIdentifer, getSiteOrg, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getThisMboSet, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, hasHierarchyLink, hasLockSaveRights, isAutoKeyed, isBasedOn, isFlagSet, isForDM, isLocked, isLocked, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isZombie, lock, propagateKeyValue, rollbackToCheckpoint, select, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDeleted, setESigFieldModified, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setIgnoreRecordLockCheck, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setReferencedMbo, setReferencedMbo, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

Constructor Detail

WFInstance

public WFInstance(MboSet ms)
           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Make fields read-only.

Overrides:

init in class Mbo

Throws:

MXException

add

public void add()
         throws MXException,
                java.rmi.RemoteException

Sets Mbo defaults of a new WFInstance. When created, the instance is owned by the Mbo it will control.

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

getControlledMbo

public MboRemote getControlledMbo()
                           throws MXException,
                                  java.rmi.RemoteException

Get a link to the controlled Mbo.

Specified by:

getControlledMbo in interface WFInstanceRemote

Returns:

The controlled Mbo.

Throws:

MXException

java.rmi.RemoteException

See Also:

WFInstance.getControlledMbo()

setControlledMbo

public void setControlledMbo(MboRemote mbo)
                      throws MXException,
                             java.rmi.RemoteException

Set the link to the controlled Mbo. Used when initiating or activating with the controlled Mbo in hand.

Specified by:

setControlledMbo in interface WFInstanceRemote

Parameters:

mbo - The controlled Mbo.

Throws:

MXException

java.rmi.RemoteException

See Also:

WFInstance.setControlledMbo(MboRemote)

initiateWorkflow

public void initiateWorkflow(java.lang.String memo,
                             WFProcess wfProcess)
                      throws java.rmi.RemoteException,
                             MXException

Gets the CallStackSet and calls initiateWorkflow on it. This initiates workflow on the controlled Mbo.

Parameters:

memo - Memo that goes with the workflow start.

wfProcess - link to process definition

Throws:

java.rmi.RemoteException

MXException

getActions

public WFActionSetRemote getActions()
                             throws java.rmi.RemoteException,
                                    MXException

Gets the set of WFActions for the instance. This gives the user the options of what to do next.

Specified by:

getActions in interface WFInstanceRemote

Returns:

the current set of WFActions for the WFInstance

Throws:

java.rmi.RemoteException

MXException

See Also:

WFInstance.getActions()

completeWorkflowAssignment

public void completeWorkflowAssignment(int assignment,
                                       int action,
                                       java.lang.String memo)
                                throws java.rmi.RemoteException,
                                       MXException

Mark the workflow assignment complete and perform the action chosen.

Specified by:

completeWorkflowAssignment in interface WFInstanceRemote

Parameters:

assignment - The assignment that is now complete.

action - The action to take now that the assignment is complete.

memo - Memo about completing the assignment.

Throws:

java.rmi.RemoteException

MXException

See Also:

WFInstance.completeWorkflowAssignment(int,int,String)

completeWorkflowAssignment

public void completeWorkflowAssignment(java.lang.String assignment,
                                       int action,
                                       java.lang.String memo)
                                throws java.rmi.RemoteException,
                                       MXException

Specified by:

completeWorkflowAssignment in interface WFInstanceRemote

Throws:

java.rmi.RemoteException

MXException

See Also:

WFInstance.completeWorkflowAssignment(String,int,String)

applyWorkflowAction

public void applyWorkflowAction(int actionID)
                         throws java.rmi.RemoteException,
                                MXException

Apply the workflow action choice.

Specified by:

applyWorkflowAction in interface WFInstanceRemote

Parameters:

action - The action chosen.

Throws:

MXApplicationException - Throw with "workflow", "NotAvailableAction" if the action chosen is conditional and the condition evaluates to false.

java.rmi.RemoteException

MXException

See Also:

The actionID parameter is passed to this method will an emtpy memo.

applyWorkflowAction

public void applyWorkflowAction(int actionID,
                                java.lang.String memo)
                         throws java.rmi.RemoteException,
                                MXException

Apply the workflow action choice.

Specified by:

applyWorkflowAction in interface WFInstanceRemote

Parameters:

action - The action chosen.

memo - Memo for the action.

Throws:

MXApplicationException - Throw with "workflow", "NotAvailableAction" if the action chosen is conditional and the condition evaluates to false.

java.rmi.RemoteException

MXException

See Also:

WFInstance.applyWorkflowAction(int, String)

getWFDiagramInfo

public WFViewInfo getWFDiagramInfo(int callSeq)
                            throws java.rmi.RemoteException,
                                   MXException

Get the gif for the processes which make of this instance.

Specified by:

getWFDiagramInfo in interface WFInstanceRemote

Throws:

java.rmi.RemoteException

MXException

See Also:

WFInstance.getWFDiagramInfo(int)

cancelWorkflowAssignment

public void cancelWorkflowAssignment(WFAssignmentRemote assignment,
                                     java.lang.String actionMemo)
                              throws java.rmi.RemoteException,
                                     MXException

Cancels the Workflow Assignment. Writes a cancel transaction and the transaction is removed from the active list.

Specified by:

cancelWorkflowAssignment in interface WFInstanceRemote

Parameters:

assignment - The assignment

actionMemo - Memo about this assignment change.

Throws:

java.rmi.RemoteException

MXException

See Also:

WFInstance.cancelWorkflowAssignment(WFAssignmentRemote,String)

stopWorkflow

public void stopWorkflow(java.lang.String memo)
                  throws java.rmi.RemoteException,
                         MXException

Stops the workflow instance. Optionally notifies open and/or completed labor assignees.

Specified by:

stopWorkflow in interface WFInstanceRemote

Parameters:

memo - Memo for the WFTransaction of the stop.

Throws:

java.rmi.RemoteException

MXException

See Also:

WFInstance.stopWorkflow(String)

getCurrentNode

public WFNode getCurrentNode()
                      throws java.rmi.RemoteException,
                             MXException

Get the current node where the instance is in the process

Throws:

java.rmi.RemoteException

MXException

interactionComplete

public void interactionComplete()
                         throws java.rmi.RemoteException,
                                MXException

Called to tell the instance that the user is done with the interaction.

Specified by:

interactionComplete in interface WFInstanceRemote

Throws:

java.rmi.RemoteException

MXException

See Also:

WFInstance.interactionComplete()

waitComplete

public void waitComplete()
                  throws java.rmi.RemoteException,
                         MXException

Called to tell the instance that one of the events it was waiting for occured.

Specified by:

waitComplete in interface WFInstanceRemote

Throws:

java.rmi.RemoteException

MXException

See Also:

WFInstance.waitComplete()

atInteraction

public boolean atInteraction()
                      throws java.rmi.RemoteException,
                             MXException

Tells whether this workflow instance is at an interactive node.

Specified by:

atInteraction in interface WFInstanceRemote

Returns:

true if at a WFInteraction node.

Throws:

java.rmi.RemoteException

MXException

See Also:

WFInstance.atInteraction()

getInteraction

public WFInteractionRemote getInteraction()
                                   throws java.rmi.RemoteException,
                                          MXException

Returns the detail information for the current WFInteraction node. Used by the workflow director to setup the UI

Specified by:

getInteraction in interface WFInstanceRemote

Returns:

The node details, assuming the current node is an interaction.

Throws:

java.rmi.RemoteException

MXException

See Also:

WFInstance.getInteraction()

escalateAssignment

public void escalateAssignment(int assignID,
                               java.lang.String memo)
                        throws java.rmi.RemoteException,
                               MXException

Escalate the assignment

Specified by:

escalateAssignment in interface WFInstanceRemote

Parameters:

assignID - Assignment identifier.

memo - Memo for the transaction

Throws:

java.rmi.RemoteException

MXException

See Also:

WFInstance.escalateAssignment(int,String)

escalateAssignment

public void escalateAssignment(java.lang.String assignID,
                               java.lang.String memo)
                        throws java.rmi.RemoteException,
                               MXException

Specified by:

escalateAssignment in interface WFInstanceRemote

Throws:

java.rmi.RemoteException

MXException

See Also:

WFInstance.escalateAssignment(String,String)

atStoppingPoint

public boolean atStoppingPoint()
                        throws java.rmi.RemoteException,
                               MXException

Return true if the instance is at a Stop, Wait, or Task. The instance and controlled get linked and should be saved.

Specified by:

atStoppingPoint in interface WFInstanceRemote

Throws:

java.rmi.RemoteException

MXException

See Also:

WFInstance.atStoppingPoint()

canAutoCompleteInteraction

public boolean canAutoCompleteInteraction()
                                   throws java.rmi.RemoteException,
                                          MXException

Called when at an interaction, returns true if the next node after the interaction is a stop, there's no action to perform on the way to the stop, and the stop will stop the process, i.e. we're not in a subprocess that will continue.

Specified by:

canAutoCompleteInteraction in interface WFInstanceRemote

Returns:

true if process stop after interaction.

Throws:

java.rmi.RemoteException

MXException

See Also:

WFInstance.canAutoCompleteInteraction()

delete

public void delete(long accessModifier)
            throws MXException,
                   java.rmi.RemoteException

Delete the instance.

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

accessModifier - The bitwise flag specified to determine if certain normal security checks are to be bypassed for this delete request. For example: if the accessModifer is NOACCESSCHECK, then the check for the object's NODELETE flag and the call to the object's canDelete() method will not be performed. If the accessModifer is NONE, then all the access checks are performed before this object is marked delete.

Throws:

MXException

java.rmi.RemoteException

See Also:

deletion checks