Package com.microstrategy.web.app.gui

Interface DefaultSubscriptionWidget

    • Method Detail

      • renderAddressList

        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)
        Deprecated.
        Renders the list of addresses for the e-mail. 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

      • renderSubjectField

        void renderSubjectField​(MarkupOutput out,
                        java.lang.String subject,
                        java.lang.String argSubject)
        Deprecated.
        Renders a field for the Subject's of 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.
        Parameters:
        out - Where to write the widget's output
        subject - The e-mails subjects text
        argSubject - the name of the subject's argument

      • renderCustomMessageField

        void renderCustomMessageField​(MarkupOutput out,
                              java.lang.String message,
                              java.lang.String argMessage)
        Deprecated.
        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.
        Parameters:
        out - Where to write the widget's output
        message - The e-mails message text
        argMessage - the name of the message's argument

      • setDevices

        void setDevices​(SimpleList value)
        Deprecated.
        Sets the global list of devices to use for new addresses
        Parameters:
        value - the new list of devices.

      • getDevices

        SimpleList getDevices()
        Deprecated.
        Returns:
        the current global list of devices.

      • setAddresses

        void setAddresses​(SimpleList value)
        Deprecated.
        The global list of addresses to use for this subscription
        Parameters:
        value - the new global list of addresses

      • getAddresses

        SimpleList getAddresses()
        Deprecated.
        Returns:
        the current global list of addresses

      • setAddressId

        @Deprecated
void setAddressId​(java.lang.String value)
        Deprecated.
        replaced by setLocationID(String)
        Sets the value of the current addressId used when creating subscriptions to existing addresses
        Parameters:
        value - the new addressId

      • getAddressId

        @Deprecated
