AGSFindTask Class Reference


Description

This task performs text-based searches on an ArcGIS Server map service. The search is performed on only layers in the map service. Any tables in the map service are not searched. The search can be conducted on a single field of a single layer in the map service, on many fields of a layer, or on many fields of many layers.

A find task needs a URL to a REST resource that represents a Map service. For example, http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/SanFrancisco/311Incidents/MapServer

Defined in:
AGSFindTask.h ( ArcGIS library)
Since:
1.0
See also:
AGSFindParameters for search criteria
AGSFindTaskDelegate and AGSFindResult for search results
Inheritance diagram for AGSFindTask:
AGSTask <AGSSecuredResource>

List of all members.

Public Member Functions

(NSOperation *) - executeWithParameters:
(id) - initWithURL:
(id) - initWithURL:credential:

Static Public Member Functions

(id) + findTaskWithURL:
(id) + findTaskWithURL:credential:

Properties

AGSCredentialcredential
id< AGSFindTaskDelegatedelegate
NSURL * URL

Member Function Documentation

- (NSOperation *) executeWithParameters: (AGSFindParameters *)  params  

Performs a search on the map service using the specified parameters. The delegate will be notified when the operation completes or if an error is encountered.

It relies on the Find operation of the REST resource.

Parameters:
params The parameters for executing the search.
Returns:
NSOperation for current search operation.
See also:
AGSFindTaskDelegate
Since:
1.0
+ (id) findTaskWithURL: (NSURL *)  url  

Initialize autoreleased find task.

Parameters:
url URL to a map service resource in the ArcGIS Server REST Services Directory.
Returns:
A new, autoreleased, find task object.
Since:
1.0
+ (id) findTaskWithURL: (NSURL *)  url
credential: (AGSCredential *)  cred 

Initialize autoreleased find task.

Parameters:
url URL to a map service resource in the ArcGIS Server REST Services Directory.
cred AGSCredential to access secure resource.
Returns:
A new, autoreleased, find task object.
Since:
1.0
- (id) initWithURL: (NSURL *)  url  

Initialize the task.

Parameters:
url URL to a task resource in the ArcGIS Server REST Services Directory.
Returns:
A new task object.
Since:
1.0
- (id) initWithURL: (NSURL *)  url
credential: (AGSCredential *)  cred 

Initialize the task with a URL and credential to a secured resource.

Parameters:
url URL to a task resource in the ArcGIS Server REST Services Directory.
cred AGSCredential used to access secure resource.
Returns:
A new task object.
Since:
1.0

Property Documentation

- (AGSCredential*) credential [read, write, copy, inherited]

The credential to be used to access secured resources.

Since:
1.0

Reimplemented from <AGSSecuredResource>.

- (id<AGSFindTaskDelegate>) delegate [read, write, assign]

Delegate to be notified when the task completes successfully or encounters an error.

Since:
1.0
- (NSURL*) URL [read, copy, inherited]

URL to a task resource in the ArcGIS Server REST Services Directory.

Since:
1.0