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

This interface is used to manage the collection of document data and enable it to be rendered. It leverages many of the features of the WebBean and ObjectBean interfaces. It reuses the ObjectBean interface to allow a document to: (a) be retrieved by name (and with wildcard) (b) retrieve its parent folder bean.

The main methods it provides in this interface are:

Document execution settings: Users can set the message ID, state ID and synchronous nature of the request. Users can also have the document directly saved in the Inbox and control whether server-side caches are used and updated or not used at all.
In-memory HTML caching: If the application builder wants to hold a Document Bean in the user's session or the application context, it may do so as a way of caching the results. If done in this manner, the document data need not be transformed with every request to transform, but only when the document is retrieved from the Intelligence Server. In this way, the Document Bean may be instructed on when to release its XML and re-execute the document. This is done using a simple expiration time period, in hours.
Access the underlying reports of the document

Event handler: com.microstrategy.web.beans.EnumEventHandlerTypes.HANDLER_TYPE_DOCUMENT (32)

browseEvent
event for browsing a given object.			1001	EnumObjectBeanEvents.OBJECT_EVENT_BROWSE
	*objectID	objectID -- argument using for browsing objects.	1001	EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_OBJECT_ID
	executionFlags	flags -- integer argument specifying the flags (from `EnumDSSXMLObjectFlags` ) to be used while performing object browse operations.	1003	EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_FlAGS
cancelRepromptRequestEvent
Specifies an event to cancel the request.			32006	EnumDocumentBeanEvents.DOCUMENT_EVENT_CANCEL_REPROMPT_REQUEST
cancelRequestEvent
Specifies an event to cancel the request.			32003	EnumDocumentBeanEvents.DOCUMENT_EVENT_CANCEL_REQUEST
ExecuteDocument
Specifies an event to execute a Document. The possible parameters that can be sent in are `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_MESSAGE_ID` `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_DOCUMENT_ID` `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_EXECUTION_FLAGS`			32001	EnumDocumentBeanEvents.DOCUMENT_EVENT_EXECUTE_DOCUMENT
	documentID	objectID -- argument using for browsing objects.	1001	EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_OBJECT_ID
	documentName	objectName	1004	EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_OBJECT_NAME
	elementsPromptAnswers	Specifies an argument for the new prompt answer for `WebElementsPrompt` in document drilling.	32339	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER
	executionFlags	Specifies an argument for the object id of a Document.	32201	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_EXECUTION_FLAGS
	linkAnswers		32351	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_LINK_ANSWERS
	messageID	Specifies an argument for the message id of a Document instance.	32202	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_MESSAGE_ID
	objectsPromptAnswers	Specifies an argument for the new prompt answer for `WebObjectsPrompt` in document drilling.	32350	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER
	originMessageID	Specifies an argument for the original document message id in document drilling.	32337	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID
	promptAnswerMode	An integer prompt answer mode from `EnumWebPromptAnswerMode`	32352	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION
	promptsAnswerXML	Specifies an argument for the original document's prompt answer XML in document drilling.	32338	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML
	valuePromptAnswers	Specifies an argument for the new prompt answer for `WebConstantPrompt` in document drilling.	32349	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER
initializeFromSchedule
Specifies an event to initialize the document bean using a schedule. `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_TRIGGER_ID` `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_TARGET_ID`			32007	EnumDocumentBeanEvents.DOCUMENT_EVENT_INITIALIZE_FROM_SCHEDULE
	*triggerID	String argument indicating the trigger to be used.	32203	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_TRIGGER_ID
	saveToInbox	Specifies whether to save the message to inbox.	32317	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SAVE_TO_INBOX
	targetID	The target document ID for the schedule using which a document can be initialized	32315	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_TARGET_ID
initializeFromSubscription
Specifies an event to initialize the document bean using a subscription. `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_TRIGGER_ID` `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_TARGET_ID`			32008	EnumDocumentBeanEvents.DOCUMENT_EVENT_INITIALIZE_FROM_SUBSCRIPTION
	*_subscriptionID	The subscription ID for the subscription using which a document can be initialized	32316	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ID
	saveToInbox	Specifies whether to save the message to inbox.	32317	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SAVE_TO_INBOX
refreshDocument
Event for refreshing a report.			32310	EnumDocumentBeanEvents.DOCUMENT_EVENT_REFRESH
	fresh	Argument indicating whether the document to be executed with fresh-execution related execution flags.	32312	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_REEXECUTE_FRESH
	rePrompt	Reprompting option for refreshing a report.	32311	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_REPROMPT
