org.osivia.portal.api.batch

Interface Batch

All Known Implementing Classes:

AbstractBatch

public interface Batch

Batch (facade of a quartz job).

Author:

Loïc Billon

Method Summary

Modifier and Type	Method and Description
void	execute(Map<String,Object> parameters) The main execution method.
String	getBatchId() Id a the batch (used to register the job in Quartz scheduler).
String	getJobScheduling() Define the cron used to run the batch periodically
boolean	isRunningOnMasterOnly() Set true if this job should not run on all nodes of the cluster
void	setBatchId(String batchId) Id a the batch (used to register the job in Quartz scheduler).

Method Detail

getBatchId

String getBatchId()

Id a the batch (used to register the job in Quartz scheduler).

Returns:

setBatchId

void setBatchId(String batchId)

Id a the batch (used to register the job in Quartz scheduler).

Parameters:

batchId - the identifier of the batch

getJobScheduling

String getJobScheduling()

Define the cron used to run the batch periodically

Returns:

execute

void execute(Map<String,Object> parameters)
      throws PortalException

The main execution method.

Throws:

PortalException

isRunningOnMasterOnly

boolean isRunningOnMasterOnly()

Set true if this job should not run on all nodes of the cluster

Returns: