Package quadbase.reportorganizer.organizerAPI

Interface ICallBackScheduler

public interface ICallBackScheduler

This interface provides a call back mechanism for scheduler tasks. Relevant methods are invoked when different events happens in the Scheduler. To use this class, the user need to provide his/her implementation of this interface, then specify in the serverCommands.txt the name of the class that implements this interface.

    -SchedulerCallBackClass:package.class
    (where package.class is the fully qualified name of the class that implements this interface)
 

important: Also be sure to include the class that implements this interface in your classpath of the application server (such as Tomcat classpath).

Method Summary

Modifier and Type	Method	Description
void	exportFailed(QbScheduleObject obj, String exportPath, Throwable e)	invoked when a schedule task export failed.
void	exportSucceeded(QbScheduleObject obj, String exportPath)	Invoked when a schedule task export succeeded.

Method Details

exportSucceeded

void exportSucceeded(QbScheduleObject obj,
 String exportPath)

Invoked when a schedule task export succeeded. This method is invoked once for every export associated with a task, and once before the end of the task. Thus, if a task contains two exports, the the method will be invoked three three times.

Parameters:

obj - the scheduler object that contains information about the task executed

exportPath - if the task was an export task, this parameter is the location of the exported file. Otherwise, it is null.

exportFailed

void exportFailed(QbScheduleObject obj,
 String exportPath,
 Throwable e)

invoked when a schedule task export failed. This method is invoked once for every export associated with a task, and once before the end of the task. Thus, if a task contains two exports, the the method will be invoked three three times.

Parameters:

obj - the scheduler object that contains information about the task executed

exportPath - if the task was an export task, this parameter is the location of the exported file. Otherwise, it is null.

e - the Exception or Error associated with the error, if available, otherwise null.