Package com.aquima.interactions.portal

Interface ICallbackFunction

All Superinterfaces:
Serializable
All Known Implementing Classes:
ClearSearchCallback, DecisionTreeSelectCallBack, OrderColumnCallback, PageNavigationCallback, SearchCallBack, SearchFilterCallback, ShowAllCalback, StartCaseCallBack, StartTaskCallBack, TreeRunnerCallback
public interface ICallbackFunction extends Serializable
The callback function interface can be implemented by objects that wish to be notified when an action takes place on the current page. A callback function is usually registered by a dynamic container for one or more of its children.
Since:
5.0
Author:
O. Kerpershoek, Jon van Leuven

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    handle(IElement element, IContainerEventContext context)
    The handle method will be invoked after an event has occurred on the page.

  • Method Details

    • handle

      void handle(IElement element, IContainerEventContext context) throws Exception
      The handle method will be invoked after an event has occurred on the page. This callback function may choose to throw an exception when processing should stop due to an error, which will result in the flow being aborted and the last page to be shown again (for validation error messages or generic error messages set an error in the request scope) Use element.isFired() to check if the element caused the current event.
      Parameters:
      element - The element for which the callback function was registered.
      context - The current context which will be equal to the context at the moment of registration.
      Throws:
      Exception - This exception type may be thrown to indicate that the processing should stop due to an error.