Package org.pentaho.platform.api.engine

Interface IActionRequestHandler

public interface IActionRequestHandler
The basic interface for requests to execute actions .
Author:
mbatchel

  • Method Details

    • handleActionRequest

      IRuntimeContext handleActionRequest(int timeout, int timeoutType)
      Responsible for executing the action using the solution engine.
      Parameters:
      timeout - Timeout for the execution - currently ignored in the Base
      timeoutType - - currently ignored in the Base
      Returns:
      RuntimeContext from the execution
      See Also:
      • BaseRequestHandler

    • handleActionAsyncRequest

      IRuntimeContext handleActionAsyncRequest()
      Executes an action sequence asynchronously. Note - this is currently not implemented in the BaseRequestHandler
      Returns:
      RuntimeContext created for the asynchronous execution.

    • getRuntime

      IRuntimeContext getRuntime(String requestHandle)
      Gets the runtime. Currently not called anywhere in the platform
      Parameters:
      requestHandle -
      Returns:
      the RuntimeContext for the execution

    • getMessages

      List getMessages()
      As the execution happens, the action handler is responsible for storing a list of all the messages that occur in the case of component failure. This method returns that list. The items in the list are presented to the user as execution feedback.
      Returns:
      list of messages

    • setCreateFeedbackParameterCallback

      void setCreateFeedbackParameterCallback(ICreateFeedbackParameterCallback createFeedbackParameterCallback)

    • setForcePrompt

      void setForcePrompt(boolean forcePrompt)
      Sets whether to force the generation of a prompt page
      Parameters:
      forcePrompt -