net.bluemind.scheduledjob.scheduler

Interface IScheduler

All Known Implementing Classes:

Scheduler

public interface IScheduler

Method Summary

Modifier and Type	Method and Description
void	error(IScheduledJobRunId rid, java.lang.String locale, java.lang.String logEntry)
void	finish(IScheduledJobRunId rid, JobExitStatus status) Called by jobs at the end of the tick method when no exception occured.
java.util.concurrent.locks.Lock	getDbLock()
void	info(IScheduledJobRunId rid, java.lang.String locale, java.lang.String logEntry)
void	reportProgress(IScheduledJobRunId rid, int percent)
IScheduledJobRunId	requestSlot(java.lang.String domainName, IScheduledJob bj, java.util.Date startDate) Request an execution id to start a job.
void	warn(IScheduledJobRunId rid, java.lang.String locale, java.lang.String logEntry)

Method Detail

requestSlot

IScheduledJobRunId requestSlot(java.lang.String domainName,
                               IScheduledJob bj,
                               java.util.Date startDate)
                        throws ServerFault

Request an execution id to start a job. The task must not do anything if this method returns null or throws an exception. The exception received here MUST be re-thrown to parent.

Parameters:

d -

bj -

startDate -

Returns:

Throws:

ServerFault

info

void info(IScheduledJobRunId rid,
          java.lang.String locale,
          java.lang.String logEntry)

reportProgress

void reportProgress(IScheduledJobRunId rid,
                    int percent)

finish

void finish(IScheduledJobRunId rid,
            JobExitStatus status)

Called by jobs at the end of the tick method when no exception occured.

Parameters:

rid -

status -

warn

void warn(IScheduledJobRunId rid,
          java.lang.String locale,
          java.lang.String logEntry)

error

void error(IScheduledJobRunId rid,
           java.lang.String locale,
           java.lang.String logEntry)

getDbLock

java.util.concurrent.locks.Lock getDbLock()