public interface

EnumSubscriptionEditorEvents

implements EnumFrameEditorEvents
com.microstrategy.web.app.beans.EnumSubscriptionEditorEvents

Class Overview

All event definitions used in subscription editor bean

Summary

Constants
int ADDRESS_CONTACT
int ADDRESS_EXISTING Constant to indicate an existing address
int ADDRESS_NEW Constant to indicate new address
int ADDRESS_RECIPIENTS_DEFAULT Constant to indicate recipient default email address
int WebEventArgumentAddressId Argument to specify the Address id for the subscription.
int WebEventArgumentAddressType Argument to indicate whether to use the address id or the address values.
int WebEventArgumentAddressValues Argument to specify the list of address names for the subscription.
int WebEventArgumentAllowChangingDeliverySettings
int WebEventArgumentAllowChangingPersonalization
int WebEventArgumentAllowUnsubscribe
int WebEventArgumentCompressContents Argument to indicate if the subscription is to be compressed for delivery.
int WebEventArgumentCompressedFileName Argument to indicate the compressed file name
int WebEventArgumentCurrentFormat Argument to indicate the format for the email subscription.
int WebEventArgumentCustomMessage Argument to indicate the text messsage to go with the email subscription.
int WebEventArgumentDeviceId Argument to specify the Device ID of the address used in the email subscription.
int WebEventArgumentExpandPageBy Argument to specify the notification Device ID of the address used in the subscription.
int WebEventArgumentExpandUseSeparateSheets Argument to specify whether to use separate sheets when expanding the page by elements.
int WebEventArgumentExpirationDate Argument to indicate the expiration date
int WebEventArgumentExtendedLocation Argument to indicate extended location for the print or file delivery.
int WebEventArgumentFileName Argument to indicate the file name for the scheduled file export.
int WebEventArgumentIncludeData Argument to for including data
int WebEventArgumentIncludeLink Argument to include link
int WebEventArgumentLocationID Argument to indicate location ID for the print or file delivery.
int WebEventArgumentMobile
int WebEventArgumentNotify Argument to specify the notification Device ID of the address used in the subscription.
int WebEventArgumentNotifyAddressId Argument to specify the notification Address id for the subscription.
int WebEventArgumentNotifyAddressMode Argument to specify the notification Device ID of the address used in the subscription.
int WebEventArgumentNotifyAddressValue Argument to specify the notification address name for the subscription.
int WebEventArgumentNotifyDeviceId Argument to specify the notification Device ID of the address used in the subscription.
int WebEventArgumentOverwriteSchedule Argument to indicate to overwrite any existing schedules when creating Schedule subscription.
int WebEventArgumentPrintCopies Argument to indicate the number of copies for scheduled print.
int WebEventArgumentPrintIsCollated Argument to indicate whether copies are collated for scheduled print.
int WebEventArgumentPrintIsPortrait Argument to indicate whether the orientation is portrait for scheduled print.
int WebEventArgumentPrintRangeAll Argument to indicate the all pages option for scheduled print.
int WebEventArgumentPrintRangeEnd Argument to indicate the end page for scheduled print.
int WebEventArgumentPrintRangeStart Argument to indicate the start page for scheduled print.
int WebEventArgumentProtectZipFile Indicates whether to protect the zip file.
int WebEventArgumentReuseMessage Argument to indicate whether to use the same message id everytime the report is run or not.
int WebEventArgumentScheduleExecutionFlags Argument to indicate to execution flags when creating Schedule subscription.
int WebEventArgumentSendNow Argument to specify if we need a preview of an email subscription immediately.
int WebEventArgumentSendToInbox Argument to send data to inbox
int WebEventArgumentSubject Argument to specify the subject of the email subscription.
int WebEventArgumentTriggerId Argument to specify the Trigger id for the subscription.
int WebEventArgumentZipFilePassword Argument to indicate the zip file password
int WebEventSubscriptionEditorApply Event to process the Subscription editor form.
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.EnumFrameEditorEvents
From interface com.microstrategy.web.app.beans.EnumPageEvents
From interface com.microstrategy.web.app.beans.EnumServletEvents

Constants

public static final int ADDRESS_CONTACT

Constant Value: 2 (0x00000002)

public static final int ADDRESS_EXISTING

Constant to indicate an existing address

Constant Value: 0 (0x00000000)

public static final int ADDRESS_NEW

Constant to indicate new address

Constant Value: 1 (0x00000001)

public static final int ADDRESS_RECIPIENTS_DEFAULT

Constant to indicate recipient default email address

Constant Value: 2 (0x00000002)

public static final int WebEventArgumentAddressId

Argument to specify the Address id for the subscription.

Constant Value: 39002 (0x0000985a)

public static final int WebEventArgumentAddressType

Argument to indicate whether to use the address id or the address values.

Constant Value: 39007 (0x0000985f)

public static final int WebEventArgumentAddressValues

Argument to specify the list of address names for the subscription. This is a list of comma seperated address values.

Constant Value: 39003 (0x0000985b)

public static final int WebEventArgumentAllowChangingDeliverySettings

Constant Value: 39037 (0x0000987d)

public static final int WebEventArgumentAllowChangingPersonalization

Constant Value: 39038 (0x0000987e)

public static final int WebEventArgumentAllowUnsubscribe

Constant Value: 39039 (0x0000987f)

public static final int WebEventArgumentCompressContents

Argument to indicate if the subscription is to be compressed for delivery. A value of "1" will indicate a compressed delivery. This is available only for email subscriptions.

Constant Value: 39012 (0x00009864)

