com.cloupia.service.cIM.inframgr

Interface ScheduleTask

All Known Subinterfaces:

CollectorIf, ParameterizedScheduleTask

All Known Implementing Classes:

AbstractScheduleTask, InventoryCollector, InventoryCollector2, LicenseStatusTask

public interface ScheduleTask

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXECUTION_MODE_ALL
static int	EXECUTION_MODE_COLLECTOR
static int	EXECUTION_MODE_JOBMGR
static long	FREQUENCY_15MIN
static long	FREQUENCY_30MIN
static long	FREQUENCY_DAILY
static int	FREQUENCY_FOUR_HOURLY
static long	FREQUENCY_HOURLY
static long	FREQUENCY_MIN
static long	FREQUENCY_MONTHLY
static int	FREQUENCY_NON_RECURRING
static long	FREQUENCY_THOUROUGLY
static int	FREQUENCY_TWENTY_FOUR_HOURLY
static long	FREQUENCY_WEEKLY

Method Summary

Modifier and Type	Method and Description
void	execute(long lastExecuted)
long	getFrequency() The frequency this task will be executed in milliseconds.
FormLOVPair[]	getFrequencyHoursLov() The Hours LOV
FormLOVPair[]	getFrequencyMinsLov() The Minutes LOV
int	getTaskExecutionMode() While implementaing this method, choose the return value very carefully.
java.lang.String	getTaskName() The identifier for this task.
boolean	isValid()

Field Detail

EXECUTION_MODE_ALL

static final int EXECUTION_MODE_ALL

See Also:

Constant Field Values

EXECUTION_MODE_COLLECTOR

static final int EXECUTION_MODE_COLLECTOR

See Also:

Constant Field Values

EXECUTION_MODE_JOBMGR

static final int EXECUTION_MODE_JOBMGR

See Also:

Constant Field Values

FREQUENCY_MIN

static final long FREQUENCY_MIN

See Also:

Constant Field Values

FREQUENCY_15MIN

static final long FREQUENCY_15MIN

See Also:

Constant Field Values

FREQUENCY_30MIN

static final long FREQUENCY_30MIN

See Also:

Constant Field Values

FREQUENCY_HOURLY

static final long FREQUENCY_HOURLY

See Also:

Constant Field Values

FREQUENCY_DAILY

static final long FREQUENCY_DAILY

See Also:

Constant Field Values

FREQUENCY_WEEKLY

static final long FREQUENCY_WEEKLY

See Also:

Constant Field Values

FREQUENCY_MONTHLY

static final long FREQUENCY_MONTHLY

See Also:

Constant Field Values

FREQUENCY_THOUROUGLY

static final long FREQUENCY_THOUROUGLY

See Also:

Constant Field Values

FREQUENCY_FOUR_HOURLY

static final int FREQUENCY_FOUR_HOURLY

See Also:

Constant Field Values

FREQUENCY_TWENTY_FOUR_HOURLY

static final int FREQUENCY_TWENTY_FOUR_HOURLY

See Also:

Constant Field Values

FREQUENCY_NON_RECURRING

static final int FREQUENCY_NON_RECURRING

See Also:

Constant Field Values

Method Detail

getTaskName

java.lang.String getTaskName()

The identifier for this task.

Returns:

A unique string to uniquely identify this task. It is a good idea to prefix your task name with some unique descriptor followed by its purpose. E.g. moduleID_inventoryCollection.

getFrequency

long getFrequency()

The frequency this task will be executed in milliseconds.

Returns:

Number of milliseconds this task should wait between executions.

execute

void execute(long lastExecuted)
      throws java.lang.Exception

Throws:

java.lang.Exception

isValid

boolean isValid()

getTaskExecutionMode

int getTaskExecutionMode()

While implementaing this method, choose the return value very carefully. If you are not sure what to pick, Contact raju@cloupia.com for help. Expected values are: EXECUTION_MODE_ALL, EXECUTION_MODE_COLLECTOR, EXECUTION_MODE_JOBMGR

Returns:

getFrequencyHoursLov

FormLOVPair[] getFrequencyHoursLov()

The Hours LOV

Returns:

List of supported hourly frequencies

getFrequencyMinsLov

FormLOVPair[] getFrequencyMinsLov()

The Minutes LOV

Returns:

List of supported frequencies in minutes