org.ow2.proactive.scheduler.common.job

Interface JobResult

All Superinterfaces:

Serializable

All Known Implementing Classes:

JobResultImpl, JobResultImpl

@PublicAPI
public interface JobResult
extends Serializable

Result of the execution of a job which is a map of task result.
The key of the map is the name of the task on which to get the result.
To identify the job attached to this result, a JobId and its name are provide by this class.
You can get the task results within 3 different ways :

• Every results of every tasks executed in the job.
• Every results that have generated an exception.
• Every results that you pointed out as precious result.

Since:

ProActive Scheduling 0.9

Method Summary

Modifier and Type	Method and Description
Map<String,TaskResult>	getAllResults() Return every task results of this job as a mapping between user task name (in XML job description) and its task result. User that wants to get a specific result may get this map and ask for a specific mapping or use the getResult(String) method.
Map<String,TaskResult>	getExceptionResults() Return only the task results that have generated an exception. User that wants to get a specific result may get this map and ask for a specific mapping.
JobId	getJobId() To get the id of the job corresponding to this result.
JobInfo	getJobInfo() Return the information of the corresponding job
String	getName() To get the name of the job that has generate this result.
Map<String,TaskResult>	getPreciousResults() Return only the precious results of this job as a mapping between user task name (in XML job description) and its task result. User that wants to get a specific result may get this map and ask for a specific mapping.
TaskResult	getResult(String taskName) Return the task Result corresponding to the given name.
Map<String,Serializable>	getResultMap() Each task can contribute to this map.
boolean	hadException() Returns true if the job has generated an exception, false if not.
void	removeResult(String taskName) Remove the result of the given task in this jobResult.

Method Detail

getJobId

JobId getJobId()

To get the id of the job corresponding to this result.

Returns:

the id of the job corresponding to this result.

getName

String getName()

To get the name of the job that has generate this result.

Returns:

the name of the job that has generate this result.

getJobInfo

JobInfo getJobInfo()

Return the information of the corresponding job

Returns:

the information of the corresponding job

getAllResults

Map<String,TaskResult> getAllResults()

Return every task results of this job as a mapping between user task name (in XML job description) and its task result.
User that wants to get a specific result may get this map and ask for a specific mapping or use the getResult(String) method.

Returns:

the task result as a map.

getPreciousResults

Map<String,TaskResult> getPreciousResults()

Return only the precious results of this job as a mapping between user task name (in XML job description) and its task result.
User that wants to get a specific result may get this map and ask for a specific mapping.

Returns:

the precious results as a map.

getResultMap

Map<String,Serializable> getResultMap()

Each task can contribute to this map.

Returns:

merged map of job results

getExceptionResults

Map<String,TaskResult> getExceptionResults()

Return only the task results that have generated an exception.
User that wants to get a specific result may get this map and ask for a specific mapping.

Returns:

the precious results as a map.

getResult

TaskResult getResult(String taskName)
              throws UnknownTaskException

Return the task Result corresponding to the given name. A result is returned if the taskName exist and if the result is available. Null is returned if the task is not finished (has no result).

Parameters:

taskName - the task name of the result to get.

Returns:

the result corresponding to the given task name, null if not found or not finished.

Throws:

UnknownTaskException - if the given task name does not exist in this job

removeResult

void removeResult(String taskName)
           throws UnknownTaskException

Remove the result of the given task in this jobResult.

Parameters:

taskName - the identification name of the task.

Throws:

UnknownTaskException - if the given task name does not exist in this job

hadException

boolean hadException()

Returns true if the job has generated an exception, false if not.

Returns:

true if the job has generated an exception.