Package com.microstrategy.web.app.gui

Class SubscriptionFileWidgetImpl

    • Field Detail

      • EXISTING_ADDRESSES_PANE

        protected static java.lang.String EXISTING_ADDRESSES_PANE

      • NEW_ADDRESSES_PANE

        protected static java.lang.String NEW_ADDRESSES_PANE

      • CONTACTS_PANE

        protected static java.lang.String CONTACTS_PANE

      • isDHTML

        protected boolean isDHTML

    • Constructor Detail

      • SubscriptionFileWidgetImpl

        public SubscriptionFileWidgetImpl()
        Default no arguments constructor. Initialize the widget with default values.

    • Method Detail

      • renderElement

        public MarkupOutput renderElement()
        Renders the element using the global arguments.
        Specified by:
        renderElement in interface GuiElement
        Returns:
        a MarkupOutput with the Subscription Widget.

      • setIsBulkExport

        public void setIsBulkExport​(boolean value)
        Set to true if the current object is a bulk export report.
        Specified by:
        setIsBulkExport in interface SubscriptionFileWidget
        Parameters:
        value - true current object is a bulk export report.
        Since:
        MicroStrategy Web 8.0.0

      • getToolTipforMacro

        public java.lang.String getToolTipforMacro()
        Generates the tool tip for showing the list of macros.
        Returns:
        The tool tip showing the list of macros.

      • getAddressDivStyle

        public java.lang.String getAddressDivStyle()
        Generates the style for showing the address value DIV.
        Returns:
        The style for showing the address value DIV.

      • getSendNowDivStyle

        public java.lang.String getSendNowDivStyle()
        Generates the style for showing the send now value DIV.
        Returns:
        The style for showing the address value DIV.

      • renderAvailableLocations

        public void renderAvailableLocations​(MarkupOutput out,
                                     SimpleList locations,
                                     java.lang.String locationID,
                                     java.lang.String argLocation)
        Description copied from interface: SubscriptionFileWidget
        Renders the list of available locations for the Subscriptions. This method can be called stand alone by passing the required arguments. It's also part of the renderElement() method that passes the global widget values properties as the arguments.
        Specified by:
        renderAvailableLocations in interface SubscriptionFileWidget
        Parameters:
        out - Where to write the widget's output
        locations - the list of locations
        locationID - the current location ID
        argLocation - the name of the location ID argument

      • renderTriggerList

        public void renderTriggerList​(MarkupOutput out,
                              SimpleList triggers,
                              java.lang.String triggerId,
                              java.lang.String argTrigger)
        Renders the list of triggers for the Subscriptions. This method can be called stand alone by passing the required arguments. It's also part of the renderElement() method that passes the global widget values properties as the arguments.
        Specified by:
        renderTriggerList in interface SubscriptionWidget
        Parameters:
        out - Where to write the widget's output
        triggers - the list of triggers
        triggerId - the current triggerId
        argTrigger - the name of the triggerId argument

      • renderTriggerList

        public void renderTriggerList​(MarkupOutput out,
                              SimpleList triggers,
                              java.lang.String triggerId,
                              java.lang.String argTrigger,
                              boolean selectSendNow)
        Renders the list of triggers for the Subscriptions. This method can be called stand alone by passing the required arguments. It's also part of the renderElement() method that passes the global widget values properties as the arguments.
        Parameters:
        out - Where to write the widget's output
        triggers - the list of triggers
        triggerId - the current triggerId
        argTrigger - the name of the triggerId argument
        selectSendNow - boolean to indicate if the send now schedule is to be pre selected in case of creating a new subscrtiption (Does not apply for edit case)
        Since:
        MicroStrategy Web 8.0.0

      • setTriggers

        public void setTriggers​(SimpleList value)
        Sets the id of the current trigger
        Specified by:
        setTriggers in interface SubscriptionWidget
        Parameters:
        value - the new value for the current trigger

      • setTriggerArg

        public void setTriggerArg​(java.lang.String value)
        The name of the triggerId argument
        Specified by:
        setTriggerArg in interface SubscriptionWidget
        Parameters:
        value - the new name for the triggerId argument

      • getTriggerArg

        public java.lang.String getTriggerArg()
        Specified by:
        getTriggerArg in interface SubscriptionWidget
        Returns:
        The name of the triggerId argument

      • setTriggerId

        public void setTriggerId​(java.lang.String value)
        Sets the id of the current trigger
        Specified by:
        setTriggerId in interface SubscriptionWidget
        Parameters:
        value - the new value for the current trigger

      • getTriggerId

        public java.lang.String getTriggerId()
        Specified by:
        getTriggerId in interface SubscriptionWidget
        Returns:
        the current triggerId value

      • setSendNow

        public void setSendNow​(boolean value)
        Indicated whether to send a preview of the subscription now.
        Specified by:
        setSendNow in interface SubscriptionWidget
        Parameters:
        value - true if a preview will be sent immediatly after creating the subscription.

      • isSendNowSet

        public boolean isSendNowSet()
        Specified by:
        isSendNowSet in interface SubscriptionWidget
        Returns:
        true if a preview will be sent immediatly after creating the subscription.

      • setSendNowArg

        public void setSendNowArg​(java.lang.String value)
        The sendNow's argument name.
        Specified by:
        setSendNowArg in interface SubscriptionWidget
        Parameters:
        value - The new sendNow argument name.

      • getSendNowArg

        public java.lang.String getSendNowArg()
        Specified by:
        getSendNowArg in interface SubscriptionWidget
        Returns:
        The sendNow argument name.

      • setIsSendNowAvailable

        public void setIsSendNowAvailable​(boolean value)
        Set to true if the the feature for Send Now is available
        Specified by:
        setIsSendNowAvailable in interface SubscriptionWidget
        Parameters:
        value - true if the send now feature is available

      • renderAddressList

        public void renderAddressList​(MarkupOutput out,
                              SimpleList addresses,
                              java.lang.String addressId,
                              java.lang.String addressArg,
                              java.lang.String addressTypeArg,
                              java.lang.String newAddressValue,
                              java.lang.String newAddressArg,
                              SimpleList devices,
                              java.lang.String deviceId,
                              java.lang.String deviceArg)
        Renders the list of addresses for the Subscription. This method can be called stand alone by passing the required arguments. It's also part of the renderElement() method that passes the global widget values properties as the arguments.
        Specified by:
        renderAddressList in interface DefaultSubscriptionWidget
        Parameters:
        out - Where to write the widget's output
        addresses - the list of addresses
        addressId - the id of the current address
        addressArg - the name of the addressId arg
        addressTypeArg - the name of the addressType arg
        newAddressValue - the value for the new address list
        newAddressArg - the name of the new address list argument
        devices - the list of devices
        deviceId - the current deviceId
        deviceArg - the name of the deviceId argument

      • renderSubjectField

        public void renderSubjectField​(MarkupOutput out,
                               java.lang.String subject,
                               java.lang.String argSubject)
        Renders a field for the Subject's of the e-mail sent with the given subscriptions. This method can be called stand alone by passing the required arguments. It's also part of the renderElement() method that passes the global widget values properties as the arguments.
        Specified by:
        renderSubjectField in interface DefaultSubscriptionWidget
        Parameters:
        out - Where to write the widget's output
        subject - The e-mails subjects text
        argSubject - the name of the subject's argument

      • renderFileNameField

        public void renderFileNameField​(MarkupOutput out,
                                java.lang.String fileName,
                                java.lang.String argFileName)
        Renders a field for the Subject's of the e-mail sent with the given subscriptions. This method can be called stand alone by passing the required arguments. It's also part of the renderElement() method that passes the global widget values properties as the arguments.
        Parameters:
        out - Where to write the widget's output
        fileName - The e-mails subjects text
        argFileName - the name of the subject's argument

      • renderObjectName

        public void renderObjectName​(MarkupOutput out,
                             java.lang.String name)
        Renders the name of the object for which the subscription is being created. This method can be called stand alone by passing the required arguments. It's also part of the renderElement() method that passes the global widget values properties as the arguments.
        Specified by:
        renderObjectName in interface DefaultSubscriptionWidget
        Parameters:
        out - Where to write the widget's output
        name - The name of the object
        Since:
        MicroStrategy Web 8.0.0

      • renderCustomMessageField

        public void renderCustomMessageField​(MarkupOutput out,
                                     java.lang.String message,
                                     java.lang.String argMessage)
        Renders a field for the Custom Message which can be sent along with the e-mail sent with the given addresses. This method can be called stand alone by passing the required arguments. It's also part of the renderElement() method that passes the global widget values properties as the arguments. This message will be sent along with the report or document which is being subscribed. It would be the first line in the email.
        Specified by:
        renderCustomMessageField in interface DefaultSubscriptionWidget
        Parameters:
        out - Where to write the widget's output
        message - The e-mails message text
        argMessage - the name of the message's argument

      • renderDeliveryFormats

        public void renderDeliveryFormats​(MarkupOutput out)
        Renders all the available formats that we can subscribe to. This could be HTML or EXCEL or PDF or any other format supported by the system. It also renders a check box which indicates if we want to compress the contents of the subscription for delivery. This method can be called stand alone by passing the required arguments. It's also part of the renderElement() method that passes the global widget values properties as the arguments. This message will be sent along with the report or document which is being subscribed.
        Parameters:
        out - Where to write the widget's output

      • renderDeliveryFormats

        public void renderDeliveryFormats​(MarkupOutput out,
                                  SimpleList availableFormats,
                                  WebSubscriptionContentFormat currentFormat,
                                  boolean compressed,
                                  java.lang.String formatArg,
                                  java.lang.String compressedArg)
        Deprecated.
        Renders all the available formats that we can subscribe to. This could be HTML or EXCEL or PDF or any other format supported by the system. It also renders a check box which indicates if we want to compress the contents of the subscription for delivery. This method can be called stand alone by passing the required arguments. It's also part of the renderElement() method that passes the global widget values properties as the arguments. This message will be sent along with the report or document which is being subscribed.
        Parameters:
        out - Where to write the widget's output
        availableFormats - All the available delivery formats
        currentFormat - The current delivery format
        compressed - Indicates if the contents of the subscription need to be compressed (zipped)
        formatArg - The name of the format's argument
        compressedArg - The name of the compression argument

      • setDevices

        public void setDevices​(SimpleList value)
        Sets the global list of devices to use for new addresses
        Specified by:
        setDevices in interface DefaultSubscriptionWidget
        Parameters:
        value - the new list of devices.

      • setAddresses

        public void setAddresses​(SimpleList value)
        The global list of addresses to use for this subscription
        Specified by:
        setAddresses in interface DefaultSubscriptionWidget
        Parameters:
        value - the new global list of addresses

      • setAddressId

        public void setAddressId​(java.lang.String value)
        Sets the value of the current addressId used when creating subscriptions to existing addresses
        Specified by:
        setAddressId in interface DefaultSubscriptionWidget
        Parameters:
        value - the new addressId

      • getAddressId

        public java.lang.String getAddressId()
        Specified by:
        getAddressId in interface DefaultSubscriptionWidget
        Returns:
        the value of the current addressId used when creating subscriptions to existing addresses

      • setNewAddressValue

        public void setNewAddressValue​(java.lang.String value)
        The value of the address list used when creating subscriptions to new addresses
        Specified by:
        setNewAddressValue in interface DefaultSubscriptionWidget
        Parameters:
        value - a comma separated list of addresses

      • getNewAddressValue

        public java.lang.String getNewAddressValue()
        Specified by:
        getNewAddressValue in interface DefaultSubscriptionWidget
        Returns:
        a comma separated list of addresses used when creating subscriptions to new addresses

      • setDeviceId

        public void setDeviceId​(java.lang.String value)
        The current deviceId. This is the device used for new addresses
        Specified by:
        setDeviceId in interface DefaultSubscriptionWidget
        Parameters:
        value - the new current deviceId

      • getDeviceId

        public java.lang.String getDeviceId()
        Specified by:
        getDeviceId in interface DefaultSubscriptionWidget
        Returns:
        The current deviceId. This is the device used for new addresses

      • setSubject

        public void setSubject​(java.lang.String value)
        Sets the text to use as the subject of the email subscriptions sent.
        Specified by:
        setSubject in interface DefaultSubscriptionWidget
        Parameters:
        value - the new subject text to use

      • setObjectName

        public void setObjectName​(java.lang.String value)
        Sets the name of the object for which the subscription is created.
        Specified by:
        setObjectName in interface DefaultSubscriptionWidget
        Parameters:
        value - the name of the object for which the subscription is created
        Since:
        MicroStrategy Web 8.0.0

      • getObjectName

        public java.lang.String getObjectName()
        Specified by:
        getObjectName in interface DefaultSubscriptionWidget
        Returns:
        the name of the object for which the subscription is created.
        Since:
        MicroStrategy Web 8.0.0

      • setCustomMessage

        public void setCustomMessage​(java.lang.String value)
        Sets the text to use as the message line of the email subscriptions sent.
        Specified by:
        setCustomMessage in interface DefaultSubscriptionWidget
        Parameters:
        value - the new message text to use

      • setIsCustomMessageAvailable

        public void setIsCustomMessageAvailable​(boolean value)
        Set to true if the the feature for Custom Message is available
        Specified by:
        setIsCustomMessageAvailable in interface DefaultSubscriptionWidget
        Parameters:
        value - true if the custom message feature is available

      • setDeviceArg

        public void setDeviceArg​(java.lang.String value)
        The name of the deviceId argument.
        Specified by:
        setDeviceArg in interface DefaultSubscriptionWidget
        Parameters:
        value - the new deviceId argument name.

      • setAddressArg

        public void setAddressArg​(java.lang.String value)
        The name of the adressId argument
        Specified by:
        setAddressArg in interface DefaultSubscriptionWidget
        Parameters:
        value - the new name for the addressId argument

      • setAddressTypeArg

        public void setAddressTypeArg​(java.lang.String value)
        The name of the adressType argument. The addressType indicates whether to use an existing addresses or a new address list
        Specified by:
        setAddressTypeArg in interface DefaultSubscriptionWidget
        Parameters:
        value - the new name for the addressType argument.

      • setNewAddressArg

        public void setNewAddressArg​(java.lang.String value)
        The name of the newAddress argument.
        Specified by:
        setNewAddressArg in interface DefaultSubscriptionWidget
        Parameters:
        value - the new newAddress argument name

      • setSubjectArg

        public void setSubjectArg​(java.lang.String value)
        The Subject's argument name.
        Specified by:
        setSubjectArg in interface DefaultSubscriptionWidget
        Parameters:
        value - The new Subject's argument name.

      • setCustomMessageArg

        public void setCustomMessageArg​(java.lang.String value)
        The Message's argument name.
        Specified by:
        setCustomMessageArg in interface DefaultSubscriptionWidget
        Parameters:
        value - The new Message's argument name.

      • setOpenAddressesEvent

        public void setOpenAddressesEvent​(WebEvent event)
        Sets the openAddress event. This event is the one used to by the application to open the address list page.
        Specified by:
        setOpenAddressesEvent in interface DefaultSubscriptionWidget
        Parameters:
        event - the new openAddress event

      • setInitialiIndent

        public void setInitialiIndent​(int value)
        Defines the initial indent the widget uses to render the content
        Specified by:
        setInitialiIndent in interface DefaultSubscriptionWidget
        Parameters:
        value - the new base indent to use

      • setSubscriptionObjectType

        public void setSubscriptionObjectType​(int subscriptionObjectType)
        Sets if the current subscription is for a report or for a document. The value is specified by the enumeration REPORT_SUBSCRIPTION or DOCUMENT_SUBSCRIPTION
        Specified by:
        setSubscriptionObjectType in interface DefaultSubscriptionWidget
        Parameters:
        subscriptionObjectType - The type of object for which we are creating the subscription

      • getSubscriptionObjectType

        public int getSubscriptionObjectType()
        Returns if the current subscription is for a report or for a document. The value is specified by the enumeration REPORT_SUBSCRIPTION or DOCUMENT_SUBSCRIPTION
        Specified by:
        getSubscriptionObjectType in interface DefaultSubscriptionWidget
        Returns:
        The type of object (report or document) for which we are creating the subscription

      • setSubscriptionObjectViewType

        public void setSubscriptionObjectViewType​(int subscriptionObjectViewType)
        Sets the view mode for the object. This can be grid/graph/grid-graph. This applies only to subscriptions to reports. The value is specified by the enumeration EnumWebReportViewMode
        Specified by:
        setSubscriptionObjectViewType in interface DefaultSubscriptionWidget
        Parameters:
        subscriptionObjectViewType - The view mode for the object we are subscribing to.

      • getSubscriptionObjectViewType

        public int getSubscriptionObjectViewType()
        Returns the view mode for the object. This can be grid/graph/grid-graph. This applies only to subscriptions to reports. The value is specified by the enumeration EnumWebReportViewMode
        Specified by:
        getSubscriptionObjectViewType in interface DefaultSubscriptionWidget
        Returns:
        The view mode for the object we are subscribing to.

      • setAvailableFormats

        public void setAvailableFormats​(SimpleList availableFormats)
        Sets all the available formats for subscription in this system. This could be HTML or EXCEL or PDF or any other such format.
        Specified by:
        setAvailableFormats in interface DefaultSubscriptionWidget
        Parameters:
        availableFormats - The available formats for subscription.

      • getAvailableFormats

        public SimpleList getAvailableFormats()
        Returns all the available formats for subscription in this system. This could be HTML or EXCEL or PDF or any other such format.
        Specified by:
        getAvailableFormats in interface DefaultSubscriptionWidget
        Returns:
        The available formats for subscription.

      • setCurrentFormat

        public void setCurrentFormat​(WebSubscriptionContentFormat currentFormat)
        Sets the current format for this subscription used when creating the subscription. This could be HTML or EXCEL or PDF or any other such format.
        Specified by:
        setCurrentFormat in interface DefaultSubscriptionWidget
        Parameters:
        currentFormat - The current subscription format.

      • setCompressed

        public void setCompressed​(boolean compressed)
        Sets if the current subscription is supposed to be delivered in the compressed(zipped) format.
        Specified by:
        setCompressed in interface DefaultSubscriptionWidget
        Parameters:
        compressed - Set to true if the subscription is to be delivered in compressed form.

      • getCompressed

        public boolean getCompressed()
        Returns true if the current subscription is supposed to be delivered in the compressed(zipped) format.
        Specified by:
        getCompressed in interface DefaultSubscriptionWidget
        Returns:
        true if the subscription is to be delivered in the compressed form.

      • setFormatArg

        public void setFormatArg​(java.lang.String value)
        The Format's argument name.
        Specified by:
        setFormatArg in interface DefaultSubscriptionWidget
        Parameters:
        value - The argument name for the subscription format.

      • setCompressedArg

        public void setCompressedArg​(java.lang.String value)
        The argument name to for the Compressed value.
        Specified by:
        setCompressedArg in interface DefaultSubscriptionWidget
        Parameters:
        value - The argument name for the Compressed value.

      • setImageBasePath

        public void setImageBasePath​(java.lang.String value)
        The name of the base path for images
        Specified by:
        setImageBasePath in interface DefaultSubscriptionWidget
        Parameters:
        value - name of the base path for images
        Since:
        MicroStrategy Web 7.5.1

      • getImageBasePath

        public java.lang.String getImageBasePath()
        Specified by:
        getImageBasePath in interface DefaultSubscriptionWidget
        Returns:
        The name of the image basepath
        Since:
        MicroStrategy Web 7.5.1

      • setIsRWD

        public void setIsRWD​(boolean value)
        Indicated whether it is an RWD or not.
        Specified by:
        setIsRWD in interface DefaultSubscriptionWidget
        Parameters:
        value - true if it is an RWD.
        Since:
        MicroStrategy Web 7.5.1

      • setIsCreateEmailAvailable

        public void setIsCreateEmailAvailable​(boolean value)
        Set to true if the feature for creating new email addresses is available.
        Specified by:
        setIsCreateEmailAvailable in interface DefaultSubscriptionWidget
        Parameters:
        value - true if the feature for creating new email addresses is available.
        Since:
        MicroStrategy Web 7.5.1

      • getIsCreateEmailAvailable

        public boolean getIsCreateEmailAvailable()
        Specified by:
        getIsCreateEmailAvailable in interface DefaultSubscriptionWidget
        Returns:
        true if the feature for creating new email addresses is available.
        Since:
        MicroStrategy Web 7.5.1

      • renderNotificationAddressList

        public void renderNotificationAddressList​(MarkupOutput out,
                                          SimpleList addresses,
                                          java.lang.String addressId,
                                          java.lang.String addressArg,
                                          java.lang.String addressTypeArg,
                                          java.lang.String newAddressValue,
                                          java.lang.String newAddressArg,
                                          SimpleList devices,
                                          java.lang.String deviceId,
                                          java.lang.String deviceArg,
                                          boolean bUseNotification)
        Renders the list of Notification addresses for the Subscription. This method can be called stand alone by passing the required arguments. It's also part of the renderElement() method that passes the global widget values properties as the arguments.
        Parameters:
        out - Where to write the widget's output
        addresses - the list of addresses
        addressId - the id of the current address
        addressArg - the name of the addressId arg
        addressTypeArg - the name of the addressType arg
        newAddressValue - the value for the new address list
        newAddressArg - the name of the new address list argument
        devices - the list of devices
        deviceId - the current deviceId
        deviceArg - the name of the deviceId argument
        bUseNotification - the boolean argument to denote whether the subscription uses notification
        Since:
        MicroStrategy Web 8.0.0

      • setNotificationDevices

        public void setNotificationDevices​(SimpleList value)
        Sets the global list of notification devices to use for new addresses
        Parameters:
        value - the new list of notification devices.
        Since:
        MicroStrategy Web 8.0.0

      • getNotificationDevices

        public SimpleList getNotificationDevices()
        Returns:
        the current global list of Notification devices.
        Since:
        MicroStrategy Web 8.0.0

      • setNotificationAddresses

        public void setNotificationAddresses​(SimpleList value)
        The global list of notification addresses to use for this subscription
        Parameters:
        value - the new global list of notification addresses
        Since:
        MicroStrategy Web 8.0.0

      • getNotificationAddresses

        public SimpleList getNotificationAddresses()
        Returns:
        the current global list of notification addresses
        Since:
        MicroStrategy Web 8.0.0

      • setNotificationAddressId

        public void setNotificationAddressId​(java.lang.String value)
        Sets the value of the current notification addressId used when creating subscriptions to existing addresses
        Parameters:
        value - the new notification addressId
        Since:
        MicroStrategy Web 8.0.0

      • getNotificationAddressId

        public java.lang.String getNotificationAddressId()
        Returns:
        the value of the current Notification addressId used when creating subscriptions to existing addresses
        Since:
        MicroStrategy Web 8.0.0

      • setNotificationNewAddressValue

        public void setNotificationNewAddressValue​(java.lang.String value)
        The value of the notification address list used when creating subscriptions to new addresses
        Parameters:
        value - a comma separated list of notification addresses
        Since:
        MicroStrategy Web 8.0.0

      • getNotificationNewAddressValue

        public java.lang.String getNotificationNewAddressValue()
        Returns:
        a comma separated list of notification addresses used when creating subscriptions to new addresses
        Since:
        MicroStrategy Web 8.0.0

      • setNotificationDeviceId

        public void setNotificationDeviceId​(java.lang.String value)
        The current notification deviceId. This is the device used for new addresses
        Parameters:
        value - the new current notification deviceId
        Since:
        MicroStrategy Web 8.0.0

      • getNotificationDeviceId

        public java.lang.String getNotificationDeviceId()
        Returns:
        The current notification deviceId. This is the device used for new addresses
        Since:
        MicroStrategy Web 8.0.0

      • setNotificationAddressArg

        public void setNotificationAddressArg​(java.lang.String value)
        The name of the notification adressId argument
        Parameters:
        value - the new name for the notification addressId argument
        Since:
        MicroStrategy Web 8.0.0

      • getNotificationAddressArg

        public java.lang.String getNotificationAddressArg()
        Returns:
        The name of the notification addressId argument
        Since:
        MicroStrategy Web 8.0.0

      • setNotificationAddressTypeArg

        public void setNotificationAddressTypeArg​(java.lang.String value)
        The name of the notification adressType argument. The addressType indicates whether to use an existing addresses or a new address list
        Parameters:
        value - the new name for the notification addressType argument.
        Since:
        MicroStrategy Web 8.0.0

      • getNotificationAddressTypeArg

        public java.lang.String getNotificationAddressTypeArg()
        Returns:
        the name for the notification addressType argument.
        Since:
        MicroStrategy Web 8.0.0

      • setNotificationDeviceArg

        public void setNotificationDeviceArg​(java.lang.String value)
        The name of the notification deviceId argument.
        Parameters:
        value - the new notification deviceId argument name.
        Since:
        MicroStrategy Web 8.0.0

      • getNotificationDeviceArg

        public java.lang.String getNotificationDeviceArg()
        Returns:
        The notification deviceId argument name.
        Since:
        MicroStrategy Web 8.0.0

      • setNotificationNewAddressArg

        public void setNotificationNewAddressArg​(java.lang.String value)
        The name of the notification newAddress argument.
        Parameters:
        value - the new notification newAddress argument name
        Since:
        MicroStrategy Web 8.0.0

      • getNotificationNewAddressArg

        public java.lang.String getNotificationNewAddressArg()
        Returns:
        the notification newAddress argument name
        Since:
        MicroStrategy Web 8.0.0

      • setUseDeliveryNotification

        public void setUseDeliveryNotification​(boolean value)
        Set to true if delivery notification is currently used.
        Parameters:
        value - true if delivery notification is currently used.
        Since:
        MicroStrategy Web 8.0.0

      • getUseDeliveryNotification

        public boolean getUseDeliveryNotification()
        Returns:
        true if delivery notification is currently used.
        Since:
        MicroStrategy Web 8.0.0

      • setUseDeliveryNotificationArg

        public void setUseDeliveryNotificationArg​(java.lang.String value)
        The name of the useDeliveryNotification argument.
        Parameters:
        value - the new useDeliveryNotification argument name.
        Since:
        MicroStrategy Web 8.0.0

      • getUseDeliveryNotificationArg

        public java.lang.String getUseDeliveryNotificationArg()
        Returns:
        The useDeliveryNotification argument name.
        Since:
        MicroStrategy Web 8.0.0

      • setIsDeliveryNotificationAvailable

        public void setIsDeliveryNotificationAvailable​(boolean value)
        Set to true if delivery notification is available.
        Parameters:
        value - true if delivery notification is available.
        Since:
        MicroStrategy Web 8.0.0

      • getIsDeliveryNotificationAvailable

        public boolean getIsDeliveryNotificationAvailable()
        Returns:
        true if delivery notification is available.
        Since:
        MicroStrategy Web 8.0.0

      • setIsExpandPageByAvailable

        public void setIsExpandPageByAvailable​(boolean value)
        Set to true if the expand pageby option is available.
        Specified by:
        setIsExpandPageByAvailable in interface DefaultSubscriptionWidget
        Parameters:
        value - true if the expand pageby option is available.
        Since:
        MicroStrategy Web 8.0.0

      • setExpandPageByArg

        public void setExpandPageByArg​(java.lang.String value)
        The argument name for the expand pageBy.
        Specified by:
        setExpandPageByArg in interface DefaultSubscriptionWidget
        Parameters:
        value - The argument name for the Compressed value.
        Since:
        MicroStrategy Web 8.0.0

      • setExpandPageBy

        public void setExpandPageBy​(int value)
        The value for the expand pageBy.
        Specified by:
        setExpandPageBy in interface DefaultSubscriptionWidget
        Parameters:
        value - The new value for the expand pageBy.
        Since:
        MicroStrategy Web 8.0.0

      • getExpandPageBy

        public int getExpandPageBy()
        Specified by:
        getExpandPageBy in interface DefaultSubscriptionWidget
        Returns:
        The expand pageby value for the subscription.
        Since:
        MicroStrategy Web 8.0.0

      • setExpandUseSeparateSheetsArg

        public void setExpandUseSeparateSheetsArg​(java.lang.String value)
        The argument name for the expand use separate sheets.
        Specified by:
        setExpandUseSeparateSheetsArg in interface DefaultSubscriptionWidget
        Parameters:
        value - The argument name for the Compressed value.
        Since:
        MicroStrategy Web 8.0.1

      • setExpandUseSeparateSheets

        public void setExpandUseSeparateSheets​(int value)
        The value for the expand use separate sheets.
        Specified by:
        setExpandUseSeparateSheets in interface DefaultSubscriptionWidget
        Parameters:
        value - The new value for the expand use separate sheets.
        Since:
        MicroStrategy Web 8.0.1

      • getLocationID

        public java.lang.String getLocationID()
        Specified by:
        getLocationID in interface DefaultSubscriptionWidget
        Returns:
        the current locationID value
        Since:
        MicroStrategy Web 8.1.0

      • setLocationID

        public void setLocationID​(java.lang.String value)
        Description copied from interface: DefaultSubscriptionWidget
        Sets the id of the current location. A location is an address-device tuple.
        Specified by:
        setLocationID in interface DefaultSubscriptionWidget
        Parameters:
        value - the new value for the current location
        Since:
        MicroStrategy Web 8.1.0

      • setLocationArg

        public void setLocationArg​(java.lang.String value)
        Description copied from interface: DefaultSubscriptionWidget
        The name of the location argument. A location is an address-device tuple.
        Specified by:
        setLocationArg in interface DefaultSubscriptionWidget
        Parameters:
        value - the new name for the location argument
        Since:
        MicroStrategy Web 8.1.0

      • getLocationArg

        public java.lang.String getLocationArg()
        Specified by:
        getLocationArg in interface DefaultSubscriptionWidget
        Returns:
        the name for the location argument.
        Since:
        MicroStrategy Web 8.1.0

      • setCompressedFileName

        public void setCompressedFileName​(java.lang.String compressedFileName)
        Specified by:
        setCompressedFileName in interface DefaultSubscriptionWidget
        Parameters:
        compressedFileName - The compressed file name .

      • setCompressedFileNameArg

        public void setCompressedFileNameArg​(java.lang.String compressedFileNameArg)
        Specified by:
        setCompressedFileNameArg in interface DefaultSubscriptionWidget
        Parameters:
        compressedFileNameArg - The compressed file name arg.

      • setIServerAsNCSSource

        public void setIServerAsNCSSource()
        Description copied from interface: DefaultSubscriptionWidget
        used to convey to the widget that IServer is hosting the ncs functionality. If this is not called, widget assumes NCS Engine (old NCS) to be the backend. and disables old functionalities
        Specified by:
        setIServerAsNCSSource in interface DefaultSubscriptionWidget

      • getIncludeLinkArg

        public java.lang.String getIncludeLinkArg()

      • getSendToInboxArg

        public java.lang.String getSendToInboxArg()

      • getIncludeDataArg

        public java.lang.String getIncludeDataArg()

      • getZipPasswordArg

        public java.lang.String getZipPasswordArg()

      • getExpirationDateArg

        public java.lang.String getExpirationDateArg()

      • getChangeableMaskArg

        public java.lang.String getChangeableMaskArg()

      • getProtectZipFileArg

        public java.lang.String getProtectZipFileArg()

      • getAllowChangePersonalizationArg

        public java.lang.String getAllowChangePersonalizationArg()

      • getAllowChangeDeliverySettingsArg

        public java.lang.String getAllowChangeDeliverySettingsArg()

      • getAllowUnsubscribeArg

        public java.lang.String getAllowUnsubscribeArg()