Package com.aquima.interactions.portal

Class InvocationType

java.lang.Object
com.aquima.interactions.portal.InvocationType
All Implemented Interfaces:
Serializable
public final class InvocationType extends Object implements Serializable
This class defines the various invocation types that can be used when registering a callback function in a container expander (or dynamic container).

The following invocation types are supported:

  • ALWAYS The callback function should always be invoked for both page submits and refreshes, regardless of the element that triggered the event.
  • ON_SUBMIT The callback function should always be invoked when the page is submitted, but not invoked upon a page refresh.
  • ON_EVENT The callback function should only be invoked when the element, that the callback was registered for, caused the event. This type is usually applicable when registering a callback for a button or (refresh) field. The callback function will be invoked for both refresh and submit events.
Since:
6.5
Author:
O. Kerpershoek
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final InvocationType
    ALWAYS
    The callback function should always be invoked for both page submits and refreshes, regardless of the element that triggered the event.
    static final InvocationType
    ON_EVENT
    The callback function should only be invoked when the element, that the callback was registered for, caused the event.
    static final InvocationType
    ON_SUBMIT
    The callback function should always be invoked when the page is submitted, but not invoked upon a page refresh.

  • Method Summary

    Modifier and Type
    Method
    Description
    InvocationType
    beforeValidation()
    This method returns the invocation type with the "before validation" parameter set to true.
    boolean
    equals(Object obj)
     
    String
    getName()
    This method returns the (unique) name of the invocation type.
    int
    hashCode()
     
    boolean
    isBeforeValidation()
    This method returns a boolean indicating if the invocation type indicates a callback that should be evaluated before the validation rules are evaluated.
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Field Details

    • ALWAYS

      public static final InvocationType ALWAYS
      The callback function should always be invoked for both page submits and refreshes, regardless of the element that triggered the event.

    • ON_SUBMIT

      public static final InvocationType ON_SUBMIT
      The callback function should always be invoked when the page is submitted, but not invoked upon a page refresh.

    • ON_EVENT

      public static final InvocationType ON_EVENT
      The callback function should only be invoked when the element, that the callback was registered for, caused the event.

  • Method Details

    • getName

      public String getName()
      This method returns the (unique) name of the invocation type.
      Returns:
      the (unique) name of the invocation type.

    • beforeValidation

      public InvocationType beforeValidation()
      This method returns the invocation type with the "before validation" parameter set to true. Callback functions registered with an invocation type that has the "before validation" parameter set to true, will be invoked before the validation rules are evaluated. The before validation setting may be used for callback functions that perform post processing of the submitted (page) data, to avoid validation errors. Be aware that changing profile state before validation can cause serious problems!
      Returns:
      The invocation type with the "before validation" parameter set to true.

    • isBeforeValidation

      public boolean isBeforeValidation()
      This method returns a boolean indicating if the invocation type indicates a callback that should be evaluated before the validation rules are evaluated.
      Returns:
      Boolean indicating if the invocation type indicates a callback that should be evaluated before the validation rules are evaluated.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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

    • toString

      public String toString()
      Overrides:
      toString in class Object