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

Class RequestAction

java.lang.Object
com.aquima.interactions.portal.model.session.RequestAction
public final class RequestAction extends Object
Object containing information about the type of action that was trigged by the event.
Since:
5.0
Author:
O. Kerpershoek

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final RequestAction
    LEAVE
    A leave action will not update any fields and will not perform any validation.
    static final RequestAction
    REFRESH
    A refresh action will update the submitted fields, but only validate the fields that have actually changed in value.
    static final RequestAction
    SUBMIT
    A submit action will update the submitted fields, and validate all fields on the page, regardless of whether the fields changed value or not.
    static final RequestAction
    VOID
    A void action will not update any fields and will not perform any validation.

  • Method Summary

    Modifier and Type
    Method
    Description
    RequestAction
    asDraft()
    This method constructs a draft request action based on the current action.
    boolean
    equals(Object obj)
     
    boolean
    forcePageCommit()
    This method returns a boolean indicating if the page should be committed, even if the flow returns to the same page.
    protected RequestAction
    forElement(IElement element)
     
    int
    getActionId()
    This method will return the action mask of this request action type.
    protected IElement
    getElement()
     
    protected String[]
    getEvents()
     
    String
    getName()
    This method returns the name of the request action.
    ValidationAction
    getValidationAction()
    This method returns the ValidationAction which specifies the validation settings.
    int
    hashCode()
     
    protected boolean
    isButtonAction()
     
    protected void
    setForceCommit(boolean pageCommitNeeded)
     
    boolean
    skipValidation()
    This method returns a boolean indicating if no values should be validated.
    String
    toString()
     
    boolean
    updateValues()
    This method returns a boolean indicating if the values that are submitted should be committed.
    boolean
    validateAllValues()
    This method returns a boolean indicating if all values should be validated, or only the updated values.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • LEAVE

      public static final RequestAction LEAVE
      A leave action will not update any fields and will not perform any validation.

    • VOID

      public static final RequestAction VOID
      A void action will not update any fields and will not perform any validation. This action will however trigger services.

    • REFRESH

      public static final RequestAction REFRESH
      A refresh action will update the submitted fields, but only validate the fields that have actually changed in value.

    • SUBMIT

      public static final RequestAction SUBMIT
      A submit action will update the submitted fields, and validate all fields on the page, regardless of whether the fields changed value or not.

  • Method Details

    • forElement

      protected RequestAction forElement(IElement element)

    • getElement

      protected IElement getElement()

    • getEvents

      protected String[] getEvents()

    • isButtonAction

      protected boolean isButtonAction()

    • asDraft

      public RequestAction asDraft()
      This method constructs a draft request action based on the current action.
      Returns:
      The request action as draft.

    • getValidationAction

      public ValidationAction getValidationAction()
      This method returns the ValidationAction which specifies the validation settings.
      Returns:
      ValidationAction object indicating whether validation should be done for all fields, only updated fields or nothing at all.

    • getActionId

      public int getActionId()
      This method will return the action mask of this request action type.
      Note: The action type might be a combination of several type masks.
      Returns:
      the action mask of this request action type.

    • getName

      public String getName()
      This method returns the name of the request action.
      Returns:
      the name of the request action.

    • updateValues

      public boolean updateValues()
      This method returns a boolean indicating if the values that are submitted should be committed.
      Returns:
      boolean indicating if the values that are submitted should be committed.

    • validateAllValues

      public boolean validateAllValues()
      This method returns a boolean indicating if all values should be validated, or only the updated values.
      Returns:
      boolean indicating if all values should be validated, or only the updated values.

    • skipValidation

      public boolean skipValidation()
      This method returns a boolean indicating if no values should be validated.
      Returns:
      boolean indicating if no values should be validated.

    • forcePageCommit

      public boolean forcePageCommit()
      This method returns a boolean indicating if the page should be committed, even if the flow returns to the same page. This boolean is only relevant for submit requests, and can be enabled by adding a '_commit' action to a button.
      Returns:
      a boolean indicating if the page should be committed, even if the flow returns to the same page.

    • setForceCommit

      protected void setForceCommit(boolean pageCommitNeeded)

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object