public interface

EnumDocumentBeanEvents

implements EnumObjectBeanEvents
com.microstrategy.web.beans.EnumDocumentBeanEvents

Class Overview

Constants for document bean events

Summary

Constants
int DOCUMENT_EVENT_ARGUMENT_COPIES Specifies an argument for the number of copies.
int DOCUMENT_EVENT_ARGUMENT_DOCUMENT_ID Specifies an argument for the object id of a Document.
int DOCUMENT_EVENT_ARGUMENT_DOCUMENT_NAME Specifies an argument for the document name.
int DOCUMENT_EVENT_ARGUMENT_EXECUTION_FLAGS Specifies an argument for the object id of a Document.
int DOCUMENT_EVENT_ARGUMENT_FILE_NAME File name for scheduled file export
int DOCUMENT_EVENT_ARGUMENT_IS_COLLATED Specifies an argument indicating whether it is collated in printer.
int DOCUMENT_EVENT_ARGUMENT_IS_PORTRAIT Specifies an argument indicating whether it is a portait in printer.
int DOCUMENT_EVENT_ARGUMENT_LINK_ANSWERS
int DOCUMENT_EVENT_ARGUMENT_LOCATION_KEY Location key for scheduled file and print export
int DOCUMENT_EVENT_ARGUMENT_MESSAGE_ID Specifies an argument for the message id of a Document instance.
int DOCUMENT_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID Specifies an argument for the original document message id in document drilling.
int DOCUMENT_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML Specifies an argument for the original document's prompt answer XML in document drilling.
int DOCUMENT_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER Specifies an argument for the new prompt answer for WebElementsPrompt in document drilling.
int DOCUMENT_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER Specifies an argument for the new prompt answer for WebObjectsPrompt in document drilling.
int DOCUMENT_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER Specifies an argument for the new prompt answer for WebConstantPrompt in document drilling.
int DOCUMENT_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION An integer prompt answer mode from EnumWebPromptAnswerMode
int DOCUMENT_EVENT_ARGUMENT_RANGE_END Specifies an argument for range end in printing.
int DOCUMENT_EVENT_ARGUMENT_RANGE_START Specifies an argument for range start in printing.
int DOCUMENT_EVENT_ARGUMENT_REEXECUTE_FRESH Argument indicating whether the document to be executed with fresh-execution related execution flags.
int DOCUMENT_EVENT_ARGUMENT_REPROMPT Reprompting option for refreshing a report.
int DOCUMENT_EVENT_ARGUMENT_SAVE_TO_INBOX Specifies whether to save the message to inbox.
int DOCUMENT_EVENT_ARGUMENT_SCHEDULE_OVERWRITE Argument indicating whether to overwrite a current schedule, if existing.
int DOCUMENT_EVENT_ARGUMENT_SCHEDULE_REUSE_MESSAGE Integer argument indicating whether the message should be reused while scheduling.
int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_ID String argument indicating the address ID.
int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES String argument indicating the physical addresses to be used for subscription.
int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE Message to be saved along with the email subscription
int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_DEVICE_ID String argument indicating the deviceID.
int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_EMAIL_SUBJECT String argument indicating the email subject to be used for subscription.
int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ID The subscription ID for the subscription using which a document can be initialized
int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID Subscription notification is sent to this existing address.
int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_VALUE Subscription notification is sent to this new address.
int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_DEVICE_ID Specifies an argument for subscription device id.
int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_PRINT_ALL Specifies an argument whether to print all subscriptions.
int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW String argument indicating sendnow property for subscription.
int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ZIP Specifies an argument for subscription zip.
int DOCUMENT_EVENT_ARGUMENT_TARGET_ID The target document ID for the schedule using which a document can be initialized
int DOCUMENT_EVENT_ARGUMENT_TRIGGER_ID String argument indicating the trigger to be used.
int DOCUMENT_EVENT_CANCEL_REPROMPT_REQUEST Specifies an event to cancel the request.
int DOCUMENT_EVENT_CANCEL_REQUEST Specifies an event to cancel the request.
int DOCUMENT_EVENT_EXECUTE_DOCUMENT Specifies an event to execute a Document.
int DOCUMENT_EVENT_INITIALIZE_FROM_SCHEDULE This constant is deprecated. Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Hence please use DOCUMENT_EVENT_INITIALIZE_FROM_SUBSCRIPTION instead.
int DOCUMENT_EVENT_INITIALIZE_FROM_SUBSCRIPTION Specifies an event to initialize the document bean using a subscription.
int DOCUMENT_EVENT_REFRESH Event for refreshing a report.
int DOCUMENT_EVENT_SAVE_FILE_SUBSCRIPTION Specifies an event to save subscription to a file.
int DOCUMENT_EVENT_SAVE_PRINT_SUBSCRIPTION Specifies an event to print subscription.
int DOCUMENT_EVENT_SAVE_SCHEDULE This constant is deprecated. Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Please use the events defined on the SubscriptionBean instead.
int DOCUMENT_EVENT_SAVE_SUBSCRIPTION event for saving an email subsription.
int DOCUMENT_EVENT_SAVE_TO_INBOX Specifies an event to save the a Document message into Inbox.
[Expand]
Inherited Constants
From interface com.microstrategy.web.beans.EnumObjectBeanEvents

