psdi.workflow

Class WFInteraction

java.lang.Object

psdi.mbo.Mbo

psdi.workflow.WFNodeDetail

psdi.workflow.WFInteraction

All Implemented Interfaces:

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

public class WFInteraction
extends WFNodeDetail
implements WFInteractionRemote

WFInteraction nodes allow the process to bring up a certain application page and tell the user what to do.

This is a system level object.

The key attribute for this object is WFInteractionID.

The attributes in this object are as follows:

Attribute Name	Description
Action	Application action to perform
App	Application to bring up.
Directions	Title of directions for the user from the workflow process.
Directions_LongDescription	Directions for the user from the workflow process.
NodeID	Identifies the node this is the details for.
Page	Page within the application to display
ProcessName	Name of the owning process.
ProcessRev	Process Revision
Relation	Which related record to bring up in the application
WFInteractionID	Unique Id

Attributes App, Page, and Relation tell the process where to bring the user and what record to show. Attributes Action tell the process which action page to bring up. The Direction attributes are used to inform the user what to do at that point. 'Directions' is used for the title of the message box while the contents of the longdescription field are put inside the message box.

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

Method Summary

Modifier and Type	Method and Description
void	addedAction(boolean wasPositive) An Interaction node can only originate one action, so this method clears the owning node's TakePositive flag.
boolean	canTakeNegative() Interaction nodes can't have a reject action.
boolean	canTakePositive() Determines whether this node can take a positive action.
MboRemote	getRelatedMbo() During run-time, get the Mbo specified by the Relation attribute of this Interaction node.
void	removedAction(boolean wasPositive) An Interaction node can only originate one action, so if it loses it, this method sets the owning node's TakePositive flag.
void	wfValidate(java.util.Vector errs, java.util.Hashtable hinfo) Interaction node validation.

Methods inherited from class psdi.workflow.WFNodeDetail

add, getNode, getWFCallStack, getWFInstance, init, skipCopyField

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

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

WFInteraction

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

Constructor

Parameters:

ms -

Throws:

java.rmi.RemoteException

Method Detail

canTakePositive

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

Determines whether this node can take a positive action. Interaction 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

Interaction nodes can't have a reject action.

Specified by:

canTakeNegative in class WFNodeDetail

Returns:

false

Throws:

MXException

java.rmi.RemoteException

addedAction

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

An Interaction node can only originate one action, so this method clears the owning node's TakePositive flag.

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

An Interaction node can only originate one action, so if it loses it, this method sets the owning node's TakePositive flag.

Specified by:

removedAction in class WFNodeDetail

Parameters:

wasPositive - Was a positive action added?

Throws:

MXException

java.rmi.RemoteException

wfValidate

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

Interaction node validation. Interactions can only have a single exiting action. Interaction Nodes can't have a Relation and an Action. Interaction Nodes must either do somthing, like a relation, action, tab change, etc.., or have directions.

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

getRelatedMbo

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

During run-time, get the Mbo specified by the Relation attribute of this Interaction node. Only the first Mbo of each related set is used, making the results of this method shaky if sets with multiple members are used.

Specified by:

getRelatedMbo in interface WFInteractionRemote

Returns:

The related Mbo fetched for the controlled Mbo using the Relation attribute. This will be the currently controlled Mbo if the Relation attribute is null. Returns null if unable to get a related Mbo.

Throws:

MXException

java.rmi.RemoteException

See Also:

WFInteraction.getRelatedMbo()