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 Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Object
getStreamProvider()
Returns the object representing the stream provider containing the file associated with the given action.Throwable
getThrowable()
default boolean
isExecutionSuccessful()
Return the success/failure of the execution.boolean
requiresUpdate()
Returns true if theIAction
that was just invoked needs to be resubmitted.default void
setExecutionStatus(boolean status)
Set the execution status.void
setRequiresUpdate(boolean requiresUpdate)
void
setStreamProvider(Object streamProvider)
void
setThrowable(Throwable throwable)
-
-
-
Method Detail
-
setRequiresUpdate
void setRequiresUpdate(boolean requiresUpdate)
-
requiresUpdate
boolean requiresUpdate()
Returns true if theIAction
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()
-
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
-
-