Class ecm.widget.taskManager.CalendarScheduler

Extends dijit.layout.ContentPane.
The scheduler pane to perform calendar scheduling for an asynchronous task. This pane will allow users to set tasks to run now, run once at a later start time, or can run reoccuringly with a calendar schedule such as once every Monday or once every month. By setting the values accordingly and calling getSchedule(), an ecm.model.AsyncTaskSchedule will be created with all the appropriate calendar schedule portion filled out. This portion will match the schedule expression set in the J2EE specification for timer services. Refer to AsyncTaskSchedule for more detailed information on the schedule.
Defined in: <ecm\widget\taskManager\CalendarScheduler.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.taskManager.CalendarScheduler()

Method Summary

Method Attributes	Method Name and Description
	getEndDateSet() Returns the end date set.
	getSchedule() Returns a ecm.model.AsyncTaskSchedule object with all the appropriate calendar schedule portion filled out.
	getWeekdaysSelected() Returns a comma-delimited list of the weekdays selected in this scheduler pane.
	onChange() Event invoked when an input on a field change
	setEnableRunAtSchedule(enable) Enable or disables all the widgets for the run at schedule radio selection
	setEnableRunOnce(enable) Enable or disables all the widgets for the run once radio selection
	validate() Returns true if values are provided for all the necessary inputs.

Constructor Detail

ecm.widget.taskManager.CalendarScheduler()

Since:: 2.0.3

Method Detail

getEndDateSet()

Returns the end date set. If an actual end date was set, that date value will be returned.

getSchedule()

Returns a ecm.model.AsyncTaskSchedule object with all the appropriate calendar schedule portion filled out. This portion will match the schedule expression set in the J2EE specification for timer services. Refer to AsyncTaskSchedule for more detailed information on the schedule.

getWeekdaysSelected()

Returns a comma-delimited list of the weekdays selected in this scheduler pane. 0 represents Sunday and 6 represents Saturday. For example if Sunday and Tuesday are selected, 0,2 will be returned.

onChange()

Event invoked when an input on a field change

setEnableRunAtSchedule(enable)

Enable or disables all the widgets for the run at schedule radio selection

Parameters:
enable: True to enable and false to disable the widgets

setEnableRunOnce(enable)

Enable or disables all the widgets for the run once radio selection

Parameters:
enable: True to enable and false to disable the widgets

validate()

Returns true if values are provided for all the necessary inputs.