com.raritantechnologies.searchApp.scheduler
Interface IJobProcessListener

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

BasicJobProcessListener, ERoomBuildProcess, JobSchedule, JobStatus

public interface IJobProcessListener

extends IConfigurable

Base interface for JobProcess listeners.

All initialization, etc. occurs through the ConfigurationManager framework.

XML Configuration Schema:

  <JobProcessListener class="[ class of IJobProcessListener implementation ]" >
     <!-- configuration parameters of the IJobProcessListener class -->
  </JobProcessListener>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

static int	COMPLETED
static int	COMPLETED_NORMALLY
static int	SCHEDULED
static int	STARTED
static int	UNSCHEDULED

Method Summary

int	getCompletedStatus()
java.util.Date	getJobCompletedTime() Returns time at which the Job process executeJob( ) method completed.
java.util.Date	getJobScheduledTime() Returns time at which the Scheduler added the Job to the queue.
java.util.Date	getJobStartTime() Returns time at which the JobDispatcher initiated the job process.
int	getJobStatus()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	jobCompleted(java.lang.Object process, java.util.Date at, int status) set status = 0 for normal completion.
void	jobScheduled(java.util.Date at)
void	jobStarting(java.util.Date at)

Field Detail

UNSCHEDULED

public static final int UNSCHEDULED

See Also:

Constant Field Values

SCHEDULED

public static final int SCHEDULED

See Also:

Constant Field Values

STARTED

public static final int STARTED

See Also:

Constant Field Values

COMPLETED

public static final int COMPLETED

See Also:

Constant Field Values

COMPLETED_NORMALLY

public static final int COMPLETED_NORMALLY

See Also:

Constant Field Values

Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable

jobScheduled

public void jobScheduled(java.util.Date at)

jobStarting

public void jobStarting(java.util.Date at)

jobCompleted

public void jobCompleted(java.lang.Object process,
                         java.util.Date at,
                         int status)

set status = 0 for normal completion.

getJobStatus

public int getJobStatus()

getCompletedStatus

public int getCompletedStatus()

getJobScheduledTime

public java.util.Date getJobScheduledTime()

Returns time at which the Scheduler added the Job to the queue.

getJobStartTime

public java.util.Date getJobStartTime()

Returns time at which the JobDispatcher initiated the job process.

getJobCompletedTime

public java.util.Date getJobCompletedTime()

Returns time at which the Job process executeJob( ) method completed.