public class WFProcess extends Mbo implements WFProcessRemote
This is a system level object.
The key attributes for this object are ProcessName and ProcessRev.
The attributes in this object are as follows:
Attribute Name | Description |
---|---|
Active | Can this process be initiated? |
ChangeBy | The user that last changed the wfprocess row. Read only. |
ChangeDate | The date the wfprocess row was changed. Read only. |
Description | Description of the process. |
Enabled | Is the process is available to be used? |
LdKey | Long description key for the DESCRIPTION field |
ObjectName | Name of type of Mbo controlled by the process. |
Migrated | Was this template created during the 4.1.1 upgrade? |
ProcessName | Name of the process. |
ProcessRev | Revision of the process. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
AUTOINITACTIVE
Bulletin Board signal to AutoInit.
|
MULTILANGCOPY, phantomList, phantomQueue
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
Modifier and Type | Method and Description |
---|---|
void |
add()
Called when a new workflow process is created.
|
void |
addNodePointedTo(Mbo pointedToNode)
A node wants it's pointed to list.
|
void |
appValidate()
Called before a process is saved.
|
void |
buildSubProcessList(java.util.Hashtable<java.lang.String,java.lang.String> h)
Builds a list of processes which are members of this process by recursively
searching for subprocesses.
|
void |
canDelete()
A process that's Active or Enabled may not be deleted.
|
void |
clearAutoInitiate()
Clear the AUTOINITIATE flag on this process
|
java.lang.String |
createPointedToList(int nodeID)
Creates a list of nodes that point to the node.
|
MboRemote |
createRevision()
Creates a new revision of the process.
|
void |
deactivateProcess()
Deactivate this activate process.
|
void |
delete(long modifier)
The nodes, node detail, and action Mbo which make up a process are
deleted with the process.
|
void |
disableProcess()
Clears the enable flag on a process.
|
MboRemote |
duplicate()
Duplicate a process and all it's subrecords.
|
boolean |
enableProcess()
Validates the process and sets the Enabled flag if valid.
|
java.util.List<WFAction> |
findIncomingActions(int nodeID)
Returns the set of actions that point to the node with the ID given.
|
WFNode |
findNode(int nodeID)
Finds a node in the process, given a NodeID.
|
int |
getNextActionNum()
Determines the number for the next Action's ActionID.
|
java.awt.Point |
getNextNodePoint()
Get where to put the next node.
|
MboRemote |
getNodeAt(int x,
int y)
Determine if there is an undelete node at the position.
|
java.lang.String[] |
getValidateOrder()
Validation Order for WFProcess attributes.
|
boolean |
hasNegativeStop()
Does this process have a negative stop?
|
boolean |
hasPositiveStop()
Does this process have a positive stop?
|
void |
init()
Mbo Initialization routine.
|
WFInstanceRemote |
initiateWorkflow(MboRemote targetMbo,
java.lang.String memo)
Initiate this process on the target Mbo.
|
void |
initRelationship(java.lang.String relationName,
MboSetRemote mboSet)
Called whenever a relationship is initialized or reset from this Mbo to another MboSet.
|
void |
makeAutoInitiate()
Make this process the default for auto initiate on MBOs of its type.
|
void |
makeProcessActive()
Make this process active.
|
boolean |
needAppSupport()
Do we need to add initial workflow support to applications for this process' MBO type?
|
int |
nextNoteUID()
Get the next value to use for WFNotification's UniqueID.
|
void |
resynchronize()
Creates another set of revision records allowing the process to pickup newer revisions of
any subprocesses.
|
void |
setDeletableFlag(boolean flag)
Set the deletable flag to the value given.
|
void |
setNextActionNum(int actionID)
Make sure the next actionID returned is greater than this value.
|
void |
updatePointedTo(java.lang.Integer wasMemberNodeID,
java.lang.Integer nowMemberNodeID) |
boolean |
validateProcess()
Validates the process.
|
java.util.Vector |
validateWorkflow()
Validates a work flow process.
|
java.util.Vector<MXException> |
validateWorkflow(java.util.Hashtable<java.lang.String,java.lang.String> hinfo)
Validates a work flow process.
|
addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, determineRequiredFieldsFromERM, 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, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, 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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, 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
public static final java.lang.String AUTOINITACTIVE
public WFProcess(MboSet ms) throws java.rmi.RemoteException
java.rmi.RemoteException
public void init() throws MXException
init
in class Mbo
MXException
public void initRelationship(java.lang.String relationName, MboSetRemote mboSet) throws MXException, java.rmi.RemoteException
initRelationship
in class Mbo
relationName
- The relationship name of the related MboSet which need to initialize.mboSet
- The related MboSet which need to initialize.MXException
java.rmi.RemoteException
public void add() throws MXException, java.rmi.RemoteException
add
in interface MboRemote
add
in class Mbo
MXException
java.rmi.RemoteException
public void appValidate() throws MXException, java.rmi.RemoteException
appValidate
in class Mbo
MXException
java.rmi.RemoteException
public java.util.List<WFAction> findIncomingActions(int nodeID) throws java.rmi.RemoteException, MXException
nodeID
- The ID of the nodeMXException
java.rmi.RemoteException
public int getNextActionNum() throws MXException, java.rmi.RemoteException
MXException
java.rmi.RemoteException
public void setNextActionNum(int actionID)
actionID
- The last action ID copied from the original process.public WFNode findNode(int nodeID) throws MXException, java.rmi.RemoteException
nodeID
- The ID of the Node to find.MXApplicationException
- Thrown with "workflow", "NotValidNode" if the NodeID isn't
found in the process.MXException
java.rmi.RemoteException
public java.util.Vector validateWorkflow() throws MXException, java.rmi.RemoteException
MXException
java.rmi.RemoteException
public java.util.Vector<MXException> validateWorkflow(java.util.Hashtable<java.lang.String,java.lang.String> hinfo) throws MXException, java.rmi.RemoteException
hinfo
- A hashtable of information that is passed throughout the validation processMXException
java.rmi.RemoteException
public void buildSubProcessList(java.util.Hashtable<java.lang.String,java.lang.String> h) throws java.rmi.RemoteException, MXException
h
- The list to add new processes to. ProcessName is the key and ProcessRev is
the value.java.rmi.RemoteException
MXException
This is called to recurse on the nodes
of this process.
public boolean hasPositiveStop() throws java.rmi.RemoteException, MXException
java.rmi.RemoteException
MXException
public boolean hasNegativeStop() throws java.rmi.RemoteException, MXException
java.rmi.RemoteException
MXException
public void canDelete() throws MXException, java.rmi.RemoteException
canDelete
in class Mbo
MXException
java.rmi.RemoteException
public void delete(long modifier) throws MXException, java.rmi.RemoteException
delete
in interface MboRemote
delete
in class Mbo
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.MXException
java.rmi.RemoteException
Mbo.delete(long)
public boolean enableProcess() throws MXException, java.rmi.RemoteException
enableProcess
in interface WFProcessRemote
MXApplicationException
- Thrown with "workflow", "UnsavedNoChange"
if the process has unsaved changes.MXException
java.rmi.RemoteException
To get the error information.
public void makeProcessActive() throws MXException, java.rmi.RemoteException
makeProcessActive
in interface WFProcessRemote
MXApplicationException
- Thrown with "workflow", "UnsavedNoChange"
if the process has unsaved changes.MXApplicationException
- Thrown with "workflow", "CannotActivate"
if the process is not enabled.MXApplicationException
- Thrown with "workflow" and either "SubProcNeedsPosOut"
or "SubProcNeedsNegOut" and parameters of the node's title, the name and revision
of the process containing the subprocess node.MXException
java.rmi.RemoteException
makeProcessActive()
public WFInstanceRemote initiateWorkflow(MboRemote targetMbo, java.lang.String memo) throws java.rmi.RemoteException, MXApplicationException, MXException
targetMbo
- The Mbo to start workflow on.memo
- Memo that goes with workflow start.MXApplicationException
- Thrown with "workflow", "ProcessInactive" + the process name
if the process is not active.MXApplicationException
- Thrown with "workflow", "WrongTarget" + the process name
+ the process's target + target Mbo's type, if the process target doesn't match the target Mbo's
type.java.rmi.RemoteException
MXException
public boolean validateProcess() throws MXException, java.rmi.RemoteException
validateProcess
in interface WFProcessRemote
MXException
java.rmi.RemoteException
To get the error information.
public void deactivateProcess() throws MXException, java.rmi.RemoteException
deactivateProcess
in interface WFProcessRemote
MXException
java.rmi.RemoteException
deactivateProcess()
public MboRemote createRevision() throws MXException, java.rmi.RemoteException
createRevision
in interface WFProcessRemote
MXException
java.rmi.RemoteException
createRevision()
public void disableProcess() throws MXException, java.rmi.RemoteException
disableProcess
in interface WFProcessRemote
MXException
java.rmi.RemoteException
disableProcess()
public MboRemote duplicate() throws MXException, java.rmi.RemoteException
duplicate
in interface MboRemote
duplicate
in class Mbo
MXException
java.rmi.RemoteException
public void resynchronize() throws MXException, java.rmi.RemoteException
resynchronize
in interface WFProcessRemote
MXException
java.rmi.RemoteException
resynchronize()
public java.lang.String[] getValidateOrder()
getValidateOrder
in class Mbo
public boolean needAppSupport() throws java.rmi.RemoteException, MXException
needAppSupport
in interface WFProcessRemote
java.rmi.RemoteException
MXException
needAppSupport()
public void makeAutoInitiate() throws java.rmi.RemoteException, MXException
makeAutoInitiate
in interface WFProcessRemote
java.rmi.RemoteException
MXException
makeAutoInitiate()
public void clearAutoInitiate() throws java.rmi.RemoteException, MXException
clearAutoInitiate
in interface WFProcessRemote
java.rmi.RemoteException
MXException
clearAutoInitiate()
public int nextNoteUID() throws java.rmi.RemoteException, MXException
java.rmi.RemoteException
MXException
public void updatePointedTo(java.lang.Integer wasMemberNodeID, java.lang.Integer nowMemberNodeID) throws java.rmi.RemoteException, MXException
java.rmi.RemoteException
MXException
public void addNodePointedTo(Mbo pointedToNode) throws java.rmi.RemoteException, MXException
pointedToNode
- The nodejava.rmi.RemoteException
MXException
public java.lang.String createPointedToList(int nodeID) throws java.rmi.RemoteException, MXException
nodeID
- The node to create the list forMXException
java.rmi.RemoteException
public java.awt.Point getNextNodePoint() throws java.rmi.RemoteException, MXException
java.rmi.RemoteException
MXException
public MboRemote getNodeAt(int x, int y) throws java.rmi.RemoteException, MXException
x
- y
- java.rmi.RemoteException
MXException
public void setDeletableFlag(boolean flag) throws java.rmi.RemoteException, MXException
setDeletableFlag
in interface WFProcessRemote
java.rmi.RemoteException
MXException
clearAutoInitiate()