Package com.microstrategy.web.beans

Interface SubscriptionFolderBean

    • Field Detail

      • SUBSCRIPTION_FOLDER_CONTENT_TYPE_SCHEDULE

        @Deprecated
static final int SUBSCRIPTION_FOLDER_CONTENT_TYPE_SCHEDULE
        Deprecated.
        Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Please use SUBSCRIPTION_FOLDER_CONTENT_TYPE_SUBSCRIPTION instead.
        Content type for a schedule.
        See Also:
        Constant Field Values

      • SUBSCRIPTION_FOLDER_CONTENT_TYPE_SCHEDULE_TRIGGER

        static final int SUBSCRIPTION_FOLDER_CONTENT_TYPE_SCHEDULE_TRIGGER
        Content type for a schedule trigger.
        See Also:
        Constant Field Values

      • SUBSCRIPTION_FOLDER_CONTENT_TYPE_SUBSCRIPTION

        static final int SUBSCRIPTION_FOLDER_CONTENT_TYPE_SUBSCRIPTION
        Content type for a subscription.
        See Also:
        Constant Field Values

      • SUBSCRIPTION_FOLDER_CONTENT_TYPE_DEVICE

        static final int SUBSCRIPTION_FOLDER_CONTENT_TYPE_DEVICE
        Content type for a device.
        See Also:
        Constant Field Values

      • SUBSCRIPTION_FOLDER_CONTENT_TYPE_ADDRESS

        static final int SUBSCRIPTION_FOLDER_CONTENT_TYPE_ADDRESS
        Content type for an address.
        See Also:
        Constant Field Values

      • SUBSCRIPTION_FOLDER_CONTENT_TYPE_MOBILE_SCHEDULE

        static final int SUBSCRIPTION_FOLDER_CONTENT_TYPE_MOBILE_SCHEDULE
        Content type for mobile subscriptions
        Since:
        MicroStrategy Web 8.1.1
        See Also:
        Constant Field Values

    • Method Detail

      • getSortField

        int getSortField()
        Retrieves the sort field
        Returns:
        the sort field

      • setSortField

        void setSortField​(int sortField)
        sets the sort field
        Parameters:
        sortField - the field by which to sort on -- one of the values from WebSubscriptionsSource or {link com.microstrategy.web.objects.EnumWebScheduleSort} based on whether the bean corresponds to Email schedules or Web schedules respectively.

      • setSortAscending

        void setSortAscending​(boolean asc)
        sets the sort order to be ascending or descending
        Parameters:
        asc - true indicates ascending and false indicates descending

      • setSortForDeliveryMode

        void setSortForDeliveryMode​(int mode,
                            int field,
                            boolean ascending)
        sets the sort field and order for the specified delivery mode
        Parameters:
        mode - int deliveryMode from EnumDSSXMLSubscriptionDeliveryType
        field - int field by which to sort on from WebSubscriptionsSource or {link com.microstrategy.web.objects.EnumWebScheduleSort} based on whether the bean corresponds to Email schedules or Web schedules respectively.
        ascending -

      • getSortField

        int getSortField​(int mode)
        Retrieves the sort field for the specified delivery mode (if set)
        Parameters:
        mode - int specifying the delivery mode (from EnumDSSXMLSubscriptionDeliveryType)
        Returns:
        int sort field. -1 if not previously set

      • isSortAscending

        boolean isSortAscending​(int mode)
        returns whether the sort for the specified delivery mode is ascending
        Parameters:
        mode - int specifying the delivery mode (from EnumDSSXMLSubscriptionDeliveryType)
        Returns:
        whether the sort is ascending

      • isSortAscending

        boolean isSortAscending()
        returns whether the sort is ascending
        Returns:
        whether the sort is ascending

      • setContentType

        void setContentType​(int type)
        the possible types here are triggers, subscriptions, devices
        Parameters:
        type - -- one of the values from constants defined in this interface

      • getContentType

        int getContentType()
        the possible types here are triggers, subscriptions, devices (constants defined in this interface)
        Returns:
        the type of contents this bean holds

      • getComponents

        SimpleList getComponents()
                  throws WebBeanException
        Returns the list of objects specified by the type. The returned objects need to be cast to the appropriate type
        Returns:
        the list of objects specified by the type.
        Throws:
        WebBeanException

      • getComponentsByDeliveryMode

        SimpleList getComponentsByDeliveryMode​(int mode)
                                throws WebBeanException
        Returns a list of objects from the folder that have one of the specified delivery modes. Objects without delivery types (e.g. triggers and schedules) in the folder will be returned. The returned objects need to be cast to the appropriate type. Does not repopulate unless no initial population has occurred or folder contents have become stale
        Parameters:
        mode - int specifying a set of bitwise ORed modes from EnumDSSXMLSubscriptionDeliveryType
        Returns:
        SimpleList of objects
        Throws:
        WebBeanException

      • getBlockBegin

        int getBlockBegin()
        Returns the value of blockBegin set on this object. The blockBegin and blockCount parameters are used to incrementally fetch the list..
        Returns:
        the value of blockBegin on this object.

      • setBlockBegin

        void setBlockBegin​(int blockBegin)
        Sets the value of blockBegin on this object. The blockBegin and blockCount parameters are used to incrementally fetch the list
        Parameters:
        blockBegin - The blockBegin to be set for this object.

      • getBlockCount

        int getBlockCount()
        Returns the value of blockCount set on this object. The blockBegin and blockCount parameters are used to incrementally fetch the list
        Returns:
        the value of blockCount on this object.

      • setBlockCount

        void setBlockCount​(int blockCount)
        Sets the value of blockCount on this object. The blockBegin and blockCount parameters are used to incrementally fetch the list
        Parameters:
        blockCount - The blockCount to be set for this object.

      • getFilter

        SimpleList getFilter()
        Editable list of Identifiers of objects that is used in the case of delete In the case of subscriptions and addresses, the identifiers are just the IDs In the case of schedules, the identifiers are the saved state of the individual schedules The filter is cleared once delete is called on this bean
        Returns:
        editable SimpleList of identifiers

      • delete

        void delete()
     throws WebBeanException
        Deletes the objects that are specified by the filter using the getFilter method on this bean.
        Throws:
        WebBeanException

      • setTarget

        void setTarget​(java.lang.String ObjectID,
               int objectType)
        throws WebBeanException
        sets the object for which components should be retrieved. If this target is not set, all the components for the user are retrieved
        Parameters:
        ObjectID - of a report/document
        objectType - value from the enumeration EnumDSSXMLObjectTypes can be either report or document
        Throws:
        WebBeanException

      • setDeliveryMode

        void setDeliveryMode​(int deliveryMode)
        Sets retrieval for components with specified delivery mode (EnumWebSubscriptionDeliveryMode). If unspecified, or set to -1, no delivery mode filtering is performed.
        Parameters:
        deliveryMode - the delivery mode.
        Since:
        MicroStrategy Web 7.5.1

      • getDeliveryMode

        int getDeliveryMode()
        Retrieves only components with specified delivery mode from EnumWebSubscriptionDeliveryMode. If unspecified, or set to -1, no delivery mode filtering is performed.
        Returns:
        the delivery mode.
        Since:
        MicroStrategy Web 7.5.1