org.jberet.schedule

Class JobSchedule

java.lang.Object

org.jberet.schedule.JobSchedule

All Implemented Interfaces:

Serializable, Comparable<JobSchedule>

public final class JobSchedule
extends Object
implements Serializable, Comparable<JobSchedule>

Represents a job schedule. Instances of this class may be transferred during remote REST API invocations.

Since:

1.3.0

See Also:

JobScheduleConfig, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobSchedule.Status Statuses of JobSchedule.

Constructor Summary

Constructors

Constructor and Description
JobSchedule() Default no-arg constructor.
JobSchedule(String id, JobScheduleConfig jobScheduleConfig) Constructs JobSchedule with id and JobScheduleConfig.

Method Summary

Modifier and Type	Method and Description
int	compareTo(JobSchedule o) Compares another job schedule to this one, based on their create time.
String	getId() Gets the job schedule id.
List<Long>	getJobExecutionIds() Gets all ids of job executions that have realized from this job schedule.
JobScheduleConfig	getJobScheduleConfig() Gets the job schedule config, which is typically passed in when creating JobSchedule.
JobSchedule.Status	getStatus() Gets the job schedule status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobSchedule

public JobSchedule()

Default no-arg constructor.

JobSchedule

public JobSchedule(String id,
                   JobScheduleConfig jobScheduleConfig)

Constructs JobSchedule with id and JobScheduleConfig.

Parameters:

id - job schedule id

jobScheduleConfig - job schedule config

Method Detail

getId

public String getId()

Gets the job schedule id.

Returns:

job schedule id

getJobScheduleConfig

public JobScheduleConfig getJobScheduleConfig()

Gets the job schedule config, which is typically passed in when creating JobSchedule.

Returns:

job schedule config

getStatus

public JobSchedule.Status getStatus()

Gets the job schedule status.

Returns:

job schedule status

getJobExecutionIds

public List<Long> getJobExecutionIds()

Gets all ids of job executions that have realized from this job schedule.

Returns:

all job execution ids

compareTo

public int compareTo(JobSchedule o)

Compares another job schedule to this one, based on their create time.

Specified by:

compareTo in interface Comparable<JobSchedule>

Parameters:

o - the other job schedule

Returns:

the result of comparing their create time