java.lang.String getAddressId()
        Deprecated.
        replaced by getLocationID()
        Returns:
        the value of the current addressId used when creating subscriptions to existing addresses

      • setNewAddressValue

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

      • getNewAddressValue

        java.lang.String getNewAddressValue()
        Deprecated.
        Returns:
        a comma separated list of addresses used when creating subscriptions to new addresses

      • setDeviceId

        void setDeviceId​(java.lang.String value)
        Deprecated.
        The current deviceId. This is the device used for new addresses
        Parameters:
        value - the new current deviceId

      • getDeviceId

        java.lang.String getDeviceId()
        Deprecated.
        Returns:
        The current deviceId. This is the device used for new addresses

      • setSubject

        void setSubject​(java.lang.String value)
        Deprecated.
        Sets the text to use as the subject of the email subscriptions sent.
        Parameters:
        value - the new subject text to use

      • getSubject

        java.lang.String getSubject()
        Deprecated.
        Returns:
        the subject text of new subscriptions created.

      • setCustomMessage

        void setCustomMessage​(java.lang.String value)
        Deprecated.
        Sets the text to use as the message line of the email subscriptions sent.
        Parameters:
        value - the new message text to use

      • getCustomMessage

        java.lang.String getCustomMessage()
        Deprecated.
        Returns:
        the message text of new subscriptions created.

      • setIsCustomMessageAvailable

        void setIsCustomMessageAvailable​(boolean value)
        Deprecated.
        Set to true if the the feature for Custom Message is available
        Parameters:
        value - true if the custom message feature is available

      • getIsCustomMessageAvailable

        boolean getIsCustomMessageAvailable()
        Deprecated.
        Returns:
        true if the custom message feature is available.

      • setAddressArg

        void setAddressArg​(java.lang.String value)
        Deprecated.
        The name of the adressId argument
        Parameters:
        value - the new name for the addressId argument

      • getAddressArg

        java.lang.String getAddressArg()
        Deprecated.
        Returns:
        The name of the addressId argument

      • setAddressTypeArg

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

      • getAddressTypeArg

        java.lang.String getAddressTypeArg()
        Deprecated.
        Returns:
        the name for the addressType argument.

      • setNewAddressArg

        void setNewAddressArg​(java.lang.String value)
        Deprecated.
        The name of the newAddress argument.
        Parameters:
        value - the new newAddress argument name

      • getNewAddressArg

        java.lang.String getNewAddressArg()
        Deprecated.
        Returns:
        the newAddress argument name

      • setDeviceArg

        void setDeviceArg​(java.lang.String value)
        Deprecated.
        The name of the deviceId argument.
        Parameters:
        value - the new deviceId argument name.

      • getDeviceArg

        java.lang.String getDeviceArg()
        Deprecated.
        Returns:
        The deviceId argument name.

      • setSubjectArg

        void setSubjectArg​(java.lang.String value)
        Deprecated.
        The Subject's argument name.
        Parameters:
        value - The new Subject's argument name.

      • getSubjectArg

        java.lang.String getSubjectArg()
        Deprecated.
        Returns:
        The Subject's argument name.

      • setCustomMessageArg

        void setCustomMessageArg​(java.lang.String value)
        Deprecated.
        The Message's argument name.
        Parameters:
        value - The new Message's argument name.

      • getCustomMessageArg

        java.lang.String getCustomMessageArg()
        Deprecated.
        Returns:
        The Message's argument name.

      • setOpenAddressesEvent

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

      • getOpenAddressesEvent

        WebEvent getOpenAddressesEvent()
        Deprecated.
        Returns:
        the current openAddress event

      • setInitialiIndent

        void setInitialiIndent​(int value)
        Deprecated.
        Defines the initial indent the widget uses to render the content
        Parameters:
        value - the new base indent to use

      • getInitialiIndent

        int getInitialiIndent()
        Deprecated.
        Returns:
        The current base indent use by the widget to render its content.

      • setSubscriptionObjectType

        void setSubscriptionObjectType​(int subscriptionObjectType)
        Deprecated.
        Sets if the current subscription is for a report or for a document. The value is specified by the enumeration EnumWebSubscriptionContentTypes
        Parameters:
        subscriptionObjectType - The type of object for which we are creating the subscription

      • getSubscriptionObjectType

        int getSubscriptionObjectType()
        Deprecated.
        Returns if the current subscription is for a report or for a document. The value is specified by the enumeration EnumWebSubscriptionContentTypes
        Returns:
        The type of object (report or document) for which we are creating the subscription

      • setSubscriptionObjectViewType

        void setSubscriptionObjectViewType​(int subscriptionObjectViewType)
        Deprecated.
        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
        Parameters:
        subscriptionObjectViewType - The view mode for the object we are subscribing to.

      • getSubscriptionObjectViewType

        int getSubscriptionObjectViewType()
        Deprecated.
        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
        Returns:
        The view mode for the object we are subscribing to.

      • setAvailableFormats

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

      • getAvailableFormats

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

      • setCurrentFormat

        void setCurrentFormat​(WebSubscriptionContentFormat currentFormat)
        Deprecated.
        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.
        Parameters:
        currentFormat - The current subscription format.

      • getCurrentFormat

        WebSubscriptionContentFormat getCurrentFormat()
        Deprecated.
        Returns the current format for this subscription used when creating the subscription. This could be HTML or EXCEL or PDF or any other such format.
        Returns:
        The current subscription format.

      • setCompressed

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

      • getCompressed

        boolean getCompressed()
        Deprecated.
        Returns true if the current subscription is supposed to be delivered in the compressed(zipped) format.
        Returns:
        true if the subscription is to be delivered in the compressed form.

      • setFormatArg

        void setFormatArg​(java.lang.String value)
        Deprecated.
        The Format's argument name.
        Parameters:
        value - The argument name for the subscription format.

      • getFormatArg

        java.lang.String getFormatArg()
        Deprecated.
        Returns:
        The Format's argument name.

      • setCompressedArg

        void setCompressedArg​(java.lang.String value)
        Deprecated.
        The argument name to for the Compressed value.
        Parameters:
        value - The argument name for the Compressed value.

      • getCompressedArg

        java.lang.String getCompressedArg()
        Deprecated.
        Returns:
        The Compressed argument name.

      • setImageBasePath

        void setImageBasePath​(java.lang.String value)
        Deprecated.
        The name of the base path for images
        Parameters:
        value - name of the base path for images

      • getImageBasePath

        java.lang.String getImageBasePath()
        Deprecated.
        Returns:
        The name of the image basepath

      • setIsCreateEmailAvailable

        void setIsCreateEmailAvailable​(boolean value)
        Deprecated.
        Set to true if the feature for creating new email addresses is available.
        Parameters:
        value - true if the feature for creating new email addresses is available.

      • getIsCreateEmailAvailable

        boolean getIsCreateEmailAvailable()
        Deprecated.
        Returns:
        true if the feature for creating new email addresses is available.

      • setIsRWD

        void setIsRWD​(boolean value)
        Deprecated.
        Set to true if the current object is a RW Document.
        Parameters:
        value - true if the feature for creating new email addresses is available.

      • getIsRWD

        boolean getIsRWD()
        Deprecated.
        Returns:
        true if the current object is a RW Document.

      • renderObjectName

        void renderObjectName​(MarkupOutput out,
                      java.lang.String name)
        Deprecated.
        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.
        Parameters:
        out - Where to write the widget's output
        name - The name of the object

      • setObjectName

        void setObjectName​(java.lang.String value)
        Deprecated.
        Sets the name of the object for which the subscription is created.
        Parameters:
        value - the name of the object for which the subscription is created

      • getObjectName

        java.lang.String getObjectName()
        Deprecated.
        Returns:
        the name of the object for which the subscription is created.

      • setIsExpandPageByAvailable

        void setIsExpandPageByAvailable​(boolean value)
        Deprecated.
        Set to true if the expand pageby option is available.
        Parameters:
        value - true if the expand pageby option is available.

      • getIsExpandPageByAvailable

        boolean getIsExpandPageByAvailable()
        Deprecated.
        Returns:
        true if the expand page by option is available.

      • setExpandPageByArg

        void setExpandPageByArg​(java.lang.String value)
        Deprecated.
        The argument name for the expand pageBy.
        Parameters:
        value - The argument name for the expand pageBy.

      • getExpandPageByArg

        java.lang.String getExpandPageByArg()
        Deprecated.
        Returns:
        The expand pageby argument name.

      • setExpandPageBy

        void setExpandPageBy​(int value)
        Deprecated.
        The value for the expand pageBy.
        Parameters:
        value - The new value for the expand pageBy.

      • getExpandPageBy

        int getExpandPageBy()
        Deprecated.
        Returns:
        The expand pageby value for the subscription.

      • setExpandUseSeparateSheetsArg

        void setExpandUseSeparateSheetsArg​(java.lang.String value)
        Deprecated.
        The argument name for the use separate sheets.
        Parameters:
        value - The argument name for the use separate sheets.
        Since:
        MicroStrategy Web 8.0.1

      • getExpandUseSeparateSheetsArg

        java.lang.String getExpandUseSeparateSheetsArg()
        Deprecated.
        Returns:
        The expand use separate sheets argument name.
        Since:
        MicroStrategy Web 8.0.1

      • setExpandUseSeparateSheets

        void setExpandUseSeparateSheets​(int value)
        Deprecated.
        The value for the expand use separate sheets.
        Parameters:
        value - The new value for the expand use separate sheets.
        Since:
        MicroStrategy Web 8.0.1

      • getExpandUseSeparateSheets

        int getExpandUseSeparateSheets()
        Deprecated.
        Returns:
        The expand use separate sheets value for the subscription.
        Since:
        MicroStrategy Web 8.0.1

      • getLocationID

        java.lang.String getLocationID()
        Deprecated.
        Returns:
        the current locationID value
        Since:
        MicroStrategy Web 8.1.0

      • setLocationID

        void setLocationID​(java.lang.String value)
        Deprecated.
        Sets the id of the current location. A location is an address-device tuple.
        Parameters:
        value - the new value for the current location
        Since:
        MicroStrategy Web 8.1.0

      • setLocationArg

        void setLocationArg​(java.lang.String value)
        Deprecated.
        The name of the location argument. A location is an address-device tuple.
        Parameters:
        value - the new name for the location argument
        Since:
        MicroStrategy Web 8.1.0

      • getLocationArg

        java.lang.String getLocationArg()
        Deprecated.
        Returns:
        the name for the location argument.
        Since:
        MicroStrategy Web 8.1.0

      • setAvailableLocations

        void setAvailableLocations​(SimpleList value)
        Deprecated.
        Sets the list of available locations for the file subscription.
        Parameters:
        value - list of available locations for the file subscription.
        Since:
        MicroStrategy Web 8.1.0

      • getAvailableLocations

        SimpleList getAvailableLocations()
        Deprecated.
        Returns:
        list of available locations for the file subscription.
        Since:
        MicroStrategy Web 8.1.0

      • setFileName

        void setFileName​(java.lang.String fileName)
        Deprecated.
        Parameters:
        fileName - The file name
        Since:
        MicroStrategy Web 9.0.0

      • setFileNameArg

        void setFileNameArg​(java.lang.String fileNameArg)
        Deprecated.
        Parameters:
        fileNameArg - The file name arg.
        Since:
        MicroStrategy Web 9.0.0

      • getFileNameArg

        java.lang.String getFileNameArg()
        Deprecated.
        Returns:
        The file name.
        Since:
        MicroStrategy Web 9.0.0

      • getFileName

        java.lang.String getFileName()
        Deprecated.
        Returns:
        The file name.
        Since:
        MicroStrategy Web 9.0.0

      • setCompressedFileName

        void setCompressedFileName​(java.lang.String fileName)
        Deprecated.
        Parameters:
        fileName - The compressed file name .
        Since:
        MicroStrategy Web 9.0.0

      • getCompressedFileName

        java.lang.String getCompressedFileName()
        Deprecated.
        Returns:
        The file name.
        Since:
        MicroStrategy Web 9.0.0

      • setCompressedFileNameArg

        void setCompressedFileNameArg​(java.lang.String fileNameArg)
        Deprecated.
        Parameters:
        fileNameArg - The compressed file name arg.
        Since:
        MicroStrategy Web 9.0.0

      • getCompressedFileNameArg

        java.lang.String getCompressedFileNameArg()
        Deprecated.
        Returns:
        The compressed file name arg.
        Since:
        MicroStrategy Web 9.0.0

      • setIServerAsNCSSource

        void setIServerAsNCSSource()
        Deprecated.
        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
        Since:
        MicroStrategy Web 9.0.0

      • setIncludeLink

        void setIncludeLink​(boolean includeLink)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setIncludeLinkArg

        void setIncludeLinkArg​(java.lang.String arg)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • isIncludeLinkSet

        boolean isIncludeLinkSet()
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setSendToInbox

        void setSendToInbox​(boolean sendToInbox)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setSendToInboxArg

        void setSendToInboxArg​(java.lang.String arg)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • isSendToInboxSet

        boolean isSendToInboxSet()
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setIncludeData

        void setIncludeData​(boolean includeData)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setIncludeDataArg

        void setIncludeDataArg​(java.lang.String arg)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • isIncludeDataSet

        boolean isIncludeDataSet()
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setZipPassword

        void setZipPassword​(java.lang.String zipP)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setZipPasswordArg

        void setZipPasswordArg​(java.lang.String arg)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • getZipPassword

        java.lang.String getZipPassword()
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setExpirationDate

        void setExpirationDate​(java.lang.String expirationDate)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setExpirationDateArg

        void setExpirationDateArg​(java.lang.String arg)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • getExpirationDate

        java.lang.String getExpirationDate()
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setProtectZipFile

        void setProtectZipFile​(boolean value)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setProtectZipFileArg

        void setProtectZipFileArg​(java.lang.String arg)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • isProtectZipFile

        boolean isProtectZipFile()
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setAllowChangeDeliverySettingsArg

        void setAllowChangeDeliverySettingsArg​(java.lang.String arg)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setAllowChangePersonalizationArg

        void setAllowChangePersonalizationArg​(java.lang.String arg)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setAllowUnsubscribeArg

        void setAllowUnsubscribeArg​(java.lang.String arg)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setOpenContactsBrowserEvent

        void setOpenContactsBrowserEvent​(WebEvent openContactsEditorEvent)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setOpenContactsBrowser

        void setOpenContactsBrowser​(boolean openContactsBrowser)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0