psdi.common.asyncjob

Interface AsyncJobHandlerInterface

All Known Implementing Classes:

AssetMoveAsyncJobHandler, AssetStatusAsyncJobHandler, AsyncJobHandler, BudgetGenJobHandler, BudgetUpdateJobHandler, DmCollAsyncJobHandler, DmCompareAsyncJobHandler, DmCompareDelAsyncJobHandler, NestedJobPlanAsyncJobHandler, PMForecastGenAsyncJobHandler, ScriptAsyncJobHandler, SKDAsyncJobHandler, SKDAsyncValidationJobHandler

public interface AsyncJobHandlerInterface

The interface that any Async Job Handler needs to implement. It instructs the Async job crontask how to process the async jobs.

Method Summary

Modifier and Type	Method and Description
void	asyncProcess(MXServer server, java.lang.String jobName, java.lang.String jobQueueNum, java.lang.String Object, UserInfo ui, java.lang.String whereClause, java.util.HashMap<java.lang.String,MaxType> params) This method performs the Asynchronous operation.

Method Detail

asyncProcess

void asyncProcess(MXServer server,
                  java.lang.String jobName,
                  java.lang.String jobQueueNum,
                  java.lang.String Object,
                  UserInfo ui,
                  java.lang.String whereClause,
                  java.util.HashMap<java.lang.String,MaxType> params)
           throws MXException,
                  java.rmi.RemoteException

This method performs the Asynchronous operation. This method will be called by the asynchronous crontask. The user info passed in should be used as the user info to get any transaction or MBO sets. Save() should be called at the end of the method when process is successful.

Parameters:

jobName - The name of the job.

jobQueueNum - The identifier of the job in the job queue.

Object - The name of the main object that the async process is performed on.

userInfo - The user info object which capture the userName, language, locale and timezone that are used for running this job.

whereClause - The where clause applied on the main objects to identify one or more objects that the async process is performed on.

locale - The locale of the user if different from the User's default locale. Null can be passed in if it is using the default locale.

params - A hash map of all the other parameters need to run the async job. The keys are the parameter names and the values are the MaxTypeObject

Throws:

MXException

java.rmi.RemoteException