uk.ac.liv.pgb.analytica.lib

Class TaskExecutionResult

java.lang.Object

uk.ac.liv.pgb.analytica.lib.TaskExecutionResult

public final class TaskExecutionResult
extends Object

Describes the result of a task.

Author:

sperkins

Method Summary

Modifier and Type	Method and Description
static TaskExecutionResult	error(String errorMessage, Exception ex) Creates an instance of this class denoting an unsuccessful task execution.
String	getErrorMessage() Gets the error message, if any.
Exception	getException() Gets the exception contained in this result, if any.
String	getSuccessMessage() Gets the success message in this result, if any.
static TaskExecutionResult	success(String successMessage) Creates an instance of this class denoting a successful task execution.

Methods inherited from class java.lang.Object

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

Method Detail

success

public static TaskExecutionResult success(String successMessage)

Creates an instance of this class denoting a successful task execution.

Parameters:

successMessage - The success message.

Returns:

The success result object.

error

public static TaskExecutionResult error(String errorMessage,
                                        Exception ex)

Creates an instance of this class denoting an unsuccessful task execution.

Parameters:

errorMessage - The error message.

ex - The exception reported by the task.

Returns:

The unsuccessful result object.

getException

public Exception getException()

Gets the exception contained in this result, if any.

Returns:

The exception contained in this result.

getSuccessMessage

public String getSuccessMessage()

Gets the success message in this result, if any.

Returns:

The success message.

getErrorMessage

public String getErrorMessage()

Gets the error message, if any.

Returns:

The error message.