org.jberet.schedule

Class JobScheduleConfig

java.lang.Object

org.jberet.schedule.JobScheduleConfig

All Implemented Interfaces:

Serializable

public final class JobScheduleConfig
extends Object
implements Serializable

Represents job schedule configuration, typically passed from the client side to schedule a job.

Since:

1.3.0

See Also:

JobSchedule, Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobScheduleConfig() Default no-arg constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
long	getAfterDelay() Gets the subsequent delay (in minutes) of this job schedule.
long	getInitialDelay() Gets the initial delay (in minutes) of this job schedule.
long	getInterval() Gets the interval or period (in minutes) of this job schedule.
long	getJobExecutionId() Gets the job execution id for this job schedule.
String	getJobName() Gets the job XML name for this job schedule.
Properties	getJobParameters() Gets the job parameters for starting the job or restarting the job execution.
javax.ejb.ScheduleExpression	getScheduleExpression() Gets javax.ejb.ScheduleExpression for calendar-based job schedule.
int	hashCode()
boolean	isPersistent() Gets whether the job schedule is persistent.
boolean	isRepeating() Determines if this job schedule is repeatable or not.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JobScheduleConfig

public JobScheduleConfig()

Default no-arg constructor.

Method Detail

isRepeating

public boolean isRepeating()

Determines if this job schedule is repeatable or not.

Returns:

true if afterDelay greater than 0, interval greater than 0, or scheduleExpression not null

getJobName

public String getJobName()

Gets the job XML name for this job schedule.

Returns:

job XML name, null if this job schedule is for restarting a job execution

getJobExecutionId

public long getJobExecutionId()

Gets the job execution id for this job schedule.

Returns:

job execution id, 0 if this job schedule is for starting a job

getJobParameters

public Properties getJobParameters()

Gets the job parameters for starting the job or restarting the job execution.

Returns:

job parameters, may be empty or null

getScheduleExpression

public javax.ejb.ScheduleExpression getScheduleExpression()

Gets javax.ejb.ScheduleExpression for calendar-based job schedule.

Returns:

schedule expression, may be null

getInitialDelay

public long getInitialDelay()

Gets the initial delay (in minutes) of this job schedule.

Returns:

initial delay, 0 for calendar-based job schedule

getAfterDelay

public long getAfterDelay()

Gets the subsequent delay (in minutes) of this job schedule. Note that subsequent delay does not apply to single action or calendar-based job schedule.

Returns:

subsequent delay

getInterval

public long getInterval()

Gets the interval or period (in minutes) of this job schedule. Note that interval does not apply to single action or calendar-based job schedule. For non-calendar repeatable job schedule that has afterDelay specified, the interval is ignored.

Returns:

interval or period of the job schedule

isPersistent

public boolean isPersistent()

Gets whether the job schedule is persistent. Note that some JobScheduler implementations may not support persistent schedules.

Returns:

whether the job schedule is persistent

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object