Package com.microstrategy.web.objects

Interface WebSubscription

    • Method Detail

      • isNew

        boolean isNew()
        This indicates whether the whether the subscription is a new one
        Returns:
        boolean value indicating whether the subscription is new
        Since:
        MicroStrategy Web 9.0.0

      • restContentAndPersonalization

        void restContentAndPersonalization()
                            throws WebObjectsException
        Reset the contents and associated personalization to be empty This API is only available with valid information for multiple content subscription
        Throws:
        WebObjectsException

      • resetRdfMap

        void resetRdfMap()
        Rest rdf map for update workflow so that the rdf map gets cleaned up to populate updated information

      • getContentPls

        java.util.Map<java.lang.String,​WebContentPersonalization> getContentPls()
        Get the map contains the content personalization of all the contents This API is only available with valid information for multiple content subscription
        Returns:

      • getContentPersonalizationByContentIndex

        WebContentPersonalization getContentPersonalizationByContentIndex​(int index)
                                                           throws WebObjectsException
        Get the content personalization by the content index This API is only available with valid information for multiple content subscription
        Returns:
        the content personalization (@link WebContentPersonalization) if it is found in the map, otherwise it return null
        Throws:
        WebObjectsException

      • setContents

        WebSubscriptionContent setContents​(WebObjectInfo woi,
                                   int index)
                            throws WebObjectsException
        sets the contents for this multiple content subscription This API is only available with valid information for multiple content subscription
        Parameters:
        woi - WebObjectInfo object representing either a report or a document
        index - the index of the content in the subscription
        Returns:
        the WebSubscriptionContent associated with this subscription
        Throws:
        WebObjectsException - Thrown if the input parameter does not correspond to a valid report/document.

      • isPersonalized

        boolean isPersonalized()
                throws WebObjectsException
        This indicates whether the content that we are creating a subscription for is prompted
        Returns:
        boolean value indicating whether the content is personalized
        Throws:
        WebObjectsException

      • getNotification

        WebSubscriptionNotification getNotification()
        Retrieves the WebSubscriptionNotification object that can edited to specify whether any notification mechanism should be specified while creating the subscription. Typically, you can create an email notification while creatin a file or print subscription
        Since:
        MicroStrategy Web 8.0.0

      • isAlertingSubscription

        boolean isAlertingSubscription()
        Returns true if the subscription is used to define an alert This API is only available with valid information for single content subscription
        Since:
        MicroStrategy Web 9.0.0

      • setAlertingSubscription

        void setAlertingSubscription​(boolean val)
                      throws WebObjectsException
        Sets the subscription to be an alerting subscription. If no content is set for alerting using This API is only available with valid information for single content subscription setContentForAlert(WebObjectInfo), the current content getContent() will be used.
        Parameters:
        val -
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web 9.0.0

      • getContentForAlert

        WebObjectInfo getContentForAlert()
        Returns the report that has been configured to be delivered for the alert. While the condition of the alert is defined on the WebSubscriptionContent, the report that is configured to be delivered could be a different one. This API is only available with valid information for single content subscription
        Since:
        MicroStrategy Web 9.0.0

      • setContentForAlert

        void setContentForAlert​(WebObjectInfo woi)
        Sets the report that needs to be delivered when an alerting condition is met. This could be the same report on which the alerting condition is based or a different one. This API is only available with valid information for single content subscription
        Parameters:
        woi -
        Since:
        MicroStrategy Web 9.0.0

      • setOwner

        void setOwner​(WebUserEntity owner)
        Sets the owner of the subscription. By default the owner of a subscription is the user whose session is used to create the subscription. However if you have the privilege to monitor and administer subscriptions, you can modify subscriptions created by other users or even create subscriptions for other users. Setting the owner as another user will essentially tie the subscription to this user.
        Parameters:
        owner -
        Since:
        MicroStrategy Web 9.0.0

      • setName

        void setName​(java.lang.String name)
        Sets the name of the subscription.
        Parameters:
        name -
        Since:
        MicroStrategy Web 9.0.0

      • setIsMCS

        void setIsMCS​(boolean isMCS)
        Set a multiple content subscription to be true, by default it is false - for single content subscription set _isMCS
        Parameters:
        isMCS -

      • getIsMCS

        boolean getIsMCS()
        Get a multiple content subscription to be true, by default it is false - for single content subscription
        Returns:
        _isMCS

      • isSingleBookmarkSubscription

        boolean isSingleBookmarkSubscription()

      • getBookmarkId

        java.lang.String getBookmarkId()

      • getInstancePersonalization

        WebInstancePersonalization getInstancePersonalization()
        Get instance personalization from a multiple content subscription. This API is only available with valid information for multiple content subscription
        Returns:
        an instance of WebInstancePersonalization. The members of the instance may not be initialized.

      • setInstancePersonalization

        void setInstancePersonalization​(WebInstancePersonalization iInstancePls)
        Set the instance personalization for a multiple content subscription. This API is only available with valid information for multiple content subscription

      • getIncludePrompts

        boolean getIncludePrompts()

      • setIncludePrompts

        void setIncludePrompts​(boolean value)

      • setBurstList

        void setBurstList​(java.util.ArrayList burstList)

      • getBurstList

        java.util.ArrayList getBurstList()

      • isInvalidSchedule

        boolean isInvalidSchedule()

      • getBurstAddressAttributeId

        java.lang.String getBurstAddressAttributeId()
        gets the Attribute ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device. This API is only available with valid information for single content subscription
        Since:
        MicroStrategy Web 9.4

      • setBurstAddressAttributeId

        void setBurstAddressAttributeId​(java.lang.String burstAddressID)
        sets the Attribute ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device. This API is only available with valid information for single content subscription
        Since:
        MicroStrategy Web 9.4

      • setBurstDeviceId

        void setBurstDeviceId​(java.lang.String burstDeviceID)
        gets the Device ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device. This API is only available with valid information for single content subscription
        Since:
        MicroStrategy Web 9.4

      • getBurstDeviceId

        java.lang.String getBurstDeviceId()
        sets the Device ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device. This API is only available with valid information for single content subscription
        Since:
        MicroStrategy Web 9.4

      • getBurstFormId

        java.lang.String getBurstFormId()
        gets the Form ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device. This API is only available with valid information for single content subscription
        Since:
        MicroStrategy Web 9.4

      • setBurstFormId

        void setBurstFormId​(java.lang.String burstFormID)
        sets the Form ID in the Email Burst Feature.Email bursting is done on an Attribute and one of its form and a device. This API is only available with valid information for single content subscription
        Since:
        MicroStrategy Web 9.4

      • getBurstLayoutKey

        java.lang.String getBurstLayoutKey()
        gets the layout key that contains the attribute. This API is only available with valid information for single content subscription
        Since:
        MicroStrategy Web 9.4

      • setBurstLayoutKey

        void setBurstLayoutKey​(java.lang.String burstLayoutKey)
        sets the layout key that contains the attribute. This API is only available with valid information for single content subscription
        Since:
        MicroStrategy Web 9.4

      • setReuseDataSetCache

        void setReuseDataSetCache​(boolean isReuseDataSetCache)
        This API is only available with valid information for single content subscription
        Parameters:
        isReuseDataSetCache -

      • isReuseDataSetCache

        boolean isReuseDataSetCache()
        This API is only available with valid information for single content subscription
        Returns:

      • getRecipientSubscriptionIDForPersonalView

        java.lang.String getRecipientSubscriptionIDForPersonalView()
        Returns the subscription ID of recipient for personal view subscription. For other subscription, it will directly return its ID. This API is only available with valid information for single content subscription

      • addContentPls

        void addContentPls​(java.lang.String key,
                   WebContentPersonalization lContentPls)
        Set content personalization to the map Map contentPls, key is content id defined by XMLTags.Att_CnID in the subscription for get subscriptions. This API is only available with valid information for multiple content subscription
        Parameters:
        key -
        lContentPls -

      • getContentPlsByKey

        WebContentPersonalization getContentPlsByKey​(java.lang.String key)
        Get content personalization from the map Map contentPls, key is content id defined by XMLTags.Att_CnID in the subscription for get subscriptions. This API is only available with valid information for multiple content subscription
        Parameters:
        key -
        Returns:
        an instance of WebContentPersonalization, return null if the key cannot be find in the map