<AGSGeoprocessorDelegate> Protocol Reference

---

Description

A protocol which must be adopted by any class wishing to be notified when the AGSGeoprocessor completes an operation successfully or encounters an error. An instance of the class must then be set as the delegate of AGSGeoprocessor.

Defined in:

AGSGeoprocessor.h ( ArcGIS library)

Since:

1.0

List of all members.

Public Member Functions
(void)	- geoprocessor:operation:didCheckJobStatus:
(void)	- geoprocessor:operation:didExecuteWithResults:messages:
(void)	- geoprocessor:operation:didFailExecuteWithError:
(void)	- geoprocessor:operation:didQueryWithResult:forJob:
(void)	- geoprocessor:operation:didQueryWithResultImage:forJob:
(void)	- geoprocessor:operation:didQueryWithResultImageLayer:forJob:
(void)	- geoprocessor:operation:didSubmitJob:
(void)	- geoprocessor:operation:jobDidFail:
(void)	- geoprocessor:operation:jobDidSucceed:
(void)	- geoprocessor:operation:ofType:didFailWithError:forJob:
(void)	- geoprocessor:willCheckJobStatus:

---

Member Function Documentation

- (void) geoprocessor:		(AGSGeoprocessor *)	geoprocessor
operation:		(NSOperation *)	op
didCheckJobStatus:		(AGSGPJobInfo *)	jobInfo
				[optional]

Tells the delegate that AGSGeoprocessor fetched an updated status for the submitted job.

Parameters:

	geoprocessor	The geoprocessor which submitted the job and checked the status.
	op	NSOperation that performed the task.
	jobInfo	AGSGPJobInfo object containing the jobId, status and messages.

Since:

1.0

- (void) geoprocessor:		(AGSGeoprocessor *)	geoprocessor
operation:		(NSOperation *)	op
didExecuteWithResults:		(NSArray *)	results
messages:		(NSArray *)	messages
				[optional]

Tells the delegate that AGSGeoprocessor successfully invoked the geoprocessing task in synchronous mode.

Parameters:

	geoprocessor	The geoprocessor object which executed the task.
	op	NSOperation that performed the task.
	results	The array of AGSGPParameterValue objects representing output parameters of the task and their values.
	messages	The array of AGSGPMessage objects containing details of task execution.

Since:

1.0

- (void) geoprocessor:		(AGSGeoprocessor *)	geoprocessor
operation:		(NSOperation *)	op
didFailExecuteWithError:		(NSError *)	error
				[optional]

Tells the delegate that AGSGeoprocessor encountered an error when trying to execute the synchronous task.

Parameters:

	geoprocessor	The geoprocessor object which executed the task.
	op	NSOperation that performed the task.
	error	Information about the error returned by the geoprocessing task execution.

Since:

1.0

- (void) geoprocessor:		(AGSGeoprocessor *)	geoprocessor
operation:		(NSOperation *)	op
didQueryWithResult:		(AGSGPParameterValue *)	result
forJob:		(NSString *)	jobId
				[optional]

Tells the delegate that AGSGeoprocessor successfully retrieved a result of the completed job.

Parameters:

	geoprocessor	The geoprocessor object which executed the task.
	op	NSOperation that performed the task.
	result	an AGSGPParameterValue representing the value of the output parameter requested.
	jobId	Id of the job which finished through queryResultData:paramName:.

Since:

1.0

- (void) geoprocessor:		(AGSGeoprocessor *)	geoprocessor
operation:		(NSOperation *)	op
didQueryWithResultImage:		(UIImage *)	image
forJob:		(NSString *)	jobId
				[optional]

Tells the delegate that AGSGeoprocessor successfully retrieved a result image of the completed job.

Parameters:

	geoprocessor	The geoprocessor object which executed the task.
	op	NSOperation that performed the task.
	image	A UIImage representing the resulting image parameter requested.
	jobId	Id of the job which finished through queryResultImage:paramName:imageParams:.

Since:

1.0

- (void) geoprocessor:		(AGSGeoprocessor *)	geoprocessor
operation:		(NSOperation *)	op
didQueryWithResultImageLayer:		(AGSGPResultLayer *)	lyr
forJob:		(NSString *)	jobId
				[optional]

Tells the delegate that AGSGeoprocessor successfully retrieved the result image layer of the completed job.

Parameters:

	geoprocessor	The geoprocessor object which executed the task.
	op	NSOperation that performed the task.
	lyr	Dynamic layer representing the results of the task.
	jobId	Id of the job which finished.

Since:

1.0

- (void) geoprocessor:		(AGSGeoprocessor *)	geoprocessor
operation:		(NSOperation *)	op
didSubmitJob:		(AGSGPJobInfo *)	jobInfo
				[optional]

Tells the delegate a job was successfully submitted by AGSGeoprocessor by executing the geoprocessing task in asynchronous mode.

Parameters:

	geoprocessor	The geoprocessor called to submit job.
	op	NSOperation that performed the task.
	jobInfo	AGSGPJobInfo object containing the jobId, status and messages. execution.

Since:

1.0

- (void) geoprocessor:		(AGSGeoprocessor *)	geoprocessor
operation:		(NSOperation *)	op
jobDidFail:		(AGSGPJobInfo *)	jobInfo
				[optional]

Tells the delegate that the job submitted by AGSGeoprocessor encountered an error.

Parameters:

	geoprocessor	The geoprocessor which submitted the job.
	op	NSOperation that performed the task.
	jobInfo	AGSGPJobInfo object containing the jobId, status and messages. execution.

Since:

1.0

- (void) geoprocessor:		(AGSGeoprocessor *)	geoprocessor
operation:		(NSOperation *)	op
jobDidSucceed:		(AGSGPJobInfo *)	jobInfo
				[optional]

Tells the delegate that the job submitted by AGSGeoprocessor completed successfully. See didSubmitJob: for notification of when the job was actually submitted.

Parameters:

	geoprocessor	The geoprocessor which submitted the job.
	op	NSOperation that performed the task.
	jobInfo	AGSGPJobInfo object containing the jobId, status and messages.

Since:

1.0

- (void) geoprocessor:		(AGSGeoprocessor *)	geoprocessor
operation:		(NSOperation *)	op
ofType:		(AGSGPAsyncOperationType)	opType
didFailWithError:		(NSError *)	error
forJob:		(NSString *)	jobId
				[optional]

Tells the delegate that AGSGeoprocessor encountered an error while executing the geoprocessing task in asynchronous mode.

Parameters:

	geoprocessor	The task called to execute asynchronously.
	op	NSOperation that performed the task.
	opType	AGSGPAsyncOperationType representing the type of operation that failed.
	error	Information about the error returned by the geoprocessing task.
	jobId	Id of the job which failed.

Since:

1.0

- (void) geoprocessor:		(AGSGeoprocessor *)	geoprocessor
willCheckJobStatus:		(AGSGPJobInfo *)	jobInfo
				[optional]

Tells the delegate that the status of the jobId within jobInfo will be checked.

Parameters:

	geoprocessor	The geoprocessor called to submit job.
	jobInfo	AGSGPJobInfo object containing the jobId, status and messages.

Since:

1.0