Package com.microstrategy.web.beans

Interface WebEvent

  • All Known Implementing Classes:
    FolderViewTransform.ClientEvent, GenericMultipleEvents, GenericWebEvent, ServletEvent
    public interface WebEvent
    This interface abstracts user interaction with a WebComponent in a Web application. Any user interaction may be viewed as an event. In a Web application, a WebEvent could appear as a URL link or a HTML form data, or whatever appropriate to the Web application.

    A WebEvent is attached to a WebEventHandler, which in turn is associated with a particular WebComponent. The WebEventHandler knows how to generate and handle its event.

    A WebEvent has a list of WebEvent.Argument identified by their unique ID within an event handler, which could also be uniquely identified by its own ID within an application. Each Argument may have many values.

    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getID

        int getID()
        Returns the event ID of this event. The ID is unique within an event handler.
        Returns:
        the unique ID of this event.

      • setID

        void setID​(int id)
        Sets an event id to the current WebEvent.
        Parameters:
        id - an event id to set.

      • getName

        java.lang.String getName()
        Returns the name of this event.
        Returns:
        the name of this event.

      • getArgumentName

        java.lang.String getArgumentName​(int id)
        Returns the argument name with the specified id at index 0. A WebEventHandler uses this argument name to retrieve its value from an RequestKeys instance.
        Parameters:
        id - the argument ID.
        Returns:
        the argument name with the specified id at index 0. null if there is no such an argument existing.

      • getArgumentName

        java.lang.String getArgumentName​(int id,
                                 int index)
        Returns the argument name with the specified id at the specified index. A WebEventHandler uses this argument name to retrieve its value from an RequestKeys instance.

        By default, if the an argument name at the given index is null, this method returns the string concatenation of the argument name at index 0, the underscore character '_', and the index value, i.e. arg_1. If the argument name at index 0 is also null, then a null string is returned.

        Parameters:
        id - an argument ID.
        index - the index to an argument name.
        Returns:
        the argument name with the specified id and index.

      • setArgumentValue

        void setArgumentValue​(int id,
                      java.lang.String value)
        Sets a value to the argument with the specified id at index 0. A new argument with null name is created if there is no such an argument at index 0.
        Parameters:
        id - an argument ID.
        value - the argument value to set.

      • setArgumentValue

        void setArgumentValue​(int id,
                      int index,
                      java.lang.String value)
        Sets a value to the argument with the specified id at the specified index. A new argument is created if there is no such an argument.

        The name of the new argument by default is the string concatenation of the argument name at index 0, the character underscore '_' and the index value, i.e. arg_1. If the argument at index 0 does not exist either, null is assigned.

        Parameters:
        id - an argument ID.
        index - an index where the value is set.
        value - an argument value to set.

      • getArgumentValue

        java.lang.String getArgumentValue​(int argumentID)
        Returns the current value of the argument. The default value is returned if one is specified in the definition of this event.

        If not, the value set explicitly is returned. If the value is set with multiple indices, then the value at index 0 is returned

        If the argument is not found or no value is set, null is returned

        Parameters:
        argumentID - the ID of the argument
        Returns:
        the value of the argument

      • getArgumentValue

        java.lang.String getArgumentValue​(int argumentID,
                                  int index)
        Returns the current value of the argument. The default value is returned if one is specified in the definition of this event.

        If not, the value set explicitly is returned.

        If the argument is not found or no value is set, null is returned

        Parameters:
        argumentID - ID of the argument
        index - the index into the set of argument values
        Returns:
        the value of the argument

      • getArgumentValueCount

        int getArgumentValueCount​(int argumentID)
        Returns the number of values at different indices for the argument.
        Parameters:
        argumentID - ID of the argument
        Returns:
        the count of the values

      • getSource

        WebComponent getSource()
        Returns the event source, a WebComponent object which knows how to generate and handle this event.
        Returns:
        source a WebComponent object.

      • setSource

        void setSource​(WebComponent source)
        Sets a WebComponent instance which knows how to generate and handle this WebEvent.
        Parameters:
        source - a WebComponent instance.

      • getSourcePath

        java.lang.String getSourcePath()
        Returns the path of a WebComponent which knows how to generate and handle this WebEvent.
        Returns:
        the path of a WebComponent

      • setSourcePath

        void setSourcePath​(java.lang.String source)
        Sets the path of a WebComponent which knows how to generate and handle this WebEvent.
        Parameters:
        source - the path of a WebComponent

      • getArguments

        java.util.Enumeration getArguments()
        Returns an Enumeration over all the WebEvent.Argument in this WebEvent. The enumeration is backed up this event.
        Returns:
        an Enumeration over all the WebEvent.Argument.

      • initFromXML

        boolean initFromXML​(java.lang.String xml)
        Initializes this event based on its specified XML definition.
        Parameters:
        xml - an XML string representing a WebEvent.
        Returns:
        true if initialization succeeds; false otherwise.

      • getTargetWindow

        java.lang.String getTargetWindow()
        returns the target specified for this event
        Returns:
        the target associated with this event.

      • setTargetWindow

        void setTargetWindow​(java.lang.String target)
        Sets the target attribute for this event. This is useful in redirecting the result of an action into a separate browser When a link for this event is generated, the target attribute is included if a non null value is set.
        Parameters:
        target -

      • initFromKeys

        void initFromKeys​(RequestKeys keys)
        Initialize the event with the given request keys
        Parameters:
        keys - the request keys to be used by this event

      • getDeprecatedMessage

        java.lang.String getDeprecatedMessage()

        If this event has been marked deprecated, this method returns instructions on the new usage (usually the alternate event). Null is returned if the event hasn't been deprecated.

        Returns:
        further instructions if this event has been been deprecated
        Since:
        MicroStrategy Web 8.0.0

      • getFlatState

        java.lang.String getFlatState()

        FlatStateSerializer representation of event. Structure is as follows:

        id:nextStr, src:nextStr, [argName:nextStr, argValue:nextStr]*

        Returns:
        the flat state of this event.
        Since:
        MicroStrategy Web 8.0.0

      • putArgument

        void putArgument​(int id,
                 java.lang.String name)
        Since:
        MicroStrategy Web 9.0.0

      • putArgument

        void putArgument​(int id,
                 java.lang.String name,
                 java.lang.String value)
        Since:
        MicroStrategy Web 9.0.0

      • putArgument

        void putArgument​(int id,
                 java.lang.String name,
                 int required)
        Since:
        MicroStrategy Web 9.0.0