Package com.aquima.interactions.portal.model.session

Class FiredEvent

java.lang.Object
com.aquima.interactions.portal.model.session.FiredEvent
All Implemented Interfaces:
IFiredEvent, Serializable
public class FiredEvent extends Object implements IFiredEvent
This class holds the information of the element that triggered the portal event.
Since:
5.0
Author:
O. Kerpershoek
See Also:

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    FiredEvent()
    Constructs an empty fired event instance.
    protected
    FiredEvent(RequestAction action)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsAction(String eventName)
    Checks whether the action is available within the getActions() array.
    String[]
    getActions()
    This method returns the actions of the element which triggered the event.
    IElement
    getElement()
    Returns the IElement key which is the cause of the event processing.
    RuntimeKey
    getRuntimeKey()
    Returns the runtime key which equals the element that fired the event.
    boolean
    isRefreshEvent()
    This method returns a boolean indicating if the event was triggered by a refresh.
    boolean
    isSubmitEvent()
    This method returns a boolean indicating if the event was triggered by a submit.
    boolean
    isVoidEvent()
    This method returns a boolean indicating if the event contains a void action, which is commonly used to navigate to another page without processing the current page.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • FiredEvent

      protected FiredEvent(RequestAction action)

    • FiredEvent

      public FiredEvent()
      Constructs an empty fired event instance. This constructor may be used to indicated the event was triggered by an unknown (page) element.

  • Method Details

    • containsAction

      public boolean containsAction(String eventName)
      Description copied from interface: IFiredEvent
      Checks whether the action is available within the getActions() array. It checks for them in a case insensitive matter.
      Specified by:
      containsAction in interface IFiredEvent
      Parameters:
      eventName - The event name that should be checked.
      Returns:
      true when the action was available in the action list, false otherwise.

    • getElement

      public IElement getElement()
      Description copied from interface: IFiredEvent
      Returns the IElement key which is the cause of the event processing.
      Specified by:
      getElement in interface IFiredEvent
      Returns:
      The element which can be null

    • getActions

      public String[] getActions()
      Description copied from interface: IFiredEvent
      This method returns the actions of the element which triggered the event.
      Specified by:
      getActions in interface IFiredEvent
      Returns:
      The action array which can be null.

    • getRuntimeKey

      public RuntimeKey getRuntimeKey()
      Description copied from interface: IFiredEvent
      Returns the runtime key which equals the element that fired the event. It is the equivalent of getElement().getRuntimeKey();
      Specified by:
      getRuntimeKey in interface IFiredEvent
      Returns:
      The RuntimeKey which can be null

    • isRefreshEvent

      public boolean isRefreshEvent()
      Description copied from interface: IFiredEvent
      This method returns a boolean indicating if the event was triggered by a refresh.
      Specified by:
      isRefreshEvent in interface IFiredEvent
      Returns:
      true when a field or button triggered a refresh. No flowing will be done and one will stay on the current page.

    • isSubmitEvent

      public boolean isSubmitEvent()
      Description copied from interface: IFiredEvent
      This method returns a boolean indicating if the event was triggered by a submit.
      Specified by:
      isSubmitEvent in interface IFiredEvent
      Returns:
      true when a button submit was being pressed and a possible flow action will be processed.

    • isVoidEvent

      public boolean isVoidEvent()
      Description copied from interface: IFiredEvent
      This method returns a boolean indicating if the event contains a void action, which is commonly used to navigate to another page without processing the current page. Services and containers may use this method to determine if the handle method should process the current page, or ignore the event.
      Specified by:
      isVoidEvent in interface IFiredEvent
      Returns:
      a boolean indicating if the event contains a void action.