Class ecm.model.AsyncTaskSchedule
Extends
ecm.model._ModelObject.
Represents a schedule used for scheduling tasks with the ECM TaskManager. It can be used to do calendar or
fixed-interval scheduling. Calendar type scheduling is based on J2EE specification for timer services. You
can read the the javadoc here: http://docs.oracle.com/javaee/6/api/javax/ejb/ScheduleExpression.html.
Fixed-interval scheduling is used for scheduling on a specific time period (a date represented in
milliseconds) and can reoccur on a fixed interval until an end time. Only one type of schedule should be
specified. If both are specified, the calendar scheduling will take precedence.
Defined in: <ecm\model\AsyncTaskSchedule.js>.
Constructor Summary
| Constructor Attributes | Constructor Name and Description |
|---|---|
Field Summary
| Field Attributes | Field Name and Description |
|---|---|
|
Calendar type scheduling is used to perform scheduling based on a calendar dates and times.
|
|
|
The description of the task that will be scheduled.
|
|
|
The email address of the task that will be scheduled.
|
|
|
A fixed interval schedule requires an initial start time represented by a date in milliseconds.
|
|
|
Whether the task that will be scheduled will reoccur or repeat.
|
|
|
The mode for this schedule.
|
|
|
The name of the task that will be scheduled.
|
|
|
If authentication for the task is required, the password of the task that will be scheduled.
|
|
|
A single schedule only runs once.
|
|
|
If authentication for the task is required, the userId of the task that will be scheduled.
|
- Fields borrowed from class ecm.model._ModelObject:
- categorization, id, nameFilter, pane, status, type
Field Detail
calendarSchedule
Calendar type scheduling is used to perform scheduling based on a calendar dates and times. It is based on
J2EE specification for timer services. You can read schedule expression javadoc here:
http://docs.oracle.com/javaee/6/api/javax/ejb/ScheduleExpression.html. A brief description is listed below
for each variable but refer to the prior link for more information.
description
The description of the task that will be scheduled. The description is optional.
emailAddress
The email address of the task that will be scheduled. The email address is optional but is used for
notification purposes such as when the task starts, completes, or fails.
fixedIntervalSchedule
A fixed interval schedule requires an initial start time represented by a date in milliseconds. If it is set
to reoccur (optional), it will continue to repeat itself based on the repeat cycle (which is in
milliseconds). It will continue to repeat until the end time specified. For example, a task can be set to
start at a specific day at 6 PM. It can be set to reoccur every hour (represented in milliseconds: 60 x 60 x
1000) and will continue to do so till end time. This type of repeated interval does not take into account day
light savings or differences in days in a month. For calendar-type scheduling, refer to the schedule below.
isRecurring
Whether the task that will be scheduled will reoccur or repeat. This must be set to true for recurring tasks
or else a number of the fixed schedule or calendar schedule values will be ignored.
mode
The mode for this schedule. It can be
- "0" - Single. This means the task will only run once.
- "1" - FixedIntervalSchedule. This means the task will reoccur on a fixed interval.
- "4" - CalendarSchedule. This means the task will reoccur based on a calendar schedule.
name
The name of the task that will be scheduled. The name is required.
password
If authentication for the task is required, the password of the task that will be scheduled. It is up to the
caller to encrypt this password before being saved. The password is optional.
singleSchedule
A single schedule only runs once. It only has an initial start time represented by a date in milliseconds.
userId
If authentication for the task is required, the userId of the task that will be scheduled. The userId is
optional.