Package com.microstrategy.web.app.beans

Interface SubscriptionEditorBean

    • Field Detail

      • SUBSCRIPTION_DEFAULT

        static final int SUBSCRIPTION_DEFAULT
        Indicates the editor handles normal (default) subscriptions
        See Also:
        Constant Field Values

      • SUBSCRIPTION_NARROWCAST

        static final int SUBSCRIPTION_NARROWCAST
        Indicates the editor handles Narrowcast email subscriptions
        See Also:
        Constant Field Values

      • SUBSCRIPTION_SEND_NOW

        static final int SUBSCRIPTION_SEND_NOW
        Indicates the editor handles send now subscriptions
        See Also:
        Constant Field Values

      • SUBSCRIPTION_NARROWCAST_FILE

        static final int SUBSCRIPTION_NARROWCAST_FILE
        Indicates the editor handles Narrowcast file subscriptions
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • SUBSCRIPTION_NARROWCAST_PRINT

        static final int SUBSCRIPTION_NARROWCAST_PRINT
        Indicates the editor handles Narrowcast print subscriptions
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • SUBSCRIPTION_MOBILE

        static final int SUBSCRIPTION_MOBILE
        Indicates the editor handles mobile subscriptions.
        Since:
        MicroStrategy Web 8.1.1
        See Also:
        Constant Field Values

      • SUBSCRIPTION_PERSONAL_VIEW

        static final int SUBSCRIPTION_PERSONAL_VIEW
        See Also:
        Constant Field Values

      • SUBSCRIPTION_NARROWCAST_FTP

        static final int SUBSCRIPTION_NARROWCAST_FTP
        Indicates the editor handles FTP subscriptions.
        Since:
        MicroStrategy Web 9.4.0
        See Also:
        Constant Field Values

      • SUBSCRIPTION_NARROWCAST_CACHE

        static final int SUBSCRIPTION_NARROWCAST_CACHE
        Indicates the editor handles cache subscriptions.
        Since:
        MicroStrategy Web 10.0
        See Also:
        Constant Field Values

    • Method Detail

      • getSubscriptionType

        int getSubscriptionType()
        Indicates the type of subscriptions the editor handles.
        Returns:
        either SUBSCRIPTION_DEFAULT or SUBSCRIPTOIN_SEND_NOW

      • setSubscriptionType

        void setSubscriptionType​(int type)
        Set the type of subscriptions the editor will handle.
        Parameters:
        type - either SUBSCRIPTION_DEFAULT or SUBSCRIPTOIN_SEND_NOW

      • getTargetBeanParentID

        java.lang.String getTargetBeanParentID()
        Obtains parent WebComponent ID of given Target bean.
        Returns:
        String ID.
        Since:
        MicroStrategy Web 8.0.0

      • getTriggers

        SimpleListObj getTriggers()
        Returns simple list of all available formats in Narrow Caster.
        Returns:
        SimpleListObj instance,
        Since:
        MicroStrategy Web 8.0.0

      • getIsCustomMessageAvailable

        boolean getIsCustomMessageAvailable()
        This method will return a true if the feature to set custom message to be delivered with the email is available.
        Returns:
        true if the feature to set custom message is available
        Since:
        MicroStrategy Web 8.0.0

      • getAddresses

        SimpleList getAddresses()
        This method will retrieve the list of available addresses for email subscription.
        Returns:
        The list of available addresses for email subscription.
        Since:
        MicroStrategy Web 8.0.0

      • getAvailableFormats

        SimpleList getAvailableFormats()
        This method will retrieve the list of available formats for email subscription.
        Returns:
        The list of available formats for email subscription.
        Since:
        MicroStrategy Web 8.0.0

      • getAvailableLocations

        SimpleList getAvailableLocations()
        This method will retrieve the list of available locations for print and file subscription.
        Returns:
        The list of available locations for print and file subscription.
        Since:
        MicroStrategy Web 8.0.0

      • getDevices

        SimpleList getDevices()
        This method will retrieve the list of available devices for creating addresses for email subscription.
        Returns:
        The list of available devices for creating addresses for email subscription.
        Since:
        MicroStrategy Web 8.0.0

      • getSubscriptionTriggers

        SimpleList getSubscriptionTriggers()
        This method will retrieve the list of available triggers (schedules) for email subscription.
        Returns:
        The list of available triggers (schedules) for email subscription.
        Since:
        MicroStrategy Web 8.0.0

      • getSubject

        java.lang.String getSubject()
        This method will retrieve the subjsct for email subscription.
        Returns:
        The subjsct for email subscription.
        Since:
        MicroStrategy Web 8.0.0

      • getSubscriptionsCount

        int getSubscriptionsCount()
        This method returns the count of subscriptions.
        Returns:
        The count of subscriptions.
        Since:
        MicroStrategy Web 8.0.0

      • getScheduleTriggers

        SimpleListObj getScheduleTriggers()
        This method will retrieve the list of available triggers (schedules) for scheduling.
        Returns:
        The list of available triggers (schedules) for scheduling.
        Since:
        MicroStrategy Web 8.0.0

      • getSubscriptionObjectViewType

        int getSubscriptionObjectViewType()
        Indicates what view type is the subscription object.
        Returns:
        int value.
        Since:
        MicroStrategy Web 8.0.0

      • isOverwriteNeeded

        boolean isOverwriteNeeded()
        Indicates whether or not current subscription needs to be overwritten.
        Returns:
        true value.
        Since:
        MicroStrategy Web 8.0.0

      • setIsOverwriteNeeded

        void setIsOverwriteNeeded​(boolean value)
        Specifies whether or not current subscription needs to be overwritten.
        Parameters:
        value - boolean flag.
        Since:
        MicroStrategy Web 8.0.0

      • getTriggerId

        java.lang.String getTriggerId()
        Indicates Id value for existing subscription trigger.
        Returns:
        String text.
        Since:
        MicroStrategy Web 8.0.0

      • setTriggerId

        void setTriggerId​(java.lang.String value)
        Specifies Id value for existing subscription trigger.
        Parameters:
        value - String text.
        Since:
        MicroStrategy Web 8.0.0

      • reuseMsg

        java.lang.String reuseMsg()
        Indicates The value of the subscription flag.
        Returns:
        String text
        Since:
        MicroStrategy Web 8.0.0

      • setReuseMsg

        void setReuseMsg​(java.lang.String value)
        Specifies The value of the subscription flag.
        Parameters:
        value - String text.
        Since:
        MicroStrategy Web 8.0.0

      • getScheduleTrigger

        WebScheduleTrigger getScheduleTrigger()
        Indicates the scheduled trigger element.
        Returns:
        WebScheduleTrigger object.
        Since:
        MicroStrategy Web 8.0.0

      • getApplyEventId

        int getApplyEventId()
        Indicates the apply event Id.
        Returns:
        int value.
        Since:
        MicroStrategy Web 8.0.0

      • setApplyEventId

        void setApplyEventId​(int value)
        Specifies the apply event Id.
        Parameters:
        value - value.
        Since:
        MicroStrategy Web 8.0.0

      • isSaveNeeded

        boolean isSaveNeeded()
        Indicates whether or not current subscription needs to be saved.
        Returns:
        true value.
        Since:
        MicroStrategy Web 8.0.0

      • getErrorMessage

        java.lang.String getErrorMessage()
        Returns error message if any or null if nothing happens.
        Returns:
        String text.
        Since:
        MicroStrategy Web 8.0.0

      • setEditorMessage

        void setEditorMessage​(java.lang.String mssg)
        Specifies message to be displayed informing action results.
        Parameters:
        mssg - Text.
        Since:
        MicroStrategy Web 8.0.0

      • getEditorMessage

        java.lang.String getEditorMessage()
        Returns message to be displayed informing action results.
        Returns:
        String mssg Text.
        Since:
        MicroStrategy Web 8.0.0

      • getNotificationAddresses

        SimpleList getNotificationAddresses()
        This method will retrieve the list of available notification addresses for subscription.
        Returns:
        The list of available notification addresses for subscription.
        Since:
        MicroStrategy Web 8.0.0

      • getNotificationDevices

        SimpleList getNotificationDevices()
        This method will retrieve the list of available notification devices for subscription.
        Returns:
        The list of available notification devices for subscription.
        Since:
        MicroStrategy Web 8.0.0

      • getUseDeliveryNotification

        boolean getUseDeliveryNotification()
        This method will retrieve the value of use delivery notification for subscription.
        Returns:
        The current value of use delivery notification for subscription.
        Since:
        MicroStrategy Web 8.0.0

      • getIsDeliveryNotificationAvailable

        boolean getIsDeliveryNotificationAvailable()
        Indicates whether or not the delivery notification option is available.
        Returns:
        true if delivery notification is available.
        Since:
        MicroStrategy Web 8.0.0

      • getIsExpandPageByAvailable

        boolean getIsExpandPageByAvailable​(SubscriptionEditorBean subsEditor)
        Indicates whether or not the expand pageby option is available
        Parameters:
        subsEditor - The current subscriptionEditor
        Returns:
        true if expand pageby is available.
        Since:
        MicroStrategy Web 8.0.0

      • getExpandPageBy

        int getExpandPageBy​(SubscriptionEditorBean subsEditor)
        Returns the value of expand pageby option
        Parameters:
        subsEditor - The current subscriptionEditor
        Returns:
        the expand pageby value.
        Since:
        MicroStrategy Web 8.0.0

      • getExpandUseSeparateSheets

        int getExpandUseSeparateSheets​(SubscriptionEditorBean subsEditor)
        Returns the value of expand use separate sheets option
        Parameters:
        subsEditor - The current subscriptionEditor
        Returns:
        the expand use separate sheets value
        Since:
        MicroStrategy Web 8.0.1

      • getFileName

        java.lang.String getFileName()
        Returns the value of file name
        Returns:
        the file name value.
        Since:
        MicroStrategy Web 8.0.0

      • isMobile

        boolean isMobile()
        Since:
        MicroStrategy Web 8.1.1

      • setMobile

        void setMobile​(boolean value)
        Since:
        MicroStrategy Web 8.1.1

      • hasDuplicate

        boolean hasDuplicate()
        Since:
        MicroStrategy Web 8.1.1

      • setHasDuplicate

        void setHasDuplicate​(boolean value)
        Since:
        MicroStrategy Web 8.1.1

      • hasMobileDuplicate

        boolean hasMobileDuplicate()
        Since:
        MicroStrategy Web 8.1.1

      • setMobileDuplicate

        void setMobileDuplicate​(WebSchedule value)
        Since:
        MicroStrategy Web 8.1.1

      • getMobileDuplicate

        WebSchedule getMobileDuplicate()
        Since:
        MicroStrategy Web 8.1.1

      • getSubscriptionBean

        SubscriptionBean getSubscriptionBean()
        Since:
        MicroStrategy Web 9.0.0

      • getExpandLayouts

        boolean getExpandLayouts()
        Since:
        MicroStrategy Web 9.0.0

      • isExpandLayoutsAvailable

        boolean isExpandLayoutsAvailable()
        Since:
        MicroStrategy Web 9.0.0

      • isNonSchedulable

        boolean isNonSchedulable()
        Returns:
        whether the schedulable

      • isUserAllowedToSubscribe

        boolean isUserAllowedToSubscribe()
        Returns:
        whether the allow user to subscribe

      • isPageByChanged

        boolean isPageByChanged()