Package com.microstrategy.web.app.gui

Interface SubscriptionFileWidget

    • Method Detail

      • setIsBulkExport

        void setIsBulkExport​(boolean value)
        Deprecated.
        Set to true if the current object is a bulk export report.
        Parameters:
        value - true current object is a bulk export report.
        Since:
        MicroStrategy Web 8.0.0

      • renderAvailableLocations

        void renderAvailableLocations​(MarkupOutput out,
                              SimpleList locations,
                              java.lang.String locationID,
                              java.lang.String argLocation)
        Deprecated.
        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.
        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

      • renderNotificationAddressList

        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)
        Deprecated.
        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.
        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

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

      • getNotificationDevices

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

      • setNotificationAddresses

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

      • getNotificationAddresses

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

      • setNotificationAddressId

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

      • getNotificationAddressId

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

      • setNotificationNewAddressValue

        void setNotificationNewAddressValue​(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
        Since:
        MicroStrategy Web 8.0.0

      • getNotificationNewAddressValue

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

      • setNotificationDeviceId

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

      • getNotificationDeviceId

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

      • setNotificationAddressArg

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

      • getNotificationAddressArg

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

      • setNotificationAddressTypeArg

        void setNotificationAddressTypeArg​(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.
        Since:
        MicroStrategy Web 8.0.0

      • getNotificationAddressTypeArg

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

      • setNotificationDeviceArg

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

      • getNotificationDeviceArg

        java.lang.String getNotificationDeviceArg()
        Deprecated.
        Returns:
        The deviceId argument name for new addresses.
        Since:
        MicroStrategy Web 8.0.0

      • setNotificationNewAddressArg

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

      • getNotificationNewAddressArg

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

      • setUseDeliveryNotification

        void setUseDeliveryNotification​(boolean value)
        Deprecated.
        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

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

      • setUseDeliveryNotificationArg

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

      • getUseDeliveryNotificationArg

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

      • setIsDeliveryNotificationAvailable

        void setIsDeliveryNotificationAvailable​(boolean value)
        Deprecated.
        Set to true if the feature for creating delivery notification is available.
        Parameters:
        value - true if the feature for creating new email addresses is available.
        Since:
        MicroStrategy Web 8.0.0

      • getIsDeliveryNotificationAvailable

        boolean getIsDeliveryNotificationAvailable()
        Deprecated.
        Returns:
        true if the feature for creating delivery notification is available.
        Since:
        MicroStrategy Web 8.0.0

      • setFileName

        void setFileName​(java.lang.String value)
        Deprecated.
        Sets the name of the file to which the export will be sent.
        Specified by:
        setFileName in interface DefaultSubscriptionWidget
        Parameters:
        value - the name of the file to which the export will be sent.

      • getFileName

        java.lang.String getFileName()
        Deprecated.
        Specified by:
        getFileName in interface DefaultSubscriptionWidget
        Returns:
        the name of the file to which the export will be sent.

      • setFileNameArg

        void setFileNameArg​(java.lang.String value)
        Deprecated.
        The FileName argument name.
        Specified by:
        setFileNameArg in interface DefaultSubscriptionWidget
        Parameters:
        value - The FileName argument name.