Package com.aquima.interactions.portal

Interface IActionHandler

All Known Implementing Classes:
AddCaseInformationIntoProfileActionHandler, CaseUpdater, CreateResponseHandler, CreateResponseHandler, DcmAuditActionHandler, ExecuteExposedTreeActionHandler, GenerateDocumentHandler, GetMessageHandler, HandleRequestHandler, HandleRequestHandler, ImageActionHandler, ProcessEnabledActionHandler, ProfileEditorActionHandler, ResourceHandler, ResourceLastModifiedHandler, RestoreProfileActionHandler, SearchExposedTreesActionHandler, TaskProfileUpdater
public interface IActionHandler
Interface for objects that can handle action from the client. The handler will be invoked in the context of the last rendered page.
Since:
5.0
Author:
O. Kerpershoek, F. van der Meer

  • Method Summary

    Modifier and Type
    Method
    Description
    IActionResult
    handle(IActionContext context)
    This method will be called from the portal session to handle an action request from the client.
    boolean
    isReadOnly()
    This method indicates if the action handler does not modify any profile data.

  • Method Details

    • isReadOnly

      boolean isReadOnly()
      This method indicates if the action handler does not modify any profile data.
      Returns:
      boolean indicating if the handler does not modify any profile data.

    • handle

      IActionResult handle(IActionContext context) throws Exception
      This method will be called from the portal session to handle an action request from the client. The method returns an Action result object which can be used by the client to act upon this result.
      Parameters:
      context - The portal context of the current session.
      Returns:
      The result of the handle method, may be null.
      Throws:
      PortalException - This exception may be thrown by the implementation to indicate a failure.
      Exception - When an unexpected exception occurs.