ERQSJobDescription (Project Wonder Reference Documentation)

All Known Implementing Classes:

ERQSJobDescription4Test
```
public interface ERQSJobDescription
```
This framework doesn't embed an EOModel so it let you free to implement your own entity and enterprise objects.
As a result, your EOs must implement this interface.
Notice that a ERQSJobDescription object is not considered as an EO if the method isEnterpriseObject returns false.

Author:

Philippe Rabier

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`classPath()` Object that will be instantiated by the scheduler to make its job.
`String`	`cronExpression()` The cron expression allows you to define a period where the job is triggered. If the cron expression returns null, the job runs once immediately.
`com.webobjects.foundation.NSTimestamp`	`firstExecutionDate()` A getter that returns the first execution date of the job.
`String`	`group()` If group() return null or an empty string, Scheduler.DEFAULT_GROUP is used instead.
`boolean`	`isEnterpriseObject()` Very important: tells the supervisor and the listener if the current object is a EO.
`String`	`jobDescription()` The description is optional.
`Map<String,Object>`	`jobInfos()` jobInfos is used to pass information when the job will run.
`com.webobjects.foundation.NSTimestamp`	`lastExecutionDate()` A getter that returns the last execution date of the job.
`String`	`name()` The name and the group are very important because the scheduler retrieve jobs based on the name and group.
`NSArray<String>`	`recipients(boolean executionSucceeded)` If you set up the listener to send email when the job is done, recipient() will be used to send emails.
`void`	`setFirstExecutionDate(com.webobjects.foundation.NSTimestamp firstExecutionDate)`
`void`	`setLastExecutionDate(com.webobjects.foundation.NSTimestamp lastExecutionDate)`
`void`	`setNextExecutionDate(com.webobjects.foundation.NSTimestamp nextExecutionDate)` A setter to save the next execution date.

- Method Detail
  - name
```
String name()
```
    The name and the group are very important because the scheduler retrieve jobs based on the name and group.
    It can't be null.
    
    Returns:
    
    job name
  - group
```
String group()
```
    If group() return null or an empty string, Scheduler.DEFAULT_GROUP is used instead.
    
    Returns:
    
    group
  - cronExpression
```
String cronExpression()
```
    The cron expression allows you to define a period where the job is triggered.
    If the cron expression returns null, the job runs once immediately. See the documentation: http://www.quartz-scheduler.org/docs/tutorials/crontrigger.html
    
    Returns:
    
    cron expression
  - jobDescription
```
String jobDescription()
```
    The description is optional. It's used only when displaying the dashboard so it can give you additional informations useful for you.
    
    Returns:
    
    a job description
  - classPath
```
String classPath()
```
    Object that will be instantiated by the scheduler to make its job. Of course, very important ;-)
    
    Returns:
    
    a class path
  - recipients
```
NSArray<String> recipients(boolean executionSucceeded)
```
    If you set up the listener to send email when the job is done, recipient() will be used to send emails.
    Depending on the value of executionSucceeded, you can return a different list of recipients.
    
    Parameters:
    
    executionSucceeded - true if the job ran successfully.
    
    Returns:
    
    array of recipients
  - isEnterpriseObject
```
boolean isEnterpriseObject()
```
    Very important: tells the supervisor and the listener if the current object is a EO. If yes, it must have a global ID and we assume that it derives from ERXGenericRecord.
    
    Returns:
    
    true if it's an EO
    
    See Also:
    
    buildTriggerForJob
  - lastExecutionDate
```
com.webobjects.foundation.NSTimestamp lastExecutionDate()
```
    A getter that returns the last execution date of the job.
    
    Returns:
    
    last execution date
  - setLastExecutionDate
```
void setLastExecutionDate(com.webobjects.foundation.NSTimestamp lastExecutionDate)
```
  - firstExecutionDate
```
com.webobjects.foundation.NSTimestamp firstExecutionDate()
```
    A getter that returns the first execution date of the job.
    
    Returns:
    
    last execution date
  - setFirstExecutionDate
```
void setFirstExecutionDate(com.webobjects.foundation.NSTimestamp firstExecutionDate)
```
  - setNextExecutionDate
```
void setNextExecutionDate(com.webobjects.foundation.NSTimestamp nextExecutionDate)
```
    A setter to save the next execution date.
    Notice that there is no getter because the framework doesn't need it to run. But it's a good idea to code it.
    
    Parameters:
    
    nextExecutionDate -
  - jobInfos
```
Map<String,Object> jobInfos()
```
    jobInfos is used to pass information when the job will run.
    All key/value pair will be given to the job.

Interface ERQSJobDescription

Method Summary

Method Detail

name

group

cronExpression

jobDescription

classPath

recipients

isEnterpriseObject

lastExecutionDate

setLastExecutionDate

firstExecutionDate

setFirstExecutionDate

setNextExecutionDate

jobInfos