org.eclipse.smila.taskmanager

Class ResultDescription

java.lang.Object

org.eclipse.smila.taskmanager.ResultDescription

public class ResultDescription
extends java.lang.Object

The description of a task execution result.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_COUNTERS Key for counters.
static java.lang.String	KEY_ERROR_CODE Key for errorCode.
static java.lang.String	KEY_ERROR_MESSAGE Key for errorMessage.
static java.lang.String	KEY_STATUS Key for status.

Constructor Summary

Constructors

Constructor and Description
ResultDescription(TaskCompletionStatus status, java.lang.String errorCode, java.lang.String errorMessage, java.util.Map<java.lang.String,java.lang.Number> counters) Constructs a new ResultDescription.

Method Summary

Methods

Modifier and Type	Method and Description
static ResultDescription	fromAny(AnyMap resultDescriptionAny) Parse a new ResultDescription from an Any object.
java.util.Map<java.lang.String,java.lang.Number>	getCounters()
java.lang.String	getErrorCode()
java.lang.String	getErrorMessage()
TaskCompletionStatus	getStatus()
AnyMap	toAny() Returns the Any representation of the result description.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_STATUS

public static final java.lang.String KEY_STATUS

Key for status.

See Also:

Constant Field Values

KEY_ERROR_CODE

public static final java.lang.String KEY_ERROR_CODE

Key for errorCode.

See Also:

Constant Field Values

KEY_COUNTERS

public static final java.lang.String KEY_COUNTERS

Key for counters.

See Also:

Constant Field Values

KEY_ERROR_MESSAGE

public static final java.lang.String KEY_ERROR_MESSAGE

Key for errorMessage.

See Also:

Constant Field Values

Constructor Detail

ResultDescription

public ResultDescription(TaskCompletionStatus status,
                 java.lang.String errorCode,
                 java.lang.String errorMessage,
                 java.util.Map<java.lang.String,java.lang.Number> counters)

Constructs a new ResultDescription.

Parameters:

status - The completion status.

errorCode - An error code if an error occurred, null (or a success code) if not.

errorMessage - An error message if an error occurred, null if not.

counters - Counters for statistical purposes.

Method Detail

fromAny

public static ResultDescription fromAny(AnyMap resultDescriptionAny)
                                 throws AnyConvertException

Parse a new ResultDescription from an Any object.

Parameters:

resultDescriptionAny - see class comment for format of Any object

Returns:

a ResultDescription constructed from the Any object

Throws:

TaskmanagerException

AnyConvertException - error converting object.

getStatus

public TaskCompletionStatus getStatus()

Returns:

the status

getErrorCode

public java.lang.String getErrorCode()

Returns:

the errorCode

getErrorMessage

public java.lang.String getErrorMessage()

Returns:

the errorMessage

getCounters

public java.util.Map<java.lang.String,java.lang.Number> getCounters()

Returns:

the counters

toAny

public AnyMap toAny()
             throws java.lang.Exception

Returns the Any representation of the result description.

Returns:

the Any representation of the result description

Throws:

java.lang.Exception - an exception occurred during the conversion to Any.