psdi.workflow

Class WFTask

java.lang.Object

psdi.mbo.Mbo

psdi.workflow.WFNodeDetail

psdi.workflow.WFTask

All Implemented Interfaces:

java.rmi.Remote, MboConstants, MboRemote, MaxRemoteProxy, WFNodeDetailRemote, WFTaskRemote

public class WFTask
extends WFNodeDetail
implements WFTaskRemote

Mbo to represent Workflow Tasks. Tasks are things in the workflow process which need to be done something outside of workflow, i.e. an auditor may need to approve the financial data on a work order. In an enabled process, a task must have at least assignment defined to say who must do the task.

In this Mbo, there are two non-overlapping mbosets of assignments obtained by relationship "activeassignments" and "defaultassignments". Any updating operation on the assignments of this task have to be operated on these two mbosets.

This is a system level object.

The key attributes for this object are NodeId, ProcessName and ProcessRev. These attributes are shared by all WFNodeDetail Mbo subclasses.

This mboset has four additional attributes, unique to this type of NodeDetail: ReadOnly, FirstComplete, App, & TimeLimit.

The attributes in this object are as follows:

Attribute Name	Description
App	Default application to launch for this task.
FirstComplete	Will the first person to complete an assignment complete the task? If N then all of the assignments must be complete before a new current task is calculated.
NodeId	The WFTASK type Node that this task is related to.
ProcessName	The Process that this node is related to.
ProcessRev	Process revision.
ReadOnly	Should the application associated with this task be read only for all users other than those assigned to the task?
TimeLimit	Time in hours that can pass before the task is escalated.

Author:

Qiuping Mao

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
WFTask(MboSet ms) Constructor

Method Summary

Modifier and Type	Method and Description
void	add() Called when a new workflow task node is created.
void	addedAction(boolean wasPositive) Task, Condition, and Subprocess nodes can only originate one action of each type, so this method clears the owning node's Take* flag corresponding to the parameter.
boolean	canTakeNegative() Determines whether this node can take a negative action.
boolean	canTakePositive() Determines whether this node can take a positive action.
boolean	completeAssignment(WFAssignment assignment, WFActionRemote action, java.lang.String memo) Completes the assignment selected and evaluates whether the process should continue now.
void	delete(long modifier) When a task is deleted, delete the assignments
void	initializeTask() Creates active assignments from the template assignments defined for this task node.
void	removedAction(boolean wasPositive) Task, Condition, and Subprocess nodes can only originate one action of each type, so when they lose one, they can take another.
void	stopAssignment() Stops all assignments.
void	wfValidate(java.util.Vector<MXException> errs, java.util.Hashtable<java.lang.String,java.lang.String> hinfo) Validate the task node specifics.

Methods inherited from class psdi.workflow.WFNodeDetail

getNode, getWFCallStack, getWFInstance, init

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, canDelete, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, 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, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, 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, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDefaultValue, setDefaultValues, setDeleted, 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, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, 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, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

equals, 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, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

Constructor Detail

WFTask

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

Constructor

Throws:

java.rmi.RemoteException

Method Detail

add

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

Called when a new workflow task node is created.

Specified by:

add in interface MboRemote

Overrides:

add in class WFNodeDetail

Throws:

MXException

java.rmi.RemoteException

completeAssignment

public boolean completeAssignment(WFAssignment assignment,
                                  WFActionRemote action,
                                  java.lang.String memo)
                           throws java.rmi.RemoteException,
                                  MXException

Completes the assignment selected and evaluates whether the process should continue now. If the FirstComplete flag is set or a negative action taken, this node is done. The node is also done if there are no more active assignments.

Parameters:

assignment - The assignment to complete (from the instance's ActiveAssignments set.)

action - The action to take.

memo - Assignment completion memo.

Returns:

Is this node done?

Throws:

java.rmi.RemoteException

MXException

stopAssignment

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

Stops all assignments.

Throws:

java.rmi.RemoteException

MXException

initializeTask

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

Creates active assignments from the template assignments defined for this task node. This method sets the CurrTaskStartTime attribute to the current Date/Time.

Throws:

java.rmi.RemoteException

MXException

See Also:

New assignments are created in this set., New assignment groups are created in this set.

wfValidate

public void wfValidate(java.util.Vector<MXException> errs,
                       java.util.Hashtable<java.lang.String,java.lang.String> hinfo)
                throws MXException,
                       java.rmi.RemoteException

Validate the task node specifics.

Specified by:

wfValidate in class WFNodeDetail

Parameters:

errs - A vector of MXExceptions where there are problems in the process. Any errors found will be added to this list.

hinfo - A hashtable of information that is passed throughout the validation process

Throws:

MXException

java.rmi.RemoteException

canTakePositive

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

Determines whether this node can take a positive action. Task nodes may have one positive action.

Specified by:

canTakePositive in class WFNodeDetail

Returns:

Returns true if this node has no positive actions already.

Throws:

MXException

java.rmi.RemoteException

canTakeNegative

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

Determines whether this node can take a negative action. Task nodes may have one negative action.

Specified by:

canTakeNegative in class WFNodeDetail

Returns:

Returns false.

Throws:

MXException

java.rmi.RemoteException

addedAction

public void addedAction(boolean wasPositive)
                 throws MXException,
                        java.rmi.RemoteException

Task, Condition, and Subprocess nodes can only originate one action of each type, so this method clears the owning node's Take* flag corresponding to the parameter.

Specified by:

addedAction in class WFNodeDetail

Parameters:

wasPositive - Was a positive action added?

Throws:

MXException

java.rmi.RemoteException

removedAction

public void removedAction(boolean wasPositive)
                   throws MXException,
                          java.rmi.RemoteException

Task, Condition, and Subprocess nodes can only originate one action of each type, so when they lose one, they can take another. This method sets the owning node's Take* flag corresponding to the parameter.

Specified by:

removedAction in class WFNodeDetail

Parameters:

wasPositive - Was a positive action added?

Throws:

MXException

java.rmi.RemoteException

delete

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

When a task is deleted, delete the assignments

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

modifier - 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:

Mbo.delete(long)