psdi.workflow

Class WFAssignment

java.lang.Object

psdi.mbo.Mbo

psdi.workflow.WFAssignment

All Implemented Interfaces:

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

public class WFAssignment
extends Mbo
implements WFAssignmentRemote

Mbo to represent WFAssignment object.

This is a system level object.

The key attributes for this object are AssignId, ProcessName, ProcessRev, WfId and NodeId.

The attributes in this object are as follows:

Attribute Name	Description
App	Name of the application to launch
AssignCode	Target of an active assignment. Set on activation, null in template.
AssignID	Used to uniquely identify an assignment.
AssignStatus	The status of the assignment: DEFAULT ACTIVE COMPLETE INACTIVE
Assign_01 - Assign_05	Extra Fields.
CalendarBased	Flag to indicate if the DueDate is calculated using straight time or calculated using the persons calendar.
Condition	Condition to check to enable this assignment.
ConditionClass	Name of Object to instanciate to enable conditional assignment.
Description	Displayed by inbox and applications to tell user what needs to be done
Description_LongDescription	Long Description for Displayed by inbox and applications to tell user what needs to be done
DisplayOne	Display a single complete assignment or simply complete it?
DueDate	The date that the assignment is due according to the escalation time limit.
EmailNotification	Should the assigned person get an email notification when the task becomes the current task of a process instance.
EscRole	Role to use when assignment is escalated.
HostName	URL of the MXServer. Used to create hotlinks in email messages.
IsCustomClass	Is a Custom Class used for the condition?
LangCode	Language Column
LastMemo	The last memo written on the workflow instance.
NodeID	The task node that this assignment is related to.
ObjectName	Type of Object the process, that owns this assignment, supports.
OrigPerson	The original person for the assignment before any delegation is applied
OwnerDescription	Descriptive text about MBO referenced by the assignment.
OwnerID	Unique key of the MAXIMO Object associated with this workflow.
OwnerTable	Table of the MAXIMO Object associated with this workflow.
Priority	Priority of this assignment
ProcessName	Name of the process that this assignment is related to.
ProcessRev	The Process revision number this assignment is related to.
RoleID	identifier which describes the target of this assignment.
StartDate	The DATETIME that the assignment became current. It is set to the current date/time on the server. This value is NULL for process definitions
TemplateID	Identifies the Communication Template to use to email assignees. If null, no email is sent.
TimeLimit	This is the time in hours that can pass before the task is escalated. Defaults from the task time limit but can be changed.
UserSql	User Entered Expression - used to link to the expression builder.
WFAssignmentID	Unique Identifier
WfId	The workflow identifier of the WFInstance that this assignment is related to.

Author:

Qiuping Mao, John Neville

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

Method Summary

Modifier and Type	Method and Description
void	activeAssignment(PersonRemote person, WFAssignmentSet activeSet)
void	add() Called when a new workflow assignment is created.
java.util.Date	calcDueDate(PersonRemote person, java.util.Date startDate) Calculate the due date.
void	cancel(java.lang.String memo) Change the assignment's status to cancel and write a transaction.
void	complete(java.lang.String memo) Change the assignment's status to complete and write a transaction.
void	escalate() Change the assignment's status to escalated and write a transaction.
void	escalate(java.lang.String memo) Do the "basic" escalation of this assignment.
boolean	evaluateAssignmentCondition() Evaluate the condition associated with the assignment.
boolean	foundPersonToAssignForRole() 12-13113/IV21649: indicates if the assignment(template) has found a person for its role.
void	generateAssignments() Generate active assignments for this template assignment.
void	generateForGroup(PersonGroupRemote group)
void	generateForPerson(PersonRemote person)
void	generateForRole(MaxRoleRemote role)
WFInstance	getInstance() Returns a reference to the instance that this assignment is a part of.
MboSetRemote	getMboSet(java.lang.String name) Overridden to support faux MboSet OWNER.
WFNodeRemote	getNode() Gets task node which owns the assignment.
PersonRemote	getOriginalPersonForAssignment()
WFTask	getTask() Get the task details of the node owner of the assignment.
WFInstanceRemote	getWFInstance() Returns a remote reference to the instance that this assignment is a part of.
void	inactivate() Change the assignment's status to inactive.
void	init() Mbo Initialization routine.
boolean	isActive() Is this assignment active?
void	sendNotification(PersonRemote person) Send notification of the new assignment.
void	wfValidate(java.util.Vector<MXException> errs) Validate the assignment record.

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

WFAssignment

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

Constructor

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Mbo Initialization routine. Always read-only fields have their READONLY flag set here.

Overrides:

init in class Mbo

Throws:

MXException

add

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

Called when a new workflow assignment is created. During design time, the set is ultimately owned by a WFProcess. Assignments created during run time are ultimately owned by a WFInstance.

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

complete

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

Change the assignment's status to complete and write a transaction.

Parameters:

memo - Assignment completion memo.

Throws:

java.rmi.RemoteException

MXException

inactivate

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

Change the assignment's status to inactive.

Throws:

java.rmi.RemoteException

MXException

cancel

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

Change the assignment's status to cancel and write a transaction.

Throws:

java.rmi.RemoteException

MXException

escalate

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

Change the assignment's status to escalated and write a transaction.

Throws:

MXException

