Interface WebSubscriptionDeliveryModeEmailProperties

    • Method Detail

      • getEmailSubject

        java.lang.String getEmailSubject()
        Returns:
        the email subject associated with this subscription
      • setEmailSubject

        void setEmailSubject​(java.lang.String subject)
        Sets the email subject associated with this subscription
        Parameters:
        subject - The string that should be used as the subject
      • getEmailMessage

        java.lang.String getEmailMessage()
        Returns:
        the email subject associated with this subscription
      • setEmailMessage

        void setEmailMessage​(java.lang.String message)
        Sets the email message associated with this subscription
        Parameters:
        message - The string that should be used as the subject
      • getZipFileName

        java.lang.String getZipFileName()
        Sets the name of the compressed file associated with this subscription
        Since:
        MicroStrategy Web 9.0.0
      • setZipFileName

        void setZipFileName​(java.lang.String fileName)
        Returns the name of the compressed file saved in the subscrription
        Parameters:
        fileName -
        Since:
        MicroStrategy Web 9.0.0
      • getFileName

        java.lang.String getFileName()
        Returns the name of the file that will be delivered when the subscription is executed
        Since:
        MicroStrategy Web 9.0.0
      • setFileName

        void setFileName​(java.lang.String fileName)
        Sets the name of the file that will be delivered when the subscription is executed
        Parameters:
        fileName -
        Since:
        MicroStrategy Web 9.0.0
      • isCompressed

        boolean isCompressed()
        Returns whether the content that is delivered is compressed or not
        Since:
        MicroStrategy Web 9.0.0
      • setCompression

        void setCompression​(boolean isCompressed)
        Sets whether the content that is delivered is compressed or not
        Parameters:
        isCompressed -
        Since:
        MicroStrategy Web 9.0.0
      • isLinkIncluded

        boolean isLinkIncluded()
        Returns whether the subscription is configured to return a link to the message in the history list
        Since:
        MicroStrategy Web 9.0.0
      • setIncludeLink

        void setIncludeLink​(boolean value)
        Configures whether a link to the history list is included in the delivered subscription
        Parameters:
        value -
        Since:
        MicroStrategy Web 9.0.0
      • isDataIncluded

        boolean isDataIncluded()
        Returns whether the subscription is configured to include 'data'
        Since:
        MicroStrategy Web 9.0.0
      • setIncludeData

        void setIncludeData​(boolean value)
        Configures whether the subscription should include data in the delivered email.
        Parameters:
        value -
        Since:
        MicroStrategy Web 9.0.0
      • isSendToInbox

        boolean isSendToInbox()
        Returns whether the subscription is configured to add the delivered message to history list as well.
        Since:
        MicroStrategy Web 9.0.0
      • setSendToInbox

        void setSendToInbox​(boolean value)
        Configures whether the subscription adds the message to history list when it is executed
        Parameters:
        value -
        Since:
        MicroStrategy Web 9.0.0
      • setZipFilePassword

        void setZipFilePassword​(java.lang.String p)
        Sets the password of the compressed file.
        Parameters:
        p -
        Since:
        MicroStrategy Web 9.0.0
      • getZipFilePassword

        java.lang.String getZipFilePassword()
        Returns the password of the compressed file.
        Since:
        MicroStrategy Web 9.0.0
      • setHistoryLinkURL

        void setHistoryLinkURL​(java.lang.String url)
        Sets the URL for the link to history list. This URL should contain macros like {&WEBSERVER}, {&SERVERNAME} etc which are replaced at run-time when the subscription or the delivery notification is sent to the recipient.
        Parameters:
        url -
        Since:
        MicroStrategy Web 9.0.0
      • setHistoryLinkWebServer

        void setHistoryLinkWebServer​(java.lang.String webserver)
        This property stores the default web-server location when the user creates a subscription. In a normal execution flow, the web-server location is obtained from a property in the DefaultProjectProperties property set. However if this property is not set, then the default web-server location that is saved along with each subscription is used.
        Parameters:
        webserver -
        Since:
        MicroStrategy Web 9.0.0
      • setProtectZipFile

        void setProtectZipFile​(boolean isProtected)
        Sets whether the compressed file is password protected.
        Parameters:
        isProtected -
        Since:
        MicroStrategy Web 9.0.0
      • isZipFileProtected

        boolean isZipFileProtected()
        Returns whether the compressed file is password protected
        Since:
        MicroStrategy Web 9.0.0
      • setOverwriteOlderVersion

        void setOverwriteOlderVersion​(boolean overwrite)
        Sets whether the subscription will overwrite earlier versions of the same report or document in the history list
        Parameters:
        overwrite -
      • isOverwriteOlderVersion

        boolean isOverwriteOlderVersion()
        Returns whether the current subscription will overwrite earlier versions of the same report or document in the history list
      • getSpaceDelimiter

        java.lang.String getSpaceDelimiter()
        Returns the space delimiter
      • setSpaceDelimiter

        void setSpaceDelimiter​(java.lang.String spaceDelimiter)
        Sets the space delimiter