org.gridgain.grid
Interface GridJobResult

All Superinterfaces:

Serializable

@Apache20LicenseCompatible
public interface GridJobResult
extends Serializable

Result of remote job which gets passed into GridTask.result(GridJobResult, List) method.



See Also:

Documentation
Email Support
Online Forums
Issue Tracking

Author: 2005-2008 Copyright © GridGain Systems. All Rights Reserved. ver. 2.1.0

	Nikita Ivanov, GridGain Systems nivanov@gridgain.com
	Dmitriy Setrakyan, GridGain Systems dsetrakyan@gridgain.com
	Alexander Magdenko, GridGain Systems amagdenko@gridgain.com
	Boris Suchodoev, GridGain Systems bsuchodoev@gridgain.com
	Denis Kharlamov, GridGain Systems dkharlamov@gridgain.com
	close

Method Summary

<T> T	getData() Gets data returned by remote job if it didn't fail.
GridException	getException() Gets exception produced by execution of remote job, or null if remote execution finished normally and did not produce any exceptions.
<T extends GridJob> T	getJob() Gets local instance of remote job returned by GridTask.map(List, Object) method.
GridJobContext	getJobContext() Gets job context.
UUID	getJobId() Deprecated.
GridNode	getNode() Gets node this job executed on.
boolean	isCancelled() Gets job cancellation status.

Method Detail

getJobId

@Deprecated
UUID getJobId()

Deprecated.

Gets ID of the job that produced this result. This method has been deprecated in favor of GridJobResult.getJobContext() method which contains all job related information in addition to job ID. See GridJobContext for more information.

Returns:

ID of the job that produced this result.

getJobContext

GridJobContext getJobContext()

Gets job context. Use job context to access job unique ID or to get/set jobs attributes. Context is attached to a job and travels with it wherever it goes. For example, if a job gets failed-over from one node to another, then its context will be failed over with it and all attributes that were set on the job on the first node will be available on the new node.

Returns:

Job context.

getData

<T> T getData()

Gets data returned by remote job if it didn't fail. This data is the object returned from GridJob.execute() method.

Note that if task is annotated with GridTaskNoResultCache annotation, then job results will not be cached and will be available only in GridTask.result(GridJobResult, List) method for every individual job, but not in GridTask.reduce(List) method. This feature was added to avoid excessive storing of overly large results.

Type Parameters:

T - Type of the return value returning from GridJob.execute() method.

Returns:

Data returned by remote job's GridJob.execute() method if it didn't fail.

getException

GridException getException()

Gets exception produced by execution of remote job, or null if remote execution finished normally and did not produce any exceptions.

Returns:

GridException produced by execution of remote job or null if no exception was produced.

Note that if remote job resulted in RuntimeException or Error then they will be wrapped into GridUserUndeclaredException returned by this method.

If job on remote node was rejected (cancelled while it was on waiting queue), then GridExecutionRejectedException will be returned.

If node on which job was computing failed, then GridTopologyException is returned.

getJob

<T extends GridJob> T getJob()

Gets local instance of remote job returned by GridTask.map(List, Object) method.

Type Parameters:

T - Type of GridJob that was sent to remote node.

Returns:

Local instance of remote job returned by GridTask.map(List, Object) method.

getNode

GridNode getNode()

Gets node this job executed on.

Returns:

Node this job executed on.

isCancelled

boolean isCancelled()

Gets job cancellation status. Returns true if job received cancellation request on remote node. Note that job, after receiving cancellation request, will still need to finish and return, hence GridJobResult.getData() method may contain execution result even if the job was canceled.

Job can receive cancellation request if the task was explicitly cancelled from future (see GridTaskFuture.cancel()) or if task completed prior to getting results from all remote jobs.

Returns:

true if job received cancellation request and false otherwise.