com.konakartadmin.blif

Interface AdminSchedulerMgrIf

All Known Implementing Classes:

AdminSchedulerMgr

public interface AdminSchedulerMgrIf

AdminSchedulerMgrIf

Method Summary

Modifier and Type	Method and Description
AdminJobStatusResponse	getJobStatus(AdminJobStatusRequest jobStatusRequest) Retrieve Status Information on the Batch Jobs
void	init() Initialise the Scheduler Manager
void	refreshConfigs() Retrieve some commonly-used properties
boolean	runBatchJob(java.lang.String group, java.lang.String name, java.lang.String[] paramArray) Executes the batch job with the specified group and name.

Method Detail

getJobStatus

AdminJobStatusResponse getJobStatus(AdminJobStatusRequest jobStatusRequest)
                             throws KKAdminException

Retrieve Status Information on the Batch Jobs

Parameters:

jobStatusRequest - Defines the jobs to retrieve information about

Returns:

AdminJobStatusResponse an object defining the status of the jobs requested

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

runBatchJob

boolean runBatchJob(java.lang.String group,
                    java.lang.String name,
                    java.lang.String[] paramArray)
             throws KKAdminException

Executes the batch job with the specified group and name.

The batch job must be defined as one the existing batch jobs in the system.

For Quartz jobs, the paramAray is not actually used but it is provided should these parameters be required for overriding the implementation of this method in a custom engine.

Parameters:

group - The group of the batch job to be run

name - The name of the batch job to be executed

paramArray - A generic set of Strings that can be used for custom purposes.

Returns:

Returns true if the job was successfully started, otherwise false

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

init

void init()
   throws KKAdminException

Initialise the Scheduler Manager

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Retrieve some commonly-used properties

Throws:

java.lang.Exception - an unexpected exception