Package org.compiere.model

Class MSchedule

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_AD_Schedule

org.compiere.model.MSchedule

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_AD_Schedule, I_Persistent, Evaluatee, ImmutablePOSupport

public class MSchedule
extends X_AD_Schedule
implements ImmutablePOSupport

Schedule model for scheduler

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_AD_Schedule

FREQUENCYTYPE_AD_Reference_ID, FREQUENCYTYPE_Day, FREQUENCYTYPE_Hour, FREQUENCYTYPE_Minute, SCHEDULETYPE_AD_Reference_ID, SCHEDULETYPE_CronSchedulingPattern, SCHEDULETYPE_Frequency, SCHEDULETYPE_MonthDay, SCHEDULETYPE_WeekDay, WEEKDAY_AD_Reference_ID, WEEKDAY_Friday, WEEKDAY_Monday, WEEKDAY_Saturday, WEEKDAY_Sunday, WEEKDAY_Thursday, WEEKDAY_Tuesday, WEEKDAY_Wednesday

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_Schedule

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_Schedule_ID, COLUMNNAME_AD_Schedule_UU, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_CronPattern, COLUMNNAME_Description, COLUMNNAME_Frequency, COLUMNNAME_FrequencyType, COLUMNNAME_IsActive, COLUMNNAME_IsIgnoreProcessingTime, COLUMNNAME_IsSystemSchedule, COLUMNNAME_MonthDay, COLUMNNAME_Name, COLUMNNAME_RunOnlyOnIP, COLUMNNAME_ScheduleType, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, COLUMNNAME_WeekDay, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MSchedule(Properties ctx, int AD_Schedule_ID, String trxName)
MSchedule(Properties ctx, String AD_Schedule_UU, String trxName)	UUID based Constructor
MSchedule(Properties ctx, ResultSet rs, String trxName)
MSchedule(Properties ctx, MSchedule copy)	Copy constructor
MSchedule(Properties ctx, MSchedule copy, String trxName)	Copy constructor
MSchedule(MSchedule copy)	Copy 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.
boolean	chekIPFormat(String ipOnly)
static MSchedule	get(int AD_Schedule_ID)	Get MSchedule from cache (immutable)
static MSchedule	get(Properties ctx, int AD_Schedule_ID)	Get MSchedule from cache (immutable)
static long	getNextRunMS(long last, String scheduleType, String frequencyType, int frequency, String cronPattern)	Deprecated.
static long	getNextRunMS(long last, String scheduleType, String frequencyType, int frequency, String cronPattern, String timeZone)	Get Next Run
boolean	isOKtoRunOnIP()	Is it OK to Run process on this server based on server IP verification.
MSchedule	markImmutable()	mark PO as immutable

Methods inherited from class org.compiere.model.X_AD_Schedule

get_AccessLevel, getAD_Schedule_ID, getAD_Schedule_UU, getCronPattern, getDescription, getFrequency, getFrequencyType, getKeyNamePair, getMonthDay, getName, getRunOnlyOnIP, getScheduleType, getWeekDay, initPO, isIgnoreProcessingTime, isSystemSchedule, setAD_Schedule_ID, setAD_Schedule_UU, setCronPattern, setDescription, setFrequency, setFrequencyType, setIsIgnoreProcessingTime, setIsSystemSchedule, setMonthDay, setName, setRunOnlyOnIP, setScheduleType, setWeekDay, 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_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_Schedule

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

MSchedule

public MSchedule(Properties ctx,
 String AD_Schedule_UU,
 String trxName)

UUID based Constructor

Parameters:

ctx - Context

AD_Schedule_UU - UUID key

trxName - Transaction

MSchedule

public MSchedule(Properties ctx,
 int AD_Schedule_ID,
 String trxName)

Parameters:

ctx -

AD_Schedule_ID -

trxName -

MSchedule

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

Parameters:

ctx -

rs -

trxName -

MSchedule

public MSchedule(MSchedule copy)

Copy constructor

Parameters:

copy -

MSchedule

public MSchedule(Properties ctx,
 MSchedule copy)

Copy constructor

Parameters:

ctx -

copy -

MSchedule

public MSchedule(Properties ctx,
 MSchedule copy,
 String trxName)

Copy constructor

Parameters:

ctx -

copy -

trxName -

Method Details

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

isOKtoRunOnIP

public boolean isOKtoRunOnIP()

Is it OK to Run process on this server based on server IP verification.

Returns:

true if it is ok to run

get

public static MSchedule get(int AD_Schedule_ID)

Get MSchedule from cache (immutable)

Parameters:

AD_Schedule_ID -

Returns:

MSchedule

get

public static MSchedule get(Properties ctx,
 int AD_Schedule_ID)

Get MSchedule from cache (immutable)

Parameters:

ctx -

AD_Schedule_ID -

Returns:

MSchedule

chekIPFormat

public boolean chekIPFormat(String ipOnly)

Parameters:

ipOnly -

Returns:

true if ipOnly is IPV4 IPV6 address

getNextRunMS

@Deprecated
public static long getNextRunMS(long last,
 String scheduleType,
 String frequencyType,
 int frequency,
 String cronPattern)

Deprecated.

Get Next Run

Parameters:

last - in MS

scheduleType -

frequencyType -

frequency -

cronPattern -

Returns:

next run in MS

getNextRunMS

public static long getNextRunMS(long last,
 String scheduleType,
 String frequencyType,
 int frequency,
 String cronPattern,
 String timeZone)

Get Next Run

Parameters:

last - in MS

scheduleType -

frequencyType -

frequency -

cronPattern -

timeZone -

Returns:

next run time stamp in millisecond

markImmutable

public MSchedule markImmutable()

Description copied from interface: ImmutablePOSupport

mark PO as immutable

Specified by:

markImmutable in interface ImmutablePOSupport

Returns:

PO