jade.core.behaviours

Class OutcomeManager

java.lang.Object

jade.core.behaviours.OutcomeManager

All Implemented Interfaces:

java.io.Serializable

public class OutcomeManager
extends java.lang.Object
implements java.io.Serializable

Utility class to manage the outcome of a behaviour in a uniform way

Author:

Giovanni Caire

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	KO
static int	OK

Constructor Summary

Constructors

Constructor and Description
OutcomeManager(Behaviour bh)

Method Summary

Modifier and Type	Method and Description
void	error(java.lang.String msg, java.lang.Exception e) Mark the behaviour holding this OutcomeManager as failed and store the error-message that can then be retrieved by means of the getErrorMsg() method
java.lang.String	getErrorMsg() Retrieve the error-message providing details about the reason of failure of the behaviour holding this OutcomeManager .
int	getExitCode() Retrieve the exit-code that indicates whether the behaviour holding this OutcomeManager succeeded (OK) or failed (KO)
boolean	isSuccessful()
void	propagateError(java.lang.String msg) Used to propagate an already logged error through a hierarchy of behaviours

Methods inherited from class java.lang.Object

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

Field Detail

OK

public static final int OK

See Also:

Constant Field Values

KO

public static final int KO

See Also:

Constant Field Values

Constructor Detail

OutcomeManager

public OutcomeManager(Behaviour bh)

Method Detail

getExitCode

public int getExitCode()

Retrieve the exit-code that indicates whether the behaviour holding this OutcomeManager succeeded (OK) or failed (KO)

Returns:

The exit-code that indicates whether the behaviour holding this OutcomeManager succeeded (OK) or failed (KO)

isSuccessful

public boolean isSuccessful()

getErrorMsg

public java.lang.String getErrorMsg()

Retrieve the error-message providing details about the reason of failure of the behaviour holding this OutcomeManager .

Returns:

The error-message providing details about the reason of failure of the behaviour holding this OutcomeManager or null if the behaviour succeeded

error

public void error(java.lang.String msg,
                  java.lang.Exception e)

Mark the behaviour holding this OutcomeManager as failed and store the error-message that can then be retrieved by means of the getErrorMsg() method

Parameters:

msg - The error message.

e - The Exception, if any, that caused the behaviour to fail

propagateError

public void propagateError(java.lang.String msg)

Used to propagate an already logged error through a hierarchy of behaviours