Constants

public static final int DOCUMENT_EVENT_ARGUMENT_COPIES

Specifies an argument for the number of copies.

Constant Value: 32332 (0x00007e4c)

public static final int DOCUMENT_EVENT_ARGUMENT_DOCUMENT_ID

Specifies an argument for the object id of a Document.

Constant Value: 1001 (0x000003e9)

public static final int DOCUMENT_EVENT_ARGUMENT_DOCUMENT_NAME

Specifies an argument for the document name.

Constant Value: 1004 (0x000003ec)

public static final int DOCUMENT_EVENT_ARGUMENT_EXECUTION_FLAGS

Specifies an argument for the object id of a Document.

Constant Value: 32201 (0x00007dc9)

public static final int DOCUMENT_EVENT_ARGUMENT_FILE_NAME

File name for scheduled file export

Constant Value: 32331 (0x00007e4b)

public static final int DOCUMENT_EVENT_ARGUMENT_IS_COLLATED

Specifies an argument indicating whether it is collated in printer.

Constant Value: 32334 (0x00007e4e)

public static final int DOCUMENT_EVENT_ARGUMENT_IS_PORTRAIT

Specifies an argument indicating whether it is a portait in printer.

Constant Value: 32333 (0x00007e4d)

public static final int DOCUMENT_EVENT_ARGUMENT_LINK_ANSWERS

Constant Value: 32351 (0x00007e5f)

public static final int DOCUMENT_EVENT_ARGUMENT_LOCATION_KEY

Location key for scheduled file and print export

Constant Value: 32330 (0x00007e4a)

public static final int DOCUMENT_EVENT_ARGUMENT_MESSAGE_ID

Specifies an argument for the message id of a Document instance.

Constant Value: 32202 (0x00007dca)

public static final int DOCUMENT_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

Specifies an argument for the original document message id in document drilling.

Constant Value: 32337 (0x00007e51)

public static final int DOCUMENT_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

Specifies an argument for the original document's prompt answer XML in document drilling.

Constant Value: 32338 (0x00007e52)

public static final int DOCUMENT_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

Specifies an argument for the new prompt answer for WebElementsPrompt in document drilling.

Constant Value: 32339 (0x00007e53)

public static final int DOCUMENT_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER

Specifies an argument for the new prompt answer for WebObjectsPrompt in document drilling.

Constant Value: 32350 (0x00007e5e)

public static final int DOCUMENT_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

Specifies an argument for the new prompt answer for WebConstantPrompt in document drilling.

Constant Value: 32349 (0x00007e5d)

public static final int DOCUMENT_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

An integer prompt answer mode from EnumWebPromptAnswerMode

Constant Value: 32352 (0x00007e60)

public static final int DOCUMENT_EVENT_ARGUMENT_RANGE_END

Specifies an argument for range end in printing.

Constant Value: 32336 (0x00007e50)

public static final int DOCUMENT_EVENT_ARGUMENT_RANGE_START

Specifies an argument for range start in printing.

Constant Value: 32335 (0x00007e4f)

public static final int DOCUMENT_EVENT_ARGUMENT_REEXECUTE_FRESH

Argument indicating whether the document to be executed with fresh-execution related execution flags.

Constant Value: 32312 (0x00007e38)

public static final int DOCUMENT_EVENT_ARGUMENT_REPROMPT

Reprompting option for refreshing a report.

Constant Value: 32311 (0x00007e37)

