Interface WebEvents

  • All Known Implementing Classes:
    GenericMultipleEvents

    public interface WebEvents
    The WebEvents interface represents an ordered collection of WebEvent. It is primarily used in case of a multiple-events event.

    A multiple-events event is such an event that the event itself consists of many other events, each of which might have its own event source, and a designated WebComponent to handle it. In Web applications, a multiple-events event can be represented in the format of string, and passed to the web server through either a HTML URL link or a HTML form data.

    The string representation of a multiple-events event needs to meet the following requirements:

    • Uniquely identify the source component of each event.
    • Uniquely identify the event definition (ID of the event and its arguments, including names and values) in the request.
    • Support passing multiple events to different components in an application component hierarchy.
    • Support multiple instances of the same event going to either the same component or different components.
    • Support handling of events in the request in a specific order.
    Since:
    MicroStrategy Web 8.0.0
    See Also:
    GenericMultipleEvents
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addEvent​(WebEvent event)
      Adds an event to the current collection.
      void clear()
      Clears the current collection of web events.
      WebEvent get​(int index)
      Returns the event at the specified index.
      java.util.List getEvents()
      Returns a list of events held by the collection.
      WebEvent remove​(int index)
      Removes the event at the specified index from the collection.
    • Method Detail

      • addEvent

        void addEvent​(WebEvent event)
        Adds an event to the current collection.
        Parameters:
        event - the event to add.
      • getEvents

        java.util.List getEvents()
        Returns a list of events held by the collection.
        Returns:
        a list of events.
      • get

        WebEvent get​(int index)
        Returns the event at the specified index.
        Parameters:
        index - the position of an event.
        Returns:
        the event at the specified index.
      • remove

        WebEvent remove​(int index)
        Removes the event at the specified index from the collection.
        Parameters:
        index - the position of the event to remove.
        Returns:
        the event having justbeen removed from the collection.
      • clear

        void clear()
        Clears the current collection of web events.