Events reference: com.microstrategy.web.beans.ScheduleBean

Supported Bean: ScheduleBean

This bean represents an Intelligence server schedule. The important functionality this bean provides is:

creating new schedule by defining appropriate content, trigger and personalization
edit an existing schedule
delete an existing schedule

This bean can be created using WebBeanFactory.newScheduleBean() Once created, the bean needs to associated with a content and a trigger before it can be saved The content is defined using a valid report/document. This is set using ScheduleBean.setContent(String, int). The trigger to be used with this schedule is defined by adding a new trigger ID to the list retrieved using ScheduleBean.getTriggers().

Event handler: com.microstrategy.web.beans.EnumEventHandlerTypes.HANDLER_TYPE_SCHEDULE (512)

Event handler that can be associated with a Schedule Bean.

Events

cancel, deleteSchedule, saveSchedule, setScheduleState

cancel
Calls cancel on the `ScheduleBean`.			512004	EnumScheduleBeanEvents.SCHEDULE_EVENT_CANCEL
deleteSchedule
Deletes the current schedule.			512002	EnumScheduleBeanEvents.SCHEDULE_EVENT_DELETE
	*objectID	Argument specifying the content object ID.	512003	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_CONTENT_OBJECT_ID
	*objectType	Argument specifying the content object type.	512004	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE
	*triggerID	Argument specifying the trigger ID.	512005	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_TRIGGER_ID
saveSchedule
Saves the current schedule. This accepts all arguments that are accepted by `EnumScheduleBeanEvents.SCHEDULE_EVENT_SET_STATE`.			512001	EnumScheduleBeanEvents.SCHEDULE_EVENT_SAVE
	edit	Argument specifying that the bean represents an existing schedule.	512007	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_EDIT_MODE
	execFlags	execution flags.	5120013	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_EXECUTION_FLAGS
	mobile		5120016	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_MOBILE
	objectID	Argument specifying the content object ID.	512003	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_CONTENT_OBJECT_ID
	objectType	Argument specifying the content object type.	512004	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE
	overwrite	Argument specifying whether or not to overwrite an existing schedule that was created with the same content and trigger.	512006	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_OVERWRITE_EXISTING
	reuse	Indicates whether the messageID should be reused or new messages should be created with each execution.	512008	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_REUSE_MESSAGE
	stateID	Argument specifying the state ID.	512002	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_STATE_ID
	triggerID	Argument specifying the trigger ID.	512005	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_TRIGGER_ID
	vmode	Indicates the view mode of the report.	512009	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_VIEW_MODE
setScheduleState
Initializes the state of the Schedule bean. The content parameters are used only if the content is not already set.			512003	EnumScheduleBeanEvents.SCHEDULE_EVENT_SET_STATE
	edit	Argument specifying that the bean represents an existing schedule.	512007	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_EDIT_MODE
	elementsPromptAnswers	Plain element prompt answer.	5120012	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER
	messageID	Argument specifying the message ID.	512001	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_MESSAGE_ID
	mobile		5120016	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_MOBILE
	objectID	Argument specifying the content object ID.	512003	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_CONTENT_OBJECT_ID
	objectsPromptAnswers	Plain objects prompt answer.	5120015	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER
	objectType	Argument specifying the content object type.	512004	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE
	originMessageID	Origin message ID.	5120010	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID
	overwrite	Argument specifying whether or not to overwrite an existing schedule that was created with the same content and trigger.	512006	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_OVERWRITE_EXISTING
	promptsAnswerXML	Origin short answer XML.	5120011	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML
	reuse	Indicates whether the messageID should be reused or new messages should be created with each execution.	512008	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_REUSE_MESSAGE
	stateID	Argument specifying the state ID.	512002	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_STATE_ID
	triggerID	Argument specifying the trigger ID.	512005	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_TRIGGER_ID
	valuePromptAnswers	Plain value prompt answer.	5120014	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER
	vmode	Indicates the view mode of the report.	512009	EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_VIEW_MODE

Notes

* denotes required field.