com.cloupia.service.cIM.inframgr

Class AbstractScheduleTask

java.lang.Object

com.cloupia.service.cIM.inframgr.AbstractScheduleTask

All Implemented Interfaces:

ScheduleTask

public abstract class AbstractScheduleTask
extends java.lang.Object
implements ScheduleTask

A base implementation of ScheduleTask that hides away unnecessary details developers do not need to be concerned about.

Field Summary

Fields inherited from interface com.cloupia.service.cIM.inframgr.ScheduleTask

EXECUTION_MODE_ALL, EXECUTION_MODE_COLLECTOR, EXECUTION_MODE_JOBMGR, FREQUENCY_15MIN, FREQUENCY_30MIN, FREQUENCY_DAILY, FREQUENCY_FOUR_HOURLY, FREQUENCY_HOURLY, FREQUENCY_MIN, FREQUENCY_MONTHLY, FREQUENCY_NON_RECURRING, FREQUENCY_THOUROUGLY, FREQUENCY_TWENTY_FOUR_HOURLY, FREQUENCY_WEEKLY

Constructor Summary

Constructors

Constructor and Description
AbstractScheduleTask(java.lang.String moduleID) All instances of AbstractScheduleTask must come with a moduleID.

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	getScheduleTaskName() Returns the name of this task.
int	getTaskExecutionMode() While implementaing this method, choose the return value very carefully.
java.lang.String	getTaskName() The identifier for this task.
boolean	isValid()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.cloupia.service.cIM.inframgr.ScheduleTask

execute, getFrequency, getFrequencyHoursLov, getFrequencyMinsLov

Constructor Detail

AbstractScheduleTask

public AbstractScheduleTask(java.lang.String moduleID)

All instances of AbstractScheduleTask must come with a moduleID. This ties the task to a module so we know which tasks a developer are allowed to modify.

Parameters:

moduleID - the module ID you are using.

Method Detail

isValid

public boolean isValid()

Specified by:

isValid in interface ScheduleTask

getTaskExecutionMode

public int getTaskExecutionMode()

Description copied from interface: ScheduleTask

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

Specified by:

getTaskExecutionMode in interface ScheduleTask

Returns:

getTaskName

public java.lang.String getTaskName()

Description copied from interface: ScheduleTask

The identifier for this task.

Specified by:

getTaskName in interface ScheduleTask

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.

getScheduleTaskName

protected abstract java.lang.String getScheduleTaskName()

Returns the name of this task. It is a good idea to name your task something so it describes the functionality that way you can easily debug or locate it. E.g. inventory_collection, inventory_purging, etc.

Returns:

a string used to uniquely identify this task and describes its purpose.