ScheduledJob (broadleaf-jobs-events 2.0.3-SNAPSHOT API)

All Known Implementing Classes:

ScheduledJobImpl
```
public interface ScheduledJob
```
Represents a scheduled job for the system to execute. Can be a single use or repeatable job.

Author:

Jeff Fischer

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getCron()` A cron expression used to drive the schedule for the job execution.
`Map<String,ScheduledJobDetail>`	`getDetails()` Collection of detailed information for the job
`Boolean`	`getEnabled()` Whether the job is available for execution.
`Boolean`	`getExecuted()` Whether or not the job has been executed
`Long`	`getId()`
`String`	`getName()` The recognizable name for the job
`Date`	`getTargetDate()` The date on which a single use job should execute
`String`	`getType()` An arbitrary string representing the identity of this job
`Date`	`getUpdated()` The date on which the status of the job changed.
`void`	`setCron(String cron)`
`void`	`setDetails(Map<String,ScheduledJobDetail> details)`
`void`	`setEnabled(Boolean enabled)`
`void`	`setExecuted(Boolean executed)`
`void`	`setId(Long id)`
`void`	`setName(String name)`
`void`	`setTargetDate(Date targetDate)`
`void`	`setType(String type)`
`void`	`setUpdated(Date updated)`

- Method Detail
  - getId
```
Long getId()
```
  - setId
```
void setId(Long id)
```
  - getType
```
String getType()
```
    An arbitrary string representing the identity of this job
    
    Returns:
  - setType
```
void setType(String type)
```
  - getEnabled
```
Boolean getEnabled()
```
    Whether the job is available for execution. Not enabled jobs will not fire.
    
    Returns:
  - setEnabled
```
void setEnabled(Boolean enabled)
```
  - getUpdated
```
Date getUpdated()
```
    The date on which the status of the job changed.
    
    Returns:
  - setUpdated
```
void setUpdated(Date updated)
```
  - getCron
```
String getCron()
```
    A cron expression used to drive the schedule for the job execution. Used Quartz cron syntax http://www.quartz-scheduler.org/documentation/quartz-1.x/tutorials/crontrigger
    
    Returns:
  - setCron
```
void setCron(String cron)
```
  - getDetails
```
Map<String,ScheduledJobDetail> getDetails()
```
    Collection of detailed information for the job
    
    Returns:
  - setDetails
```
void setDetails(Map<String,ScheduledJobDetail> details)
```
  - getName
```
String getName()
```
    The recognizable name for the job
    
    Returns:
  - setName
```
void setName(String name)
```
  - getTargetDate
```
Date getTargetDate()
```
    The date on which a single use job should execute
    
    Returns:
  - setTargetDate
```
void setTargetDate(Date targetDate)
```
  - getExecuted
```
Boolean getExecuted()
```
    Whether or not the job has been executed
    
    Returns:
  - setExecuted
```
void setExecuted(Boolean executed)
```

Interface ScheduledJob

Method Summary

Method Detail

getId

setId

getType

setType

getEnabled

setEnabled

getUpdated

setUpdated

getCron

setCron

getDetails

setDetails

getName

setName

getTargetDate

setTargetDate

getExecuted

setExecuted