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, Comparator, I_AD_WF_Process, I_Persistent, Evaluatee

public class MWFProcess
extends X_AD_WF_Process

Workflow Process

Version:

$Id: MWFProcess.java,v 1.2 2006/07/30 00:51:05 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_AD_WF_Process

AD_USER_ID_AD_Reference_ID, 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, log, p_ctx, p_info, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.model.I_AD_WF_Process

accessLevel, COLUMNNAME_AD_Message_ID, COLUMNNAME_AD_Table_ID, COLUMNNAME_AD_User_ID, COLUMNNAME_AD_WF_Process_ID, COLUMNNAME_AD_WF_Responsible_ID, COLUMNNAME_AD_Workflow_ID, COLUMNNAME_Priority, COLUMNNAME_Processed, COLUMNNAME_Processing, COLUMNNAME_Record_ID, COLUMNNAME_TextMsg, COLUMNNAME_WFState, Model, Table_ID, Table_Name

Constructor Summary

MWFProcess(MWorkflow wf, ProcessInfo pi)
Deprecated.

MWFProcess(MWorkflow wf, ProcessInfo pi, String trxName)
New Constructor

MWFProcess(Properties ctx, int AD_WF_Process_ID, String trxName)
Standard Constructor

MWFProcess(Properties ctx, ResultSet rs, String trxName)
Load Constructor

Method Summary

void	checkActivities(String trxName, PO lastPO) Check Status of Activities
String[]	getActionOptions() Get Action Options
MWFActivity[]	getActivities(boolean requery, boolean onlyActive) Get active Activities of Process
MWFActivity[]	getActivities(boolean requery, boolean onlyActive, String trxName) Get active Activities of Process
PO	getPO() Get Persistent Object
String	getProcessMsg() Get Runtime (Error) Message
StateEngine	getState() Get State
boolean	perform(String action) Perform Action
void	setAD_WF_Responsible_ID() Set Workflow Responsible.
void	setProcessMsg(String msg) Set Runtime (Error) Message
void	setTextMsg(PO po) Set Text Msg (add to existing)
void	setTextMsg(String TextMsg) Set Text Msg (add to existing)
void	setWFState(String WFState) Set Process State and update Actions
boolean	startWork() Start WF Execution

Methods inherited from class org.compiere.model.X_AD_WF_Process

get_AccessLevel, getAD_Message_ID, getAD_Message, getAD_Table_ID, getAD_Table, getAD_User_ID, getAD_WF_Process_ID, getAD_WF_Responsible_ID, getAD_WF_Responsible, getAD_Workflow_ID, getAD_Workflow, getKeyNamePair, getPriority, getRecord_ID, getTextMsg, getWFState, initPO, isProcessed, isProcessing, setAD_Message_ID, setAD_Table_ID, setAD_User_ID, setAD_WF_Process_ID, 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, compare, copyValues, copyValues, createAttachment, delete_Accounting, delete_Tree, delete, delete, deleteEx, deleteEx, dump, dump, equals, 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_Table_ID, get_TableName, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_new, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadComplete, loadDefaults, loadSpecial, lock, save, save, saveEx, saveEx, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_ColumnUpdateable, set_CustomColumn, set_TrxName, set_TrxName, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setDoc, setDocWorkflowMgr, setIsActive, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, unlock

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.compiere.model.I_Persistent

save

Constructor Detail

MWFProcess

public MWFProcess(Properties ctx,
                  int AD_WF_Process_ID,
                  String trxName)

Standard Constructor

Parameters:

ctx - context

AD_WF_Process_ID - process

trxName - transaction

MWFProcess

public MWFProcess(Properties ctx,
                  ResultSet rs,
                  String trxName)

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

MWFProcess

public MWFProcess(MWorkflow wf,
                  ProcessInfo pi)
           throws Exception

Deprecated.

New Constructor

Parameters:

wf - workflow

pi - Process Info (Record_ID)

Throws:

Exception

MWFProcess

public MWFProcess(MWorkflow wf,
                  ProcessInfo pi,
                  String trxName)
           throws Exception

New Constructor

Parameters:

wf - workflow

pi - Process Info (Record_ID)

trxName -

Throws:

Exception

Method Detail

getActivities

public MWFActivity[] getActivities(boolean requery,
                                   boolean onlyActive)

Get active Activities of Process

Parameters:

requery - if true requery

onlyActive - only active activities

Returns:

array of activities

getActivities

public MWFActivity[] getActivities(boolean requery,
                                   boolean onlyActive,
                                   String trxName)

Get active Activities of Process

Parameters:

requery - if true requery

onlyActive - only active activities

Returns:

array of activities

getState

public StateEngine getState()

Get State

Returns:

state

getActionOptions

public String[] getActionOptions()

Get Action Options

Returns:

array of valid actions

setWFState

public void setWFState(String WFState)

Set Process State and update Actions

Specified by:

setWFState in interface I_AD_WF_Process

Overrides:

setWFState in class X_AD_WF_Process

Parameters:

WFState -

checkActivities

public void checkActivities(String trxName,
                            PO lastPO)

Check Status of Activities. - update Process if required - start new activity

Parameters:

trxName - transaction

setAD_WF_Responsible_ID

public void setAD_WF_Responsible_ID()

Set Workflow Responsible. Searches for a Invoker.

perform

public boolean perform(String action)

Perform Action

Parameters:

action - StateEngine.ACTION_*

Returns:

true if valid

startWork

public boolean startWork()

Start WF Execution

Returns:

true if success

getPO

public PO getPO()

Get Persistent Object

Returns:

po

setTextMsg

public void setTextMsg(PO po)

Set Text Msg (add to existing)

Parameters:

po - base object

setTextMsg

public void setTextMsg(String TextMsg)

Set Text Msg (add to existing)

Specified by:

setTextMsg in interface I_AD_WF_Process

Overrides:

setTextMsg in class X_AD_WF_Process

Parameters:

TextMsg - msg

setProcessMsg

public void setProcessMsg(String msg)

Set Runtime (Error) Message

Parameters:

msg - message

getProcessMsg

public String getProcessMsg()

Get Runtime (Error) Message

Returns:

msg