public static final int WebEventArgumentCompressedFileName

Argument to indicate the compressed file name

Constant Value: 39030 (0x00009876)

public static final int WebEventArgumentCurrentFormat

Argument to indicate the format for the email subscription. The available formats could be HTML or EXCEL or PDF or any other format supported by the system. This is available only for email subscriptions.

Constant Value: 39011 (0x00009863)

public static final int WebEventArgumentCustomMessage

Argument to indicate the text messsage to go with the email subscription.

Constant Value: 39010 (0x00009862)

public static final int WebEventArgumentDeviceId

Argument to specify the Device ID of the address used in the email subscription. The Device Id is specified only in the case of creating new addresses while creating a new subscription.

Constant Value: 39006 (0x0000985e)

public static final int WebEventArgumentExpandPageBy

Argument to specify the notification Device ID of the address used in the subscription. The notification device Id is specified only in the case of creating new notification addresses.

Constant Value: 39027 (0x00009873)

public static final int WebEventArgumentExpandUseSeparateSheets

Argument to specify whether to use separate sheets when expanding the page by elements.

Constant Value: 39028 (0x00009874)

public static final int WebEventArgumentExpirationDate

Argument to indicate the expiration date

Constant Value: 39035 (0x0000987b)

public static final int WebEventArgumentExtendedLocation

Argument to indicate extended location for the print or file delivery. This is required when the selected location requires the user to type in extra information about the path for the location.

Constant Value: 39014 (0x00009866)

public static final int WebEventArgumentFileName

Argument to indicate the file name for the scheduled file export.

Constant Value: 39015 (0x00009867)

public static final int WebEventArgumentIncludeData

Argument to for including data

Constant Value: 39033 (0x00009879)

public static final int WebEventArgumentIncludeLink

Argument to include link

Constant Value: 39031 (0x00009877)

public static final int WebEventArgumentLocationID

Argument to indicate location ID for the print or file delivery.

Constant Value: 39013 (0x00009865)

public static final int WebEventArgumentMobile

Constant Value: 39040 (0x00009880)

public static final int WebEventArgumentNotify

Argument to specify the notification Device ID of the address used in the subscription. The notification device Id is specified only in the case of creating new notification addresses.

Constant Value: 39026 (0x00009872)

public static final int WebEventArgumentNotifyAddressId

Argument to specify the notification Address id for the subscription.

Constant Value: 39022 (0x0000986e)

public static final int WebEventArgumentNotifyAddressMode

Argument to specify the notification Device ID of the address used in the subscription. The notification device Id is specified only in the case of creating new notification addresses.

Constant Value: 39025 (0x00009871)

public static final int WebEventArgumentNotifyAddressValue

Argument to specify the notification address name for the subscription.

Constant Value: 39023 (0x0000986f)

public static final int WebEventArgumentNotifyDeviceId

Argument to specify the notification Device ID of the address used in the subscription. The notification device Id is specified only in the case of creating new notification addresses.

Constant Value: 39024 (0x00009870)

public static final int WebEventArgumentOverwriteSchedule

Argument to indicate to overwrite any existing schedules when creating Schedule subscription.

Constant Value: 39009 (0x00009861)

public static final int WebEventArgumentPrintCopies

Argument to indicate the number of copies for scheduled print.

Constant Value: 39016 (0x00009868)

public static final int WebEventArgumentPrintIsCollated

Argument to indicate whether copies are collated for scheduled print.

Constant Value: 39018 (0x0000986a)

public static final int WebEventArgumentPrintIsPortrait

Argument to indicate whether the orientation is portrait for scheduled print.

Constant Value: 39017 (0x00009869)

public static final int WebEventArgumentPrintRangeAll

Argument to indicate the all pages option for scheduled print.

Constant Value: 39021 (0x0000986d)

public static final int WebEventArgumentPrintRangeEnd

Argument to indicate the end page for scheduled print.

Constant Value: 39020 (0x0000986c)

public static final int WebEventArgumentPrintRangeStart

Argument to indicate the start page for scheduled print.

Constant Value: 39019 (0x0000986b)

public static final int WebEventArgumentProtectZipFile

Indicates whether to protect the zip file.

Constant Value: 39036 (0x0000987c)

public static final int WebEventArgumentReuseMessage

Argument to indicate whether to use the same message id everytime the report is run or not. This argument is used only for web subscriptions and not for email subscriptions. When this argument is not sent, scheduled reports will generate a new message in the History List each time the schedule executes.

Constant Value: 39008 (0x00009860)

public static final int WebEventArgumentScheduleExecutionFlags

Argument to indicate to execution flags when creating Schedule subscription.

Constant Value: 39029 (0x00009875)

public static final int WebEventArgumentSendNow

Argument to specify if we need a preview of an email subscription immediately. A value of "1" signifies that we need an immediate preview.

Constant Value: 39005 (0x0000985d)

public static final int WebEventArgumentSendToInbox

Argument to send data to inbox

Constant Value: 39032 (0x00009878)

public static final int WebEventArgumentSubject

Argument to specify the subject of the email subscription.

Constant Value: 39004 (0x0000985c)

public static final int WebEventArgumentTriggerId

Argument to specify the Trigger id for the subscription.

Constant Value: 39001 (0x00009859)

public static final int WebEventArgumentZipFilePassword

Argument to indicate the zip file password

Constant Value: 39034 (0x0000987a)

public static final int WebEventSubscriptionEditorApply

Event to process the Subscription editor form. This event is used for web subscriptions, email subscriptions and send now subscriptions.

Constant Value: 39001 (0x00009859)