Package com.microstrategy.web.beans
Interface EnumDocumentBeanEvents
-
- All Superinterfaces:
EnumObjectBeanEvents
public interface EnumDocumentBeanEvents extends EnumObjectBeanEvents
Constants for document bean events- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
Fields Modifier and Type Field Description static int
DOCUMENT_EVENT_ARGUMENT_COPIES
Specifies an argument for the number of copies.static int
DOCUMENT_EVENT_ARGUMENT_DOCUMENT_ID
Specifies an argument for the object id of a Document.static int
DOCUMENT_EVENT_ARGUMENT_DOCUMENT_NAME
Specifies an argument for the document name.static int
DOCUMENT_EVENT_ARGUMENT_EXECUTION_FLAGS
Specifies an argument for the object id of a Document.static int
DOCUMENT_EVENT_ARGUMENT_FILE_NAME
File name for scheduled file exportstatic int
DOCUMENT_EVENT_ARGUMENT_IS_COLLATED
Specifies an argument indicating whether it is collated in printer.static int
DOCUMENT_EVENT_ARGUMENT_IS_PORTRAIT
Specifies an argument indicating whether it is a portait in printer.static int
DOCUMENT_EVENT_ARGUMENT_LINK_ANSWERS
static int
DOCUMENT_EVENT_ARGUMENT_LOCATION_KEY
Location key for scheduled file and print exportstatic int
DOCUMENT_EVENT_ARGUMENT_MESSAGE_ID
Specifies an argument for the message id of a Document instance.static int
DOCUMENT_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID
Specifies an argument for the original document message id in document drilling.static int
DOCUMENT_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML
Specifies an argument for the original document's prompt answer XML in document drilling.static int
DOCUMENT_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER
Specifies an argument for the new prompt answer forWebElementsPrompt
in document drilling.static int
DOCUMENT_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER
Specifies an argument for the new prompt answer forWebObjectsPrompt
in document drilling.static int
DOCUMENT_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER
Specifies an argument for the new prompt answer forWebConstantPrompt
in document drilling.static int
DOCUMENT_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION
An integer prompt answer mode fromEnumWebPromptAnswerMode
static int
DOCUMENT_EVENT_ARGUMENT_RANGE_END
Specifies an argument for range end in printing.static int
DOCUMENT_EVENT_ARGUMENT_RANGE_START
Specifies an argument for range start in printing.static int
DOCUMENT_EVENT_ARGUMENT_REEXECUTE_FRESH
Argument indicating whether the document to be executed with fresh-execution related execution flags.static int
DOCUMENT_EVENT_ARGUMENT_REPROMPT
Reprompting option for refreshing a report.static int
DOCUMENT_EVENT_ARGUMENT_SAVE_TO_INBOX
Specifies whether to save the message to inbox.static int
DOCUMENT_EVENT_ARGUMENT_SCHEDULE_OVERWRITE
Argument indicating whether to overwrite a current schedule, if existing.static int
DOCUMENT_EVENT_ARGUMENT_SCHEDULE_REUSE_MESSAGE
Integer argument indicating whether the message should be reused while scheduling.static int
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_ID
String argument indicating the address ID.static int
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES
String argument indicating the physical addresses to be used for subscription.static int
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE
Message to be saved along with the email subscriptionstatic int
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_DEVICE_ID
String argument indicating the deviceID.static int
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_EMAIL_SUBJECT
String argument indicating the email subject to be used for subscription.static int
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ID
The subscription ID for the subscription using which a document can be initializedstatic int
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID
Subscription notification is sent to this existing address.static int
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_VALUE
Subscription notification is sent to this new address.static int
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_DEVICE_ID
Specifies an argument for subscription device id.static int
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_PRINT_ALL
Specifies an argument whether to print all subscriptions.static int
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW
String argument indicating sendnow property for subscription.static int
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ZIP
Specifies an argument for subscription zip.static int
DOCUMENT_EVENT_ARGUMENT_TARGET_ID
The target document ID for the schedule using which a document can be initializedstatic int
DOCUMENT_EVENT_ARGUMENT_TRIGGER_ID
String argument indicating the trigger to be used.static int
DOCUMENT_EVENT_CANCEL_REPROMPT_REQUEST
Specifies an event to cancel the request.static int
DOCUMENT_EVENT_CANCEL_REQUEST
Specifies an event to cancel the request.static int
DOCUMENT_EVENT_EXECUTE_DOCUMENT
Specifies an event to execute a Document.static int
DOCUMENT_EVENT_INITIALIZE_FROM_SCHEDULE
Deprecated.Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions.static int
DOCUMENT_EVENT_INITIALIZE_FROM_SUBSCRIPTION
Specifies an event to initialize the document bean using a subscription.static int
DOCUMENT_EVENT_REFRESH
Event for refreshing a report.static int
DOCUMENT_EVENT_SAVE_FILE_SUBSCRIPTION
Specifies an event to save subscription to a file.static int
DOCUMENT_EVENT_SAVE_PRINT_SUBSCRIPTION
Specifies an event to print subscription.static int
DOCUMENT_EVENT_SAVE_SCHEDULE
Deprecated.Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions.static int
DOCUMENT_EVENT_SAVE_SUBSCRIPTION
event for saving an email subsription.static int
DOCUMENT_EVENT_SAVE_TO_INBOX
Specifies an event to save the a Document message into Inbox.-
Fields inherited from interface com.microstrategy.web.beans.EnumObjectBeanEvents
OBJECT_EVENT_ARGUMENT_FlAGS, OBJECT_EVENT_ARGUMENT_OBJECT_ID, OBJECT_EVENT_ARGUMENT_OBJECT_NAME, OBJECT_EVENT_ARGUMENT_OBJECT_SUBTYPE, OBJECT_EVENT_ARGUMENT_OBJECT_TYPE, OBJECT_EVENT_BROWSE
-
-
-
-
Field Detail
-
DOCUMENT_EVENT_EXECUTE_DOCUMENT
static final int DOCUMENT_EVENT_EXECUTE_DOCUMENT
Specifies an event to execute a Document. The possible parameters that can be sent in are- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_SAVE_TO_INBOX
static final int DOCUMENT_EVENT_SAVE_TO_INBOX
Specifies an event to save the a Document message into Inbox.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_CANCEL_REQUEST
static final int DOCUMENT_EVENT_CANCEL_REQUEST
Specifies an event to cancel the request.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_SAVE_SCHEDULE
static final int DOCUMENT_EVENT_SAVE_SCHEDULE
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 theSubscriptionBean
instead.event for saving the schedule.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_SAVE_SUBSCRIPTION
static final int DOCUMENT_EVENT_SAVE_SUBSCRIPTION
event for saving an email subsription.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_CANCEL_REPROMPT_REQUEST
static final int DOCUMENT_EVENT_CANCEL_REPROMPT_REQUEST
Specifies an event to cancel the request.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_INITIALIZE_FROM_SCHEDULE
static final int DOCUMENT_EVENT_INITIALIZE_FROM_SCHEDULE
Deprecated.Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Hence please useDOCUMENT_EVENT_INITIALIZE_FROM_SUBSCRIPTION
instead.Specifies an event to initialize the document bean using a schedule.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_INITIALIZE_FROM_SUBSCRIPTION
static final int DOCUMENT_EVENT_INITIALIZE_FROM_SUBSCRIPTION
Specifies an event to initialize the document bean using a subscription.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_SAVE_FILE_SUBSCRIPTION
static final int DOCUMENT_EVENT_SAVE_FILE_SUBSCRIPTION
Specifies an event to save subscription to a file.- Since:
- MicroStrategy Web 7.5.1
- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_SAVE_PRINT_SUBSCRIPTION
static final int DOCUMENT_EVENT_SAVE_PRINT_SUBSCRIPTION
Specifies an event to print subscription.- Since:
- MicroStrategy Web 7.5.1
- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_DOCUMENT_ID
static final int DOCUMENT_EVENT_ARGUMENT_DOCUMENT_ID
Specifies an argument for the object id of a Document.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_DOCUMENT_NAME
static final int DOCUMENT_EVENT_ARGUMENT_DOCUMENT_NAME
Specifies an argument for the document name.- Since:
- MicroStrategy Web 7.5.1
- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_EXECUTION_FLAGS
static final int DOCUMENT_EVENT_ARGUMENT_EXECUTION_FLAGS
Specifies an argument for the object id of a Document.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_MESSAGE_ID
static final int DOCUMENT_EVENT_ARGUMENT_MESSAGE_ID
Specifies an argument for the message id of a Document instance.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_TRIGGER_ID
static final int DOCUMENT_EVENT_ARGUMENT_TRIGGER_ID
String argument indicating the trigger to be used.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_SCHEDULE_REUSE_MESSAGE
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.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_ID
static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_ID
String argument indicating the address ID.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES
static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES
String argument indicating the physical addresses to be used for subscription.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_DEVICE_ID
static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_DEVICE_ID
String argument indicating the deviceID.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_EMAIL_SUBJECT
static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_EMAIL_SUBJECT
String argument indicating the email subject to be used for subscription.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW
static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW
String argument indicating sendnow property for subscription.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_REFRESH
static final int DOCUMENT_EVENT_REFRESH
Event for refreshing a report.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_REPROMPT
static final int DOCUMENT_EVENT_ARGUMENT_REPROMPT
Reprompting option for refreshing a report.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_REEXECUTE_FRESH
static final int DOCUMENT_EVENT_ARGUMENT_REEXECUTE_FRESH
Argument indicating whether the document to be executed with fresh-execution related execution flags.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_SCHEDULE_OVERWRITE
static final int DOCUMENT_EVENT_ARGUMENT_SCHEDULE_OVERWRITE
Argument indicating whether to overwrite a current schedule, if existing.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE
static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE
Message to be saved along with the email subscription- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_TARGET_ID
static final int DOCUMENT_EVENT_ARGUMENT_TARGET_ID
The target document ID for the schedule using which a document can be initialized
-
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ID
static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ID
The subscription ID for the subscription using which a document can be initialized
-
DOCUMENT_EVENT_ARGUMENT_SAVE_TO_INBOX
static final int DOCUMENT_EVENT_ARGUMENT_SAVE_TO_INBOX
Specifies whether to save the message to inbox.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_LOCATION_KEY
static final int DOCUMENT_EVENT_ARGUMENT_LOCATION_KEY
Location key for scheduled file and print export- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_FILE_NAME
static final int DOCUMENT_EVENT_ARGUMENT_FILE_NAME
File name for scheduled file export- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_COPIES
static final int DOCUMENT_EVENT_ARGUMENT_COPIES
Specifies an argument for the number of copies.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_IS_PORTRAIT
static final int DOCUMENT_EVENT_ARGUMENT_IS_PORTRAIT
Specifies an argument indicating whether it is a portait in printer.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_IS_COLLATED
static final int DOCUMENT_EVENT_ARGUMENT_IS_COLLATED
Specifies an argument indicating whether it is collated in printer.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_RANGE_START
static final int DOCUMENT_EVENT_ARGUMENT_RANGE_START
Specifies an argument for range start in printing.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_RANGE_END
static final int DOCUMENT_EVENT_ARGUMENT_RANGE_END
Specifies an argument for range end in printing.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID
static final int DOCUMENT_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID
Specifies an argument for the original document message id in document drilling.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML
static final int DOCUMENT_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML
Specifies an argument for the original document's prompt answer XML in document drilling.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER
static final int DOCUMENT_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER
Specifies an argument for the new prompt answer forWebElementsPrompt
in document drilling.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ZIP
static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ZIP
Specifies an argument for subscription zip.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID
static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID
Subscription notification is sent to this existing address.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_VALUE
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 overDOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID
.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_DEVICE_ID
static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_DEVICE_ID
Specifies an argument for subscription device id.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_PRINT_ALL
static final int DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_PRINT_ALL
Specifies an argument whether to print all subscriptions.- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER
static final int DOCUMENT_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER
Specifies an argument for the new prompt answer forWebConstantPrompt
in document drilling.- Since:
- MicroStrategy Web 8.1.0
- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER
static final int DOCUMENT_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER
Specifies an argument for the new prompt answer forWebObjectsPrompt
in document drilling.- Since:
- MicroStrategy Web 8.1.0
- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_LINK_ANSWERS
static final int DOCUMENT_EVENT_ARGUMENT_LINK_ANSWERS
- Since:
- MicroStrategy Web 8.1.2
- See Also:
- Constant Field Values
-
DOCUMENT_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION
static final int DOCUMENT_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION
An integer prompt answer mode fromEnumWebPromptAnswerMode
- See Also:
- Constant Field Values
-
-