com.massa.mrules.executable

Class ExecutionResultWrapper

java.lang.Object

com.massa.mrules.executable.ExecutionResultWrapper

All Implemented Interfaces:

IExecutionResult, Serializable

public class ExecutionResultWrapper
extends Object
implements IExecutionResult

This implementation wraps an IExecutionResult to redirect everything to the original result.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExecutionResultWrapper(IExecutionResult result)

Method Summary

Modifier and Type	Method and Description
static IExecutionResult	combine(IExecutionResult states, IExecutionResult returnedValueAndDirective) Easy way to combine states and [return value and/or directive]
static IExecutionResult	combineIgnoringDirective(IExecutionResult states, IExecutionResult returnedValue) Easy way to combine states and return value if present
ExecutionResultState	getActionValidated() If this executable contains sub-executables, returns ExecutionResultState.OK if they are correctly executed.
ExecutionResultState	getConditionValidated() If this executable contains conditions, returns ExecutionResultState.OK if they are validated, ExecutionResultState.KO if not.
IExecutionControlDirective	getDirective() Returns the directive to transmit to parent IExecutable, so that they can make appropriate actions.
IExecutionResult	getResult()
Object	getReturnedValue() Any executable may return a value.
boolean	isContainingDirective() Tells if this result contains flow control directives, in which case in should be interpreted.
static IExecutionResult	wrapForDirective(IExecutionResult result, IExecutionControlDirective directive) Easy way to wrap a result with a directive
static IExecutionResult	wrapForDirectiveAndReturnedValue(IExecutionResult result, Object returnedValue, IExecutionControlDirective directive) Easy way to wrap a result with a return value and a directive
static IExecutionResult	wrapForReturnedValue(IExecutionResult result, Object returnedValue) Easy way to wrap a result with a return value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExecutionResultWrapper

public ExecutionResultWrapper(IExecutionResult result)

Method Detail

getConditionValidated

public ExecutionResultState getConditionValidated()

Description copied from interface: IExecutionResult

If this executable contains conditions, returns ExecutionResultState.OK if they are validated, ExecutionResultState.KO if not.
If this executable does not contain conditions, returns ExecutionResultState.NA.
This method should not return ExecutionResultState.PARTIAL.
This result does not include sub-executables condition results.

Specified by:

getConditionValidated in interface IExecutionResult

getActionValidated

public ExecutionResultState getActionValidated()

Description copied from interface: IExecutionResult

If this executable contains sub-executables, returns

• ExecutionResultState.OK if they are correctly executed.
• ExecutionResultState.KO if not.
• ExecutionResultState.PARTIAL if some are correctly executed, others not.

If this executable does not contain sub-executables or if they are not executed, returns ExecutionResultState.NA.

For the moment, provided base implementations (IAction) will only return ExecutionResultState.OK, as errors are handled via Exceptions.
But more high level IExecutable will handle correctly all types of results.

Specified by:

getActionValidated in interface IExecutionResult

isContainingDirective

public boolean isContainingDirective()

Description copied from interface: IExecutionResult

Tells if this result contains flow control directives, in which case in should be interpreted.
If true, IExecutionResult.getDirective() can't return null.

Specified by:

isContainingDirective in interface IExecutionResult

getDirective

public IExecutionControlDirective getDirective()

Description copied from interface: IExecutionResult

Returns the directive to transmit to parent IExecutable, so that they can make appropriate actions.
This field cant't be null if IExecutionResult.isContainingDirective() is true.

Specified by:

getDirective in interface IExecutionResult

getReturnedValue

public Object getReturnedValue()

Description copied from interface: IExecutionResult

Any executable may return a value. This method is dedicated to it.

Specified by:

getReturnedValue in interface IExecutionResult

Returns:

Value returned by the executable

getResult

public IExecutionResult getResult()

wrapForReturnedValue

public static IExecutionResult wrapForReturnedValue(IExecutionResult result,
                                                    Object returnedValue)

Easy way to wrap a result with a return value

Returns:

new wrapper with return value

wrapForDirective

public static IExecutionResult wrapForDirective(IExecutionResult result,
                                                IExecutionControlDirective directive)

Easy way to wrap a result with a directive

Returns:

new wrapper with directive

wrapForDirectiveAndReturnedValue

public static IExecutionResult wrapForDirectiveAndReturnedValue(IExecutionResult result,
                                                                Object returnedValue,
                                                                IExecutionControlDirective directive)

Easy way to wrap a result with a return value and a directive

Returns:

new wrapper with return value and directive

combineIgnoringDirective

public static IExecutionResult combineIgnoringDirective(IExecutionResult states,
                                                        IExecutionResult returnedValue)

Easy way to combine states and return value if present

Returns:

new wrapper with return value and directive

combine

public static IExecutionResult combine(IExecutionResult states,
                                       IExecutionResult returnedValueAndDirective)

Easy way to combine states and [return value and/or directive]

Returns:

new wrapper with return value and directive