Package org.compiere.wf

Class MWorkflowProcessor

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_AD_WorkflowProcessor

org.compiere.wf.MWorkflowProcessor

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, AdempiereProcessor, AdempiereProcessor2, I_AD_WorkflowProcessor, I_Persistent, Evaluatee

public class MWorkflowProcessor
extends X_AD_WorkflowProcessor
implements AdempiereProcessor, AdempiereProcessor2

Extended Workflow Processor Model for AD_WorkflowProcessor

Version:

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

Author:

Jorg Janke

See Also:

• Serialized Form

Field Summary

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_WorkflowProcessor

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_Schedule_ID, COLUMNNAME_AD_WorkflowProcessor_ID, COLUMNNAME_AD_WorkflowProcessor_UU, COLUMNNAME_AlertOverPriority, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_DateLastRun, COLUMNNAME_DateNextRun, COLUMNNAME_Description, COLUMNNAME_InactivityAlertDays, COLUMNNAME_IsActive, COLUMNNAME_KeepLogDays, COLUMNNAME_Name, COLUMNNAME_Processing, COLUMNNAME_RemindDays, COLUMNNAME_Supervisor_ID, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MWorkflowProcessor(Properties ctx, int AD_WorkflowProcessor_ID, String trxName)	Standard Constructor
MWorkflowProcessor(Properties ctx, String AD_WorkflowProcessor_UU, String trxName)	UUID based Constructor
MWorkflowProcessor(Properties ctx, ResultSet rs, String trxName)	Load Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	beforeSave(boolean newRecord)	Called before Save for Pre-Save Operation. Default implementation is nop, to be implemented in sub-classes that needed it.
int	deleteLog()	Delete old processor logs
static MWorkflowProcessor[]	getActive(Properties ctx)	Get active workflow processors
String	getCronPattern()	Get the cron pattern
Timestamp	getDateNextRun(boolean requery)	Get Date Next Run
int	getFrequency()	Get the frequency
String	getFrequencyType()	Get the frequency type
AdempiereProcessorLog[]	getLogs()	Get process logs
String	getScheduleType()	Get the schedule type
String	getServerID()	Get Server ID
boolean	isIgnoreProcessingTime()

Methods inherited from class org.compiere.model.X_AD_WorkflowProcessor

get_AccessLevel, getAD_Schedule, getAD_Schedule_ID, getAD_WorkflowProcessor_ID, getAD_WorkflowProcessor_UU, getAlertOverPriority, getDateLastRun, getDateNextRun, getDescription, getInactivityAlertDays, getKeepLogDays, getKeyNamePair, getName, getRemindDays, getSupervisor, getSupervisor_ID, initPO, isProcessing, setAD_Schedule_ID, setAD_WorkflowProcessor_ID, setAD_WorkflowProcessor_UU, setAlertOverPriority, setDateLastRun, setDateNextRun, setDescription, setInactivityAlertDays, setKeepLogDays, setName, setProcessing, setRemindDays, setSupervisor_ID, toString

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, 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_TableAttribute, get_TableAttributeAsBoolean, get_TableAttributeAsInt, get_TableAttributes, 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, validForeignKeysEx

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.compiere.model.AdempiereProcessor

getAD_Client_ID, getCtx, getDateLastRun, getDescription, getName, save, saveEx, setDateLastRun, setDateNextRun

Methods inherited from interface org.compiere.model.AdempiereProcessor2

getAD_Schedule_ID

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.compiere.model.I_AD_WorkflowProcessor

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

MWorkflowProcessor

public MWorkflowProcessor(Properties ctx,
 String AD_WorkflowProcessor_UU,
 String trxName)

UUID based Constructor

Parameters:

ctx - Context

AD_WorkflowProcessor_UU - UUID key

trxName - Transaction

MWorkflowProcessor

public MWorkflowProcessor(Properties ctx,
 int AD_WorkflowProcessor_ID,
 String trxName)

Standard Constructor

Parameters:

ctx - context

AD_WorkflowProcessor_ID - id

trxName - transaction

MWorkflowProcessor

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

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

Method Details

getActive

public static MWorkflowProcessor[] getActive(Properties ctx)

Get active workflow processors

Parameters:

ctx - context

Returns:

active workflow processors

getServerID

public String getServerID()

Get Server ID

Specified by:

getServerID in interface AdempiereProcessor

Returns:

server id

getDateNextRun

public Timestamp getDateNextRun(boolean requery)

Get Date Next Run

Specified by:

getDateNextRun in interface AdempiereProcessor

Parameters:

requery - true to reload from DB

Returns:

next run date

getLogs

public AdempiereProcessorLog[] getLogs()

Get process logs

Specified by:

getLogs in interface AdempiereProcessor

Returns:

processor logs

deleteLog

public int deleteLog()

Delete old processor logs

Returns:

number of records deleted

beforeSave

protected boolean beforeSave(boolean newRecord)

Description copied from class: PO

Called before Save for Pre-Save Operation.
Default implementation is nop, to be implemented in sub-classes that needed it.

Overrides:

beforeSave in class PO

Parameters:

newRecord - true if it is a new record

Returns:

true if record can be saved

getFrequencyType

public String getFrequencyType()

Description copied from interface: AdempiereProcessor

Get the frequency type

Specified by:

getFrequencyType in interface AdempiereProcessor

Returns:

frequency type

getFrequency

public int getFrequency()

Description copied from interface: AdempiereProcessor

Get the frequency

Specified by:

getFrequency in interface AdempiereProcessor

Returns:

frequency

isIgnoreProcessingTime

public boolean isIgnoreProcessingTime()

Specified by:

isIgnoreProcessingTime in interface AdempiereProcessor2

Returns:

True if previous DateNextRun should be use as base to calculate the new DateNextRun value. False to follow the legacy behaviour where current server time is use as the base to calculate the new DateNextRun value.

getScheduleType

public String getScheduleType()

Description copied from interface: AdempiereProcessor

Get the schedule type

Specified by:

getScheduleType in interface AdempiereProcessor

Returns:

schedule type

getCronPattern

public String getCronPattern()

Description copied from interface: AdempiereProcessor

Get the cron pattern

Specified by:

getCronPattern in interface AdempiereProcessor

Returns:

cron pattern