java.rmi.RemoteException

calcDueDate

public java.util.Date calcDueDate(PersonRemote person,
                                  java.util.Date startDate)
                           throws java.rmi.RemoteException,
                                  MXException

Calculate the due date. If CALENDARBASED flag = true add timelimit to startdate based on the persons calendar to get the due date. If CALENDARBASED flag = false (or persons workperiods could not accomodate timelimit) add timelimit to startdate to get the due date.

Throws:

java.rmi.RemoteException

MXException

isActive

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

Is this assignment active?

Specified by:

isActive in interface WFAssignmentRemote

Returns:

Returns true if the assignment's status is "active". If the Mbo is marked for deletion, then false is always returned.

Throws:

java.rmi.RemoteException

MXException

See Also:

isActive()

wfValidate

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

Validate the assignment record. Checks the conditionals.

Parameters:

errs - The error list to add to.

Throws:

MXException

java.rmi.RemoteException

getTask

public WFTask getTask()
               throws java.rmi.RemoteException,
                      MXException

Get the task details of the node owner of the assignment.

Throws:

java.rmi.RemoteException

MXException

getWFInstance

public WFInstanceRemote getWFInstance()
                               throws MXException,
                                      java.rmi.RemoteException

Returns a remote reference to the instance that this assignment is a part of. Note that the instance will not be linked to the assignment.

Specified by:

getWFInstance in interface WFAssignmentRemote

Returns:

A remote reference to the instance

Throws:

MXException

java.rmi.RemoteException

See Also:

getWFInstance()

getInstance

public WFInstance getInstance()
                       throws MXException,
                              java.rmi.RemoteException

Returns a reference to the instance that this assignment is a part of. Note that the instance will not be linked to the assignment.

Returns:

A reference to the instance

Throws:

MXException

java.rmi.RemoteException

getNode

public WFNodeRemote getNode()
                     throws MXException,
                            java.rmi.RemoteException

Gets task node which owns the assignment.

Throws:

MXException

java.rmi.RemoteException

evaluateAssignmentCondition

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

Evaluate the condition associated with the assignment. This determines whether a template assignment generates active assignments. If there is no condition, true is returned.

Returns:

true if the template should generate active assignments.

Throws:

MXException

java.rmi.RemoteException

generateAssignments

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

Generate active assignments for this template assignment. Active assignments are added to the owning Task's activeAssignments set.

Throws:

java.rmi.RemoteException

MXException

See Also:

This is the owning Task's activeAssignments set.

sendNotification

public void sendNotification(PersonRemote person)
                      throws java.rmi.RemoteException,
                             MXException

Send notification of the new assignment.

Parameters:

person - The person assigned.

Throws:

java.rmi.RemoteException

MXException

escalate

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

Do the "basic" escalation of this assignment. Creates a new assignment template using the EscRole for the RoleID. That template assignment is used to generate assignments. The original assignment's status is changed to 'ESCALATED'.

Note that if you fetch an assignment, change it, and call escalate your changes will not be reflected in the assignment escalated because we need to fetch the assignment from the instance in order to generate assignments correctly.

Specified by:

escalate in interface WFAssignmentRemote

Parameters:

memo - Memo for the transaction.

Throws:

MXApplicationException - throw with "workflow", "NoEscalate" if there no role to escalate to.

MXException

java.rmi.RemoteException

See Also:

escalate(String)

getMboSet

public MboSetRemote getMboSet(java.lang.String name)
                       throws MXException,
                              java.rmi.RemoteException

Overridden to support faux MboSet OWNER.

Specified by:

getMboSet in interface MboRemote

Overrides:

getMboSet in class Mbo

Parameters:

name - The relationship provided to retrieve a related mboSet, usually using foreign keys. For example, "psdi.app.workorder.WOSetRemote.ASSET" is a relationship for the work order object to access the asset Set where "workorder.assetnum=asset.assetnum". The relationship can also be chained. Such as ASSET.ASSETSTATUS.

Returns:

The returned related set specified through the relationship.

Throws:

MXException - "A relationship called {0} does not exist for the {1} business object" exception will be thrown if the relationship was not found. "Unknown Object" exception will be thrown if the database object can not be found through the relationship.

java.rmi.RemoteException

See Also:

Mbo.getMboSet(String)

generateForRole

public void generateForRole(MaxRoleRemote role)
                     throws java.rmi.RemoteException,
                            MXException

Throws:

java.rmi.RemoteException

MXException

generateForGroup

public void generateForGroup(PersonGroupRemote group)
                      throws java.rmi.RemoteException,
                             MXException

Throws:

java.rmi.RemoteException

MXException

getOriginalPersonForAssignment

public PersonRemote getOriginalPersonForAssignment()

generateForPerson

public void generateForPerson(PersonRemote person)
                       throws java.rmi.RemoteException,
                              MXException

Throws:

java.rmi.RemoteException

MXException

activeAssignment

public void activeAssignment(PersonRemote person,
                             WFAssignmentSet activeSet)
                      throws java.rmi.RemoteException,
                             MXException

Throws:

java.rmi.RemoteException

MXException

foundPersonToAssignForRole

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

12-13113/IV21649: indicates if the assignment(template) has found a person for its role.

Returns:

Throws:

MXException

java.rmi.RemoteException