Package org.pentaho.platform.api.action

Interface IActionInvokeStatus

public interface IActionInvokeStatus
An API for the object representation of action invocation status, allows us to pass back status of action invocation, whether any exceptions occurred during invocation and whether the action needs to be retired.

  • Method Details

    • setRequiresUpdate

      void setRequiresUpdate(boolean requiresUpdate)

    • requiresUpdate

      boolean requiresUpdate()
      Returns true if the IAction that was just invoked needs to be resubmitted. Used for scheduling purposes only.
      Returns:
      true if the IAction that was just invoked needs to be resubmitted and false otherwise

    • setThrowable

      void setThrowable(Throwable throwable)

    • getThrowable

      Throwable getThrowable()
      Returns a Throwable instance, if any occurred when the IAction was being invoked.
      Returns:
      a Throwable instance, if any occurred when the IAction was being invoked

    • getStreamProvider

      Object getStreamProvider()
      Returns the object representing the stream provider containing the file associated with the given action.
      Returns:
      the object representing the stream provider containing the file associated with the given action.

    • setStreamProvider

      void setStreamProvider(Object streamProvider)

    • isExecutionSuccessful

      default boolean isExecutionSuccessful()
      Return the success/failure of the execution. Added default method to maintain backward compatibility.
      Returns:
      boolean

    • setExecutionStatus

      default void setExecutionStatus(boolean status)
      Set the execution status. Added default method to maintain backward compatibility.
      Parameters:
      status - boolean