org.compiere.model
Class MScheduler

java.lang.Object
  org.compiere.framework.PO
      org.compiere.model.X_AD_Scheduler
          org.compiere.model.MScheduler

All Implemented Interfaces:

Serializable, Cloneable, Comparator<PO>, CompiereProcessor, Evaluatee

public class MScheduler
extends X_AD_Scheduler
implements CompiereProcessor

Scheduler Model

Version:

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

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_AD_Scheduler

accessLevel, FREQUENCYTYPE_AD_Reference_ID, FREQUENCYTYPE_Day, FREQUENCYTYPE_Hour, FREQUENCYTYPE_Minute, Model, SUPERVISOR_ID_AD_Reference_ID, Table_ID, Table_Name, updatedMS

Fields inherited from class org.compiere.framework.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, log, p_changeVO, p_info, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Constructor Summary

MScheduler(Ctx ctx, int AD_Scheduler_ID, String trxName)
Standard Constructor

MScheduler(Ctx ctx, ResultSet rs, String trxName)
Load Constructor

Method Summary

int	deleteLog() Delete old Request Log
String	execute(Trx trx) Run Scheduler
static MScheduler[]	getActive(Ctx ctx) Get Active
Timestamp	getDateNextRun(boolean requery) Get Date Next Run
CompiereProcessorLog[]	getLogs() Get Logs
MSchedulerPara[]	getParameters(boolean reload) Get Parameters
MProcess	getProcess() Get Process
Integer[]	getRecipientAD_User_IDs() Get Recipient AD_User_IDs
MSchedulerRecipient[]	getRecipients(boolean reload) Get Recipients
String	getServerID() Get Server ID
String	toString() String Representation

Methods inherited from class org.compiere.model.X_AD_Scheduler

get_AccessLevel, getAD_Process_ID, getAD_Schedule_ID, getAD_Scheduler_ID, getDateLastRun, getDateNextRun, getDescription, getFrequency, getFrequencyType, getKeepLogDays, getKeyNamePair, getName, getSupervisor_ID, initPO, isFrequencyTypeValid, isProcessing, setAD_Process_ID, setAD_Schedule_ID, setAD_Scheduler_ID, setDateLastRun, setDateNextRun, setDescription, setFrequency, setFrequencyType, setKeepLogDays, setName, setProcessing, setSupervisor_ID

Methods inherited from class org.compiere.framework.PO

addAttachment, addAttachment, addError, afterDelete, afterSave, beforeDelete, beforeSave, compare, convertToBigDecimal, convertToBoolean, convertToInt, convertToTimestamp, copy, copyValues, copyValues, createAttachment, delete_Accounting, delete, delete, dump, dump, equals, get_ChangeVO, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_EntityType, get_HashMap, get_ID, get_IDOld, get_Info, get_KeyColumns, get_Logger, get_Table_ID, get_Table_ID, get_TableName, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_ValuesAsString, get_WhereClause, get_xmlDocument, get_xmlString, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getVO, hashCode, insert_Accounting, is_Changed, is_KeyColumn, is_new, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, load, load, load, load, loadComplete, loadDefaults, loadSpecial, lock, save, save, saveNew_getID, saveNewInsertSQL, saveNewSpecial, saveUpdate, set_ChangeVO, set_ColumnUpdateable, set_CustomColumn, set_TrxName, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueString, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setContext, setCtx, setDocWorkflowMgr, setIsActive, setStandardDefaults, setUpdateable, setUpdatedBy, toStringX, unlock, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.compiere.model.CompiereProcessor

getAD_Client_ID, getAD_Schedule_ID, getCtx, getDateLastRun, getDescription, getFrequency, getFrequencyType, getName, save, setDateLastRun, setDateNextRun

Constructor Detail

MScheduler

public MScheduler(Ctx ctx,
                  int AD_Scheduler_ID,
                  String trxName)

Standard Constructor

Parameters:

ctx - context

AD_Scheduler_ID - id

trxName - transaction

MScheduler

public MScheduler(Ctx ctx,
                  ResultSet rs,
                  String trxName)

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

Method Detail

getActive

public static MScheduler[] getActive(Ctx ctx)

Get Active

Parameters:

ctx - context

Returns:

active processors

getServerID

public String getServerID()

Get Server ID

Specified by:

getServerID in interface CompiereProcessor

Returns:

id

getDateNextRun

public Timestamp getDateNextRun(boolean requery)

Get Date Next Run

Specified by:

getDateNextRun in interface CompiereProcessor

Parameters:

requery - requery

Returns:

date next run

getLogs

public CompiereProcessorLog[] getLogs()

Get Logs

Specified by:

getLogs in interface CompiereProcessor

Returns:

logs

deleteLog

public int deleteLog()

Delete old Request Log

Returns:

number of records

getProcess

public MProcess getProcess()

Get Process

Returns:

process

getParameters

public MSchedulerPara[] getParameters(boolean reload)

Get Parameters

Parameters:

reload - reload

Returns:

parameter

getRecipients

public MSchedulerRecipient[] getRecipients(boolean reload)

Get Recipients

Parameters:

reload - reload

Returns:

Recipients

getRecipientAD_User_IDs

public Integer[] getRecipientAD_User_IDs()

Get Recipient AD_User_IDs

Returns:

array of user IDs

toString

public String toString()

String Representation

Overrides:

toString in class X_AD_Scheduler

Returns:

info

execute

public String execute(Trx trx)
               throws Exception

Run Scheduler

Parameters:

trx - transaction

Returns:

Summary

Throws:

Exception