Package com.microstrategy.web.app.gui

Interface ScheduleWidget

  • All Superinterfaces:
    GuiElement
    public interface ScheduleWidget
extends GuiElement
    Deprecated.
    Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions.
    Renders a Widget to edit Web Subscriptions.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • renderTriggerList

        void renderTriggerList​(MarkupOutput out,
                       SimpleList triggers,
                       java.lang.String triggerId,
                       java.lang.String argTrigger)
        Deprecated.
        Renders the list of triggers. This method is internally called with the global list of triggers and the current triggerId by the renderElement() method.
        It can be called independentaly by passing the list of triggers and the triggerId.
        Parameters:
        out - where to write the output
        triggers - the list of triggers to render
        triggerId - the selected triggerId
        argTrigger - the name of the triggerId argumetn

      • setTriggers

        void setTriggers​(SimpleList value)
        Deprecated.
        Set the global list of triggers.
        Parameters:
        value - the new list of triggers

      • getTriggers

        SimpleList getTriggers()
        Deprecated.
        Gets the current global list of triggers.
        Returns:
        a list of triggers

      • setTriggerId

        void setTriggerId​(java.lang.String value)
        Deprecated.
        Sets the current triggerId of the widget.
        Parameters:
        value - the new triggerId

      • getTriggerId

        java.lang.String getTriggerId()
        Deprecated.
        Gets the current triggerId
        Returns:
        the current triggerId

      • setTriggerArg

        void setTriggerArg​(java.lang.String value)
        Deprecated.
        Sets the name of the triggerId argument
        Parameters:
        value - the new trigger argument name

      • getTriggerArg

        java.lang.String getTriggerArg()
        Deprecated.
        Returns:
        value the current triggerId argument name

      • setReuseMessage

        void setReuseMessage​(java.lang.String value)
        Deprecated.
        Defines whether the current message should be reused when a new schedule is triggered
        Parameters:
        value - "1" if the message should be reused.

      • getReuseMessage

        java.lang.String getReuseMessage()
        Deprecated.
        Returns:
        "1" if the current message will be reused when the schedule is trigger and saved in the inbox. Otherwise a new message will be created each time the schedule is triggered.

      • setReuseMessageArg

        void setReuseMessageArg​(java.lang.String value)
        Deprecated.
        The name of the "reuseMessage" argument
        Parameters:
        value - the new name of the argument

      • getReuseMessageArg

        java.lang.String getReuseMessageArg()
        Deprecated.
        Returns:
        the current name of the "reuseMessage" argument.

      • setRWDFormatArg

        void setRWDFormatArg​(java.lang.String value)
        Deprecated.
        The name of the "rwdFormatArg" argument
        Parameters:
        value - the new name of the argument
        Since:
        MicroStrategy Web 8.0.1

      • getRWDFormatArg

        java.lang.String getRWDFormatArg()
        Deprecated.
        Returns:
        the current name of the "reuseMessage" argument.
        Since:
        MicroStrategy Web 8.0.1

      • setMobileArg

        void setMobileArg​(java.lang.String value)
        Deprecated.
        The name of the "mobile" argument
        Parameters:
        value - the new name of the argument
        Since:
        MicroStrategy Web 8.1.1

      • getMobileArg

        java.lang.String getMobileArg()
        Deprecated.
        Returns:
        the current name of the "mobile" argument.
        Since:
        MicroStrategy Web 8.1.1

      • 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
        Since:
        MicroStrategy Web 8.0.0

      • 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
        Since:
        MicroStrategy Web 8.0.0

      • 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
        Since:
        MicroStrategy Web 8.0.0

      • 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
        Since:
        MicroStrategy Web 8.0.0

      • getObjectName

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

      • setExecutionFlags

        void setExecutionFlags​(int executionFlags)
        Deprecated.
        sets the execution flags (used to pass on flags from existing schedule).
        Parameters:
        executionFlags -
        Since:
        MicroStrategy Web 8.0.1