Package com.aquima.interactions.portal

Interface IFiredEvent

All Superinterfaces:
Serializable
All Known Implementing Classes:
FiredEvent
public interface IFiredEvent extends Serializable
The fired event object which holds information about the event which triggered the portal-engine to process.
Since:
5.0
Author:
F. van der Meer, Jon van Leuven

  • 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.

  • Method Details

    • getRuntimeKey

      RuntimeKey getRuntimeKey()
      Returns the runtime key which equals the element that fired the event. It is the equivalent of getElement().getRuntimeKey();
      Returns:
      The RuntimeKey which can be null

    • getElement

      IElement getElement()
      Returns the IElement key which is the cause of the event processing.
      Returns:
      The element which can be null

    • getActions

      String[] getActions()
      This method returns the actions of the element which triggered the event.
      Returns:
      The action array which can be null.

    • containsAction

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

    • isSubmitEvent

      boolean isSubmitEvent()
      This method returns a boolean indicating if the event was triggered by a submit.
      Returns:
      true when a button submit was being pressed and a possible flow action will be processed.

    • isRefreshEvent

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

    • isVoidEvent

      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. Services and containers may use this method to determine if the handle method should process the current page, or ignore the event.
      Returns:
      a boolean indicating if the event contains a void action.