org.ops4j.pax.radman.service.job.scheduler
Class JobDescriptor

java.lang.Object
  org.ops4j.pax.radman.service.job.scheduler.JobDescriptor

All Implemented Interfaces:

java.io.Serializable

public final class JobDescriptor
extends java.lang.Object
implements java.io.Serializable

JobDescriptor represents informations:

• When the job should be executed?
• What job should be executed?
• What job parameter is required to execute the job?

Since:

0.1.0

Author:

Edward Yakop, Gavin Bong

See Also:

Serialized Form

Constructor Summary

JobDescriptor(java.lang.String cron, java.lang.String jobId, java.lang.String jobServiceId, JobParam jobParam)
Construct an instance of JobDecriptor with the specified arguments.

Method Summary

java.lang.String	getCronSchedule() Returns the schedule job execution time in cron format.
java.lang.String	getJobId() Returns the job id.
JobParam	getJobParameter() Returns the job parameter.
java.lang.String	getJobServiceId() Returns the job service id.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobDescriptor

public JobDescriptor(java.lang.String cron,
                     java.lang.String jobId,
                     java.lang.String jobServiceId,
                     JobParam jobParam)
              throws java.lang.IllegalArgumentException

Construct an instance of JobDecriptor with the specified arguments.

Parameters:

cron - The schedule as cron. null means the job to be executed immediately.

jobId - The job id id. This argument must not be null or empty.

jobServiceId - The job service id. This argument must not be null.

jobParam - The job parameter. This argument must not be null.

Throws:

java.lang.IllegalArgumentException - Thrown if arguments with non-null is specified.

Since:

0.1.0

Method Detail

getCronSchedule

public final java.lang.String getCronSchedule()

Returns the schedule job execution time in cron format. Returns null if the job described by this instance should be invoked immediately.

Returns:

The schedule job execution time.

Since:

0.1.0

getJobId

public final java.lang.String getJobId()

Returns the job id. This method must not return null string.

Returns:

The job id.

Since:

0.1.0

getJobServiceId

public final java.lang.String getJobServiceId()

Returns the job service id. This method must not return null string.

Returns:

The job service id.

Since:

0.1.0

getJobParameter

public final JobParam getJobParameter()

Returns the job parameter.

Returns:

The job parameter.

Since:

0.1.0