Package com.aquima.interactions.portal

Class ActionType

java.lang.Object
com.aquima.interactions.portal.ActionType
All Implemented Interfaces:
Serializable
public class ActionType extends Object implements Serializable
Simple class that represents an action type from the client.
Since:
5.0
Author:
O. Kerpershoek
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    LEAVE
    Action mask to indicate a leave action.
    static final int
    REFRESH
    Action mask to indicate a refresh action.
    static final int
    SUBMIT
    Action mask to indicate a submit action.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ActionType(int mask, boolean onlyInScope)
    Constructor accepting an action mask and a boolean specifying if the action is only valid when the object that trigged the action is in scope.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isLeaveAction()
    this method returns a boolean indicating if the action is valid when triggered by a leave event.
    boolean
    isRefreshAction()
    This method returns a boolean indicating if the action is valid when triggered by a refresh event.
    boolean
    isScoped()
    this method returns a boolean indicating if the action is only valid in the scope of the object that originated the event.
    boolean
    isSubmitAction()
    This method returns a boolean indicating if the action is valid when triggered by a submit event.
    boolean
    isValidFor(int actionType)
    This method returns a boolean indicating if the action is of the specified type.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • REFRESH

      public static final int REFRESH
      Action mask to indicate a refresh action.
      See Also:

    • SUBMIT

      public static final int SUBMIT
      Action mask to indicate a submit action.
      See Also:

    • LEAVE

      public static final int LEAVE
      Action mask to indicate a leave action.
      See Also:

  • Constructor Details

    • ActionType

      public ActionType(int mask, boolean onlyInScope)
      Constructor accepting an action mask and a boolean specifying if the action is only valid when the object that trigged the action is in scope.
      Parameters:
      mask - The bit-mask of the action type.
      onlyInScope - boolean indicating if the action is only valid in the scope of the object that originated the event.

  • Method Details

    • isScoped

      public boolean isScoped()
      this method returns a boolean indicating if the action is only valid in the scope of the object that originated the event.
      Returns:
      boolean indicating if the action is only valid in the scope of the object that originated the event.

    • isRefreshAction

      public boolean isRefreshAction()
      This method returns a boolean indicating if the action is valid when triggered by a refresh event.
      Returns:
      boolean indicating if the action is valid when triggered by a refresh event.

    • isSubmitAction

      public boolean isSubmitAction()
      This method returns a boolean indicating if the action is valid when triggered by a submit event.
      Returns:
      boolean indicating if the action is valid when triggered by a submit event.

    • isLeaveAction

      public boolean isLeaveAction()
      this method returns a boolean indicating if the action is valid when triggered by a leave event.
      Returns:
      boolean indicating if the action is valid when triggered by a leave event.

    • isValidFor

      public boolean isValidFor(int actionType)
      This method returns a boolean indicating if the action is of the specified type.
      Parameters:
      actionType - The mask for which the check should be performed.
      Returns:
      boolean indicating if the action is valid for the specified mask.