ERQSJobDescription4Test (Project Wonder Reference Documentation)

java.lang.Object
- er.quartzscheduler.foundation.ERQSJobDescription4Test

All Implemented Interfaces:: ERQSJobDescription

public class ERQSJobDescription4Test
extends Object
implements ERQSJobDescription

Field Summary

Fields
Modifier and Type Field and Description

static String DEF_GROUP_NAME

static String DEF_JOB_NAME

static String EMAIL_WHEN_FAILED

static String EMAIL_WHEN_SUCCEDED

Fields
Modifier and Type	Field and Description
`static String`	`DEF_GROUP_NAME`
`static String`	`DEF_JOB_NAME`
`static String`	`EMAIL_WHEN_FAILED`
`static String`	`EMAIL_WHEN_SUCCEDED`

Constructor Summary

Constructors
Constructor and Description

ERQSJobDescription4Test()

Constructors
Constructor and Description
`ERQSJobDescription4Test()`

Method Summary

All Methods Instance Methods Concrete 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.
`com.webobjects.foundation.NSTimestamp`	`nextExecutionDate()`
`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`	`setClassPath(String classPath)`
`void`	`setCronExpression(String cronExpression)`
`void`	`setFirstExecutionDate(com.webobjects.foundation.NSTimestamp firstExecutionDate)`
`void`	`setGroup(String group)`
`void`	`setIsEnterpriseObject(boolean b)`
`void`	`setJobInfos(Map<String,Object> aMap)`
`void`	`setLastExecutionDate(com.webobjects.foundation.NSTimestamp lastExecutionDate)`
`void`	`setName(String name)`
`void`	`setNextExecutionDate(com.webobjects.foundation.NSTimestamp nextExecutionDate)` A setter to save the next execution date.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEF_JOB_NAME
```
public static final String DEF_JOB_NAME
```
    See Also:
    
    Constant Field Values
  - DEF_GROUP_NAME
```
public static final String DEF_GROUP_NAME
```
    See Also:
    
    Constant Field Values
  - EMAIL_WHEN_SUCCEDED
```
public static final String EMAIL_WHEN_SUCCEDED
```
    See Also:
    
    Constant Field Values
  - EMAIL_WHEN_FAILED
```
public static final String EMAIL_WHEN_FAILED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ERQSJobDescription4Test
```
public ERQSJobDescription4Test()
```
- Method Detail
  - classPath
```
public String classPath()
```
    Description copied from interface: ERQSJobDescription
    
    Object that will be instantiated by the scheduler to make its job. Of course, very important ;-)
    
    Specified by:
    
    classPath in interface ERQSJobDescription
    
    Returns:
    
    a class path
  - setClassPath
```
public void setClassPath(String classPath)
```
  - cronExpression
```
public String cronExpression()
```
    Description copied from interface: ERQSJobDescription
    
    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
    
    Specified by:
    
    cronExpression in interface ERQSJobDescription
    
    Returns:
    
    cron expression
  - setCronExpression
```
public void setCronExpression(String cronExpression)
```
  - group
```
public String group()
```
    Description copied from interface: ERQSJobDescription
    
    If group() return null or an empty string, Scheduler.DEFAULT_GROUP is used instead.
    
    Specified by:
    
    group in interface ERQSJobDescription
    
    Returns:
    
    group
  - setGroup
```
public void setGroup(String group)
```
  - isEnterpriseObject
```
public boolean isEnterpriseObject()
```
    Description copied from interface: ERQSJobDescription
    
    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.
    
    Specified by:
    
    isEnterpriseObject in interface ERQSJobDescription
    
    Returns:
    
    true if it's an EO
    
    See Also:
    
    buildTriggerForJob
  - setIsEnterpriseObject
```
public void setIsEnterpriseObject(boolean b)
```
  - jobDescription
```
public String jobDescription()
```
    Description copied from interface: ERQSJobDescription
    
    The description is optional. It's used only when displaying the dashboard so it can give you additional informations useful for you.
    
    Specified by:
    
    jobDescription in interface ERQSJobDescription
    
    Returns:
    
    a job description
  - name
```
public String name()
```
    Description copied from interface: ERQSJobDescription
    
    The name and the group are very important because the scheduler retrieve jobs based on the name and group.
    It can't be null.
    
    Specified by:
    
    name in interface ERQSJobDescription
    
    Returns:
    
    job name
  - setName
```
public void setName(String name)
```
  - recipients
```
public NSArray<String> recipients(boolean executionSucceeded)
```
    Description copied from interface: ERQSJobDescription
    
    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.
    
    Specified by:
    
    recipients in interface ERQSJobDescription
    
    Parameters:
    
    executionSucceeded - true if the job ran successfully.
    
    Returns:
    
    array of recipients
  - setFirstExecutionDate
```
public void setFirstExecutionDate(com.webobjects.foundation.NSTimestamp firstExecutionDate)
```
    Specified by:
    
    setFirstExecutionDate in interface ERQSJobDescription
  - firstExecutionDate
```
public com.webobjects.foundation.NSTimestamp firstExecutionDate()
```
    Description copied from interface: ERQSJobDescription
    
    A getter that returns the first execution date of the job.
    
    Specified by:
    
    firstExecutionDate in interface ERQSJobDescription
    
    Returns:
    
    last execution date
  - setLastExecutionDate
```
public void setLastExecutionDate(com.webobjects.foundation.NSTimestamp lastExecutionDate)
```
    Specified by:
    
    setLastExecutionDate in interface ERQSJobDescription
  - lastExecutionDate
```
public com.webobjects.foundation.NSTimestamp lastExecutionDate()
```
    Description copied from interface: ERQSJobDescription
    
    A getter that returns the last execution date of the job.
    
    Specified by:
    
    lastExecutionDate in interface ERQSJobDescription
    
    Returns:
    
    last execution date
  - setNextExecutionDate
```
public void setNextExecutionDate(com.webobjects.foundation.NSTimestamp nextExecutionDate)
```
    Description copied from interface: ERQSJobDescription
    
    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.
    
    Specified by:
    
    setNextExecutionDate in interface ERQSJobDescription
  - nextExecutionDate
```
public com.webobjects.foundation.NSTimestamp nextExecutionDate()
```
  - setJobInfos
```
public void setJobInfos(Map<String,Object> aMap)
```
  - jobInfos
```
public Map<String,Object> jobInfos()
```
    Description copied from interface: ERQSJobDescription
    
    jobInfos is used to pass information when the job will run.
    All key/value pair will be given to the job.
    
    Specified by:
    
    jobInfos in interface ERQSJobDescription

Class ERQSJobDescription4Test

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEF_JOB_NAME

DEF_GROUP_NAME

EMAIL_WHEN_SUCCEDED

EMAIL_WHEN_FAILED

Constructor Detail

ERQSJobDescription4Test

Method Detail

classPath

setClassPath

cronExpression

setCronExpression

group

setGroup

isEnterpriseObject

setIsEnterpriseObject

jobDescription

name

setName

recipients

setFirstExecutionDate

firstExecutionDate

setLastExecutionDate

lastExecutionDate

setNextExecutionDate

nextExecutionDate

setJobInfos

jobInfos