saveEmailSubscriptionEvent
event for saving an email subsription. `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_ID` `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES` `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_TRIGGER_ID` `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_EMAIL_SUBJECT` `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW` `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE`			32005	EnumDocumentBeanEvents.DOCUMENT_EVENT_SAVE_SUBSCRIPTION
	*triggerID	String argument indicating the trigger to be used.	32203	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_TRIGGER_ID
	addressID	String argument indicating the address ID.	32305	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_ID
	addressValues	String argument indicating the physical addresses to be used for subscription.	32306	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES
	cmsg	Message to be saved along with the email subscription	32314	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE
	deviceID	String argument indicating the deviceID.	32307	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_DEVICE_ID
	emailSubject	String argument indicating the email subject to be used for subscription.	32308	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_EMAIL_SUBJECT
	locKey	Location key for scheduled file and print export	32330	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_LOCATION_KEY
	sendNow	String argument indicating sendnow property for subscription.	32309	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW
	zip	Specifies an argument for subscription zip.	32341	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ZIP
saveFileSubscriptionEvent
Specifies an event to save subscription to a file.			32020	EnumDocumentBeanEvents.DOCUMENT_EVENT_SAVE_FILE_SUBSCRIPTION
	*locKey	Location key for scheduled file and print export	32330	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_LOCATION_KEY
	*triggerID	String argument indicating the trigger to be used.	32203	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_TRIGGER_ID
	addressValues	String argument indicating the physical addresses to be used for subscription.	32306	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES
	cmsg	Message to be saved along with the email subscription	32314	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE
	fileName	File name for scheduled file export	32331	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_FILE_NAME
	notifyAddressID	Subscription notification is sent to this existing address.	32345	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID
	notifyAddressValue	Subscription notification is sent to this new address. If this is supplied, it takes precedence over `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID`.	32346	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_VALUE
	notifyDeviceID	Specifies an argument for subscription device id.	32347	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_DEVICE_ID
	sendNow	String argument indicating sendnow property for subscription.	32309	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW
	zip	Specifies an argument for subscription zip.	32341	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ZIP
savePrintSubscriptionEvent
Specifies an event to print subscription.			32021	EnumDocumentBeanEvents.DOCUMENT_EVENT_SAVE_PRINT_SUBSCRIPTION
	*locKey	Location key for scheduled file and print export	32330	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_LOCATION_KEY
	*triggerID	String argument indicating the trigger to be used.	32203	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_TRIGGER_ID
	addressValue	String argument indicating the physical addresses to be used for subscription.	32306	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES
	cmsg	Message to be saved along with the email subscription	32314	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE
	copies	Specifies an argument for the number of copies.	32332	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_COPIES
	isCollated	Specifies an argument indicating whether it is collated in printer.	32334	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_IS_COLLATED
	isPortrait	Specifies an argument indicating whether it is a portait in printer.	32333	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_IS_PORTRAIT
	notifyAddressID	Subscription notification is sent to this existing address.	32345	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID
	notifyAddressValue	Subscription notification is sent to this new address. If this is supplied, it takes precedence over `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID`.	32346	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_VALUE
	notifyDeviceID	Specifies an argument for subscription device id.	32347	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_DEVICE_ID
	printAll	Specifies an argument whether to print all subscriptions.	32348	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_PRINT_ALL
	rangeEnd	Specifies an argument for range end in printing.	32336	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_RANGE_END
	rangeStart	Specifies an argument for range start in printing.	32335	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_RANGE_START
	sendNow	String argument indicating sendnow property for subscription.	32309	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW
saveScheduleEvent
event for saving the schedule. `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_TRIGGER_ID` `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SCHEDULE_REUSE_MESSAGE` `EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SCHEDULE_OVERWRITE`			32004	EnumDocumentBeanEvents.DOCUMENT_EVENT_SAVE_SCHEDULE
	*triggerID	String argument indicating the trigger to be used.	32203	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_TRIGGER_ID
	overWrite	Argument indicating whether to overwrite a current schedule, if existing.	32313	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SCHEDULE_OVERWRITE
	reuseMsg	Integer argument indicating whether the message should be reused while scheduling. A value of 1 indicates that it should be reused.	32304	EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SCHEDULE_REUSE_MESSAGE
SaveToInbox
Specifies an event to save the a Document message into Inbox.			32002	EnumDocumentBeanEvents.DOCUMENT_EVENT_SAVE_TO_INBOX