org.exist.scheduler
Class ScheduledJobInfo

java.lang.Object
  extended by org.exist.scheduler.ScheduledJobInfo

public class ScheduledJobInfo
extends Object

Information about a Scheduled Job

Author:
Adam Retter

Field Summary
static int TRIGGER_STATE_BLOCKED
           
static int TRIGGER_STATE_COMPLETE
           
static int TRIGGER_STATE_ERROR
           
static int TRIGGER_STATE_NONE
           
static int TRIGGER_STATE_NORMAL
           
static int TRIGGER_STATE_PAUSED
           
 
Constructor Summary
ScheduledJobInfo(Scheduler scheduler, Trigger trigger)
           
 
Method Summary
 Date getEndTime()
          Get the End time of the Job
 Date getFinalFireTime()
          Get the Final Time the Job will be Fired
 String getGroup()
          Get the Job's Group
 String getName()
          Get the Job's Name
 Date getNextFireTime()
          Get the Time the Job will Next be Fired
 Date getPreviousFireTime()
          Get the Previous Fired time of the Job
 Date getStartTime()
          Get the Start time of the Job
 String getTriggerExpression()
          Get the Expression that was used to configure the Triggers firing pattern
 String getTriggerName()
          Get the Name of the Job's Trigger
 int getTriggerState()
          Get the State of the Job's Trigger
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TRIGGER_STATE_ERROR

public static final int TRIGGER_STATE_ERROR
See Also:
Constant Field Values

TRIGGER_STATE_NONE

public static final int TRIGGER_STATE_NONE
See Also:
Constant Field Values

TRIGGER_STATE_NORMAL

public static final int TRIGGER_STATE_NORMAL
See Also:
Constant Field Values

TRIGGER_STATE_PAUSED

public static final int TRIGGER_STATE_PAUSED
See Also:
Constant Field Values

TRIGGER_STATE_BLOCKED

public static final int TRIGGER_STATE_BLOCKED
See Also:
Constant Field Values

TRIGGER_STATE_COMPLETE

public static final int TRIGGER_STATE_COMPLETE
See Also:
Constant Field Values
Constructor Detail

ScheduledJobInfo

public ScheduledJobInfo(Scheduler scheduler,
                        Trigger trigger)
Method Detail

getName

public String getName()
Get the Job's Name

Returns:
the Job's Name

getGroup

public String getGroup()
Get the Job's Group

Returns:
the Job's Group

getTriggerName

public String getTriggerName()
Get the Name of the Job's Trigger

Returns:
the Name of the Job's Trigger

getStartTime

public Date getStartTime()
Get the Start time of the Job

Returns:
the Start time of the Job

getEndTime

public Date getEndTime()
Get the End time of the Job

Returns:
the End time of the Job, or null of the job is Scheduled forever

getPreviousFireTime

public Date getPreviousFireTime()
Get the Previous Fired time of the Job

Returns:
the time the Job was Previously Fired, or null if the job hasnt fired yet

getNextFireTime

public Date getNextFireTime()
Get the Time the Job will Next be Fired

Returns:
the time the Job will Next be Fired, or null if the job wont fire again

getFinalFireTime

public Date getFinalFireTime()
Get the Final Time the Job will be Fired

Returns:
the time the Job will be Fired for the Final time, or null if the job is Scheduled forever

getTriggerExpression

public String getTriggerExpression()
Get the Expression that was used to configure the Triggers firing pattern

Returns:
The expression that was used to configure the Triggers firing pattern

getTriggerState

public int getTriggerState()
Get the State of the Job's Trigger

Returns:
the TRIGGER_STATE_*


Copyright (C) Wolfgang Meier. All rights reserved.