psdi.app.system

Class TenantRemovalCronTask

java.lang.Object

psdi.server.SimpleCronTask

psdi.app.system.TenantRemovalCronTask

All Implemented Interfaces:

CronTask

public class TenantRemovalCronTask
extends SimpleCronTask

Author:

Anamitra To change the template for this generated type comment go to Window>Preferences>Java>Code Generation>Code and Comments

Constructor Summary

Constructors

Constructor and Description
TenantRemovalCronTask()

Method Summary

Modifier and Type	Method and Description
void	cronAction() This is the CORE METHOD of this class.
CrontaskParamInfo[]	getParameters() This method provides an array of CrontaskParamInfo() object to describe all the parameters of the crontask.
void	setCrontaskInstance(CrontaskInstanceRemote inst) Cache the crontask instance this crontask object is instantiated for.
void	start() Default implementation for start().

Methods inherited from class psdi.server.SimpleCronTask

beforeRemoval, getCronTaskHistoryMsg, getCrontaskInstance, getCronTaskLogger, getCronTaskSqlLogger, getDBLastSeed, getEnteredValueVector, getInterval, getIntervalFlag, getLastRunDate, getLastSeed, getName, getParamAsBoolean, getParamAsDate, getParamAsDouble, getParamAsInt, getParamAsString, getParameter, getParameterValidationMbo, getParameterValidationMbo, getRunasUserInfo, getSleepTime, init, isOKToRun, isShutdown, setCronTaskHistoryMsg, setDBLastSeed, setEnteredValueVector, setInterval, setIntervalFlag, setLastRunDate, setLastSeed, setSleepTime, shutdown, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

TenantRemovalCronTask

public TenantRemovalCronTask()

Method Detail

start

public void start()

Description copied from class: SimpleCronTask

Default implementation for start(). It does nothing.

Specified by:

start in interface CronTask

Overrides:

start in class SimpleCronTask

See Also:

CronTask.stop(), startup()

cronAction

public void cronAction()

Description copied from class: SimpleCronTask

This is the CORE METHOD of this class. You should invoke whatever logic you want your CronTask to perform from this method. This method should

1. check the shutdown variable before invoking any processing logic.
2. call resetErrorCount() if processing proceeds w/out error.
3. call incErrorCount() if a serious error occurs during the processing logic.

Specified by:

cronAction in interface CronTask

Specified by:

cronAction in class SimpleCronTask

getParameters

public CrontaskParamInfo[] getParameters()
                                  throws MXException,
                                         java.rmi.RemoteException

Description copied from interface: CronTask

This method provides an array of CrontaskParamInfo() object to describe all the parameters of the crontask. Parameter name, default values and the description of the parameter should be set to the CrontaskParamInfo object for each parameter. If default value and description is not set, null will be the values.

Specified by:

getParameters in interface CronTask

Overrides:

getParameters in class SimpleCronTask

Returns:

Throws:

MXException

java.rmi.RemoteException

See Also:

CrontaskParamInfo

setCrontaskInstance

public void setCrontaskInstance(CrontaskInstanceRemote inst)

Description copied from class: SimpleCronTask

Cache the crontask instance this crontask object is instantiated for.

Specified by:

setCrontaskInstance in interface CronTask

Overrides:

setCrontaskInstance in class SimpleCronTask

See Also:

CronTask.setCrontaskInstance(CrontaskInstanceRemote)