psdi.app.pm

Class PMForecastCronTask

java.lang.Object

psdi.server.SimpleCronTask

psdi.app.pm.PMForecastCronTask

All Implemented Interfaces:

CronTask

public class PMForecastCronTask
extends SimpleCronTask

This is a Cron task that generates PM Forecast. Cron task parameters are used as input to generate PM Forecast. The parameters are siteid, orgid, whereclause, forecastfordays, emailto, logfile. The "WhereClause" for getting the PMSet is read from cron task parameter 'whereclause' for a given site crontask parameter 'siteid' and given crontask parameter 'orgid'. For each of the PM in this set, generateWork() will be called by passing crontask parameter 'forecastfordays' of the site . After the forecast is generated, the results are e-mailed to the address specified by the crontask parameter 'emailto' and added to the logfile specified by the crontask parameter 'logfile'.

Constructor Summary

Constructors

Constructor and Description
PMForecastCronTask()

Method Summary

Modifier and Type	Method and Description
void	cronAction() Cron Action to generate the PM Forecast
CrontaskParamInfo[]	getParameters() Set the cron task instance parameters for PM Forecast cron task Parameters set are whereclause,forecastfordays,emailto,logfile,orgid,siteid
MboRemote	getParameterValidationMbo(CrontaskInstanceRemote instance) Returns the validation mbo for the crontask parameter
void	init() initializes the crontask ()
void	readConfig() Read in the configuration information from cron task instance parameters.

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, getRunasUserInfo, getSleepTime, isOKToRun, isShutdown, setCronTaskHistoryMsg, setCrontaskInstance, setDBLastSeed, setEnteredValueVector, setInterval, setIntervalFlag, setLastRunDate, setLastSeed, setSleepTime, shutdown, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

PMForecastCronTask

public PMForecastCronTask()

Method Detail

init

public void init()
          throws MXException

initializes the crontask ()

Specified by:

init in interface CronTask

Overrides:

init in class SimpleCronTask

Throws:

MXException

See Also:

SecurityService.authenticateUser(String, boolean)

readConfig

public void readConfig()
                throws java.rmi.RemoteException,
                       MXException

Read in the configuration information from cron task instance parameters. If not specified in the cron task instance parameters get it from the mxserver properties.

Throws:

java.rmi.RemoteException

MXException

cronAction

public void cronAction()

Cron Action to generate the PM Forecast

Specified by:

cronAction in interface CronTask

Specified by:

cronAction in class SimpleCronTask

getParameters

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

Set the cron task instance parameters for PM Forecast cron task Parameters set are whereclause,forecastfordays,emailto,logfile,orgid,siteid

Specified by:

getParameters in interface CronTask

Overrides:

getParameters in class SimpleCronTask

Returns:

Array of CrontaskParamInfo

Throws:

MXException

java.rmi.RemoteException

See Also:

CrontaskParamInfo

getParameterValidationMbo

public MboRemote getParameterValidationMbo(CrontaskInstanceRemote instance)
                                    throws MXException,
                                           java.rmi.RemoteException

Returns the validation mbo for the crontask parameter

Specified by:

getParameterValidationMbo in interface CronTask

Overrides:

getParameterValidationMbo in class SimpleCronTask

Parameters:

instance - CrontaskInstanceRemote

Returns:

MboRemote Parameter Validation Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

CronTask.getParameterValidationMbo(CrontaskInstanceRemote)