public static final int DOCUMENT_EVENT_ARGUMENT_SAVE_TO_INBOX

Specifies whether to save the message to inbox.

Constant Value: 32317 (0x00007e3d)

public static final int DOCUMENT_EVENT_ARGUMENT_SCHEDULE_OVERWRITE

Argument indicating whether to overwrite a current schedule, if existing.

Constant Value: 32313 (0x00007e39)

public static final int DOCUMENT_EVENT_ARGUMENT_SCHEDULE_REUSE_MESSAGE

Integer argument indicating whether the message should be reused while scheduling. A value of 1 indicates that it should be reused.

Constant Value: 32304 (0x00007e30)

public static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_ID

String argument indicating the address ID.

Constant Value: 32305 (0x00007e31)

public static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES

String argument indicating the physical addresses to be used for subscription.

Constant Value: 32306 (0x00007e32)

public static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE

Message to be saved along with the email subscription

Constant Value: 32314 (0x00007e3a)

public static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_DEVICE_ID

String argument indicating the deviceID.

Constant Value: 32307 (0x00007e33)

public static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_EMAIL_SUBJECT

String argument indicating the email subject to be used for subscription.

Constant Value: 32308 (0x00007e34)

public static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ID

The subscription ID for the subscription using which a document can be initialized

Constant Value: 32316 (0x00007e3c)

public static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID

Subscription notification is sent to this existing address.

Constant Value: 32345 (0x00007e59)

public static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_VALUE

Subscription notification is sent to this new address. If this is supplied, it takes precedence over DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID.

Constant Value: 32346 (0x00007e5a)

public static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_DEVICE_ID

Specifies an argument for subscription device id.

Constant Value: 32347 (0x00007e5b)

public static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_PRINT_ALL

Specifies an argument whether to print all subscriptions.

Constant Value: 32348 (0x00007e5c)

public static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW

String argument indicating sendnow property for subscription.

Constant Value: 32309 (0x00007e35)

public static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ZIP

Specifies an argument for subscription zip.

Constant Value: 32341 (0x00007e55)

public static final int DOCUMENT_EVENT_ARGUMENT_TARGET_ID

The target document ID for the schedule using which a document can be initialized

Constant Value: 32315 (0x00007e3b)

public static final int DOCUMENT_EVENT_ARGUMENT_TRIGGER_ID

String argument indicating the trigger to be used.

Constant Value: 32203 (0x00007dcb)

public static final int DOCUMENT_EVENT_CANCEL_REPROMPT_REQUEST

Specifies an event to cancel the request.

Constant Value: 32006 (0x00007d06)

public static final int DOCUMENT_EVENT_CANCEL_REQUEST

Specifies an event to cancel the request.

Constant Value: 32003 (0x00007d03)

public static final int DOCUMENT_EVENT_EXECUTE_DOCUMENT

Specifies an event to execute a Document. The possible parameters that can be sent in are

Constant Value: 32001 (0x00007d01)

public static final int DOCUMENT_EVENT_INITIALIZE_FROM_SCHEDULE

This constant is deprecated.
Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Hence please use DOCUMENT_EVENT_INITIALIZE_FROM_SUBSCRIPTION instead.

Specifies an event to initialize the document bean using a schedule.

Constant Value: 32007 (0x00007d07)

public static final int DOCUMENT_EVENT_INITIALIZE_FROM_SUBSCRIPTION

Specifies an event to initialize the document bean using a subscription.

Constant Value: 32008 (0x00007d08)

public static final int DOCUMENT_EVENT_REFRESH

Event for refreshing a report.

Constant Value: 32310 (0x00007e36)

public static final int DOCUMENT_EVENT_SAVE_FILE_SUBSCRIPTION

Specifies an event to save subscription to a file.

Constant Value: 32020 (0x00007d14)

public static final int DOCUMENT_EVENT_SAVE_PRINT_SUBSCRIPTION

Specifies an event to print subscription.

Constant Value: 32021 (0x00007d15)

public static final int DOCUMENT_EVENT_SAVE_SCHEDULE

This constant is deprecated.
Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Please use the events defined on the SubscriptionBean instead.

Constant Value: 32004 (0x00007d04)

public static final int DOCUMENT_EVENT_SAVE_TO_INBOX

Specifies an event to save the a Document message into Inbox.

Constant Value: 32002 (0x00007d02)