Package org.compiere.wf
Class MWFProcess
java.lang.Object
org.compiere.model.PO
org.compiere.model.X_AD_WF_Process
org.compiere.wf.MWFProcess
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparator<Object>
,I_AD_WF_Process
,I_Persistent
,Evaluatee
Extended Workflow Process model for AD_WF_Process
- Version:
- $Id: MWFProcess.java,v 1.2 2006/07/30 00:51:05 jjanke Exp $
- Author:
- Jorg Janke, Silvano Trinchero, www.freepath.it
- IDEMPIERE-3209 changed fucntions to public to improve integration support
- See Also:
-
Field Summary
Fields inherited from class org.compiere.model.X_AD_WF_Process
WFSTATE_Aborted, WFSTATE_AD_Reference_ID, WFSTATE_Completed, WFSTATE_NotStarted, WFSTATE_Running, WFSTATE_Suspended, WFSTATE_Terminated
Fields inherited from class org.compiere.model.PO
ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, LOCAL_TRX_PREFIX, log, p_ctx, p_info, UUID_NEW_RECORD, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID
Fields inherited from interface org.compiere.model.I_AD_WF_Process
accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Message_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_Table_ID, COLUMNNAME_AD_User_ID, COLUMNNAME_AD_WF_Process_ID, COLUMNNAME_AD_WF_Process_UU, COLUMNNAME_AD_WF_Responsible_ID, COLUMNNAME_AD_Workflow_ID, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_IsActive, COLUMNNAME_Priority, COLUMNNAME_Processed, COLUMNNAME_Processing, COLUMNNAME_Record_ID, COLUMNNAME_TextMsg, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, COLUMNNAME_WFState, Model, Table_ID, Table_Name
-
Constructor Summary
ConstructorDescriptionMWFProcess
(Properties ctx, int AD_WF_Process_ID, String trxName) Standard ConstructorMWFProcess
(Properties ctx, String AD_WF_Process_UU, String trxName) UUID based ConstructorMWFProcess
(Properties ctx, ResultSet rs, String trxName) Load ConstructorMWFProcess
(MWorkflow wf, ProcessInfo pi) Deprecated.MWFProcess
(MWorkflow wf, ProcessInfo pi, String trxName) New Constructor -
Method Summary
Modifier and TypeMethodDescriptionvoid
addTextMsg
(Object obj) Add to Text Msgvoid
checkActivities
(String trxName, PO lastPO) Check Status of Activities.
- start new activityvoid
checkCloseActivities
(String trxName) Update process status based on status of activities.checkIsComplete
(String trxName) Check if activity is already completeString[]
Get Action OptionsgetActivities
(boolean requery, boolean onlyActive) Get active Activities of ProcessgetActivities
(boolean requery, boolean onlyActive, String trxName) Get active Activities of ProcessgetPO()
Get Persistent ObjectGet process infoGet Process Execution (Error) MessagegetState()
Get StateGet Workflowboolean
Perform Actionvoid
Set Workflow Responsible.void
setProcessMsg
(String msg) Set Process Execution (Error) Messagevoid
setTextMsg
(String TextMsg) Set Text Msg (add to existing)void
setTextMsg
(PO po) Set Text Msg (add to existing)void
setWFState
(String WFState) Set Process State and update Actionsboolean
Start WF ExecutionMethods inherited from class org.compiere.model.X_AD_WF_Process
get_AccessLevel, getAD_Message, getAD_Message_ID, getAD_Table, getAD_Table_ID, getAD_User, getAD_User_ID, getAD_WF_Process_ID, getAD_WF_Process_UU, getAD_WF_Responsible, getAD_WF_Responsible_ID, getAD_Workflow, getAD_Workflow_ID, getKeyNamePair, getPriority, getRecord_ID, getTextMsg, getWFState, initPO, isProcessed, isProcessing, setAD_Message_ID, setAD_Table_ID, setAD_User_ID, setAD_WF_Process_ID, setAD_WF_Process_UU, setAD_WF_Responsible_ID, setAD_Workflow_ID, setPriority, setProcessed, setProcessing, setRecord_ID, toString
Methods inherited from class org.compiere.model.PO
afterDelete, afterSave, beforeDelete, beforeSave, buildInsertSQL, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, dump, dump, equals, get_Attribute, get_Attributes, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_HashMap, get_ID, get_IDOld, get_KeyColumns, get_Logger, get_OptimisticLockingColumns, get_Table_ID, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_UUID, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_Immutable, is_new, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadPO, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveCrossTenantSafe, saveCrossTenantSafeEx, saveCrossTenantSafeEx, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_OptimisticLockingColumns, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, toInsertSQL, unlock, update_Tree, validForeignKeys
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Comparator
reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
Methods inherited from interface org.compiere.model.I_AD_WF_Process
getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive
Methods inherited from interface org.compiere.model.I_Persistent
save
-
Constructor Details
-
MWFProcess
UUID based Constructor- Parameters:
ctx
- ContextAD_WF_Process_UU
- UUID keytrxName
- Transaction
-
MWFProcess
Standard Constructor- Parameters:
ctx
- contextAD_WF_Process_ID
- processtrxName
- transaction
-
MWFProcess
Load Constructor- Parameters:
ctx
- contextrs
- result settrxName
- transaction
-
MWFProcess
Deprecated.New Constructor- Parameters:
wf
- workflowpi
- Process Info (Record_ID)- Throws:
Exception
-
MWFProcess
New Constructor- Parameters:
wf
- workflowpi
- Process Info (Record_ID)trxName
-- Throws:
Exception
-
-
Method Details
-
getActivities
Get active Activities of Process- Parameters:
requery
- true to reload from DBonlyActive
- only active activities- Returns:
- array of activities
-
getActivities
Get active Activities of Process- Parameters:
requery
- true to reload from DBonlyActive
- only active activities- Returns:
- array of activities
-
getState
Get State- Returns:
- state
-
getActionOptions
Get Action Options- Returns:
- array of valid actions
-
setWFState
Set Process State and update Actions- Specified by:
setWFState
in interfaceI_AD_WF_Process
- Overrides:
setWFState
in classX_AD_WF_Process
- Parameters:
WFState
-
-
checkActivities
Check Status of Activities.
- start new activity- Parameters:
trxName
- transactionlastPO
- PO
-
checkIsComplete
Check if activity is already complete- Parameters:
trxName
-- Returns:
-
checkCloseActivities
Update process status based on status of activities.- Parameters:
trxName
- transaction
-
setAD_WF_Responsible_ID
public void setAD_WF_Responsible_ID()Set Workflow Responsible. Searches for a Invoker. -
getWorkflow
Get Workflow- Returns:
- workflow
-
perform
Perform Action- Parameters:
action
- StateEngine.ACTION_*- Returns:
- true if valid
-
startWork
public boolean startWork()Start WF Execution- Returns:
- true if success
-
getPO
Get Persistent Object- Returns:
- po
-
getProcessInfo
Get process info- Returns:
ProcessInfo
-
setTextMsg
Set Text Msg (add to existing)- Parameters:
po
- base object
-
setTextMsg
Set Text Msg (add to existing)- Specified by:
setTextMsg
in interfaceI_AD_WF_Process
- Overrides:
setTextMsg
in classX_AD_WF_Process
- Parameters:
TextMsg
- msg
-
addTextMsg
Add to Text Msg- Parameters:
obj
- some object
-
setProcessMsg
Set Process Execution (Error) Message- Parameters:
msg
- message
-
getProcessMsg
Get Process Execution (Error) Message- Returns:
- msg
-