edu.ucdavis.cstars.client.tasks

Class FindTask

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.FindTask

public class FindTask
extends com.google.gwt.core.client.JavaScriptObject

Search a map service exposed by the ArcGIS Server REST API based on a string value. The search can be conducted on a single field of a single layer, on many fields of a layer, or on many fields of many layers.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FindTask.Options

Method Summary

Methods

Modifier and Type	Method and Description
void	addErrorHandler(ErrorHandler handler) Add error handler.
void	addFindTaskCompleteHandler(FindTaskCompleteHandler handler) Add complete handler.
static FindTask	create(java.lang.String url) Creates a new FindTask object.
static FindTask	create(java.lang.String url, FindTask.Options options) Creates a new FindTask object.
Deferred	execute(FindParameters params) Sends a request to the ArcGIS REST map service resource to perform a search based on the FindParameters specified in the findParameters argument.
Deferred	execute(FindParameters params, FindTaskCallback taskCallback) Sends a request to the ArcGIS REST map service resource to perform a search based on the FindParameters specified in the findParameters argument.
java.lang.String	getUrl() URL to the ArcGIS Server REST resource that represents a map service.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static FindTask create(java.lang.String url)

Creates a new FindTask object. A URL is a required parameter.

Parameters:

url - - URL to the ArcGIS Server REST resource that represents a layer in a service.

Returns:

FindTask

create

public static FindTask create(java.lang.String url,
              FindTask.Options options)

Creates a new FindTask object. A URL is a required parameter.

Parameters:

url - - URL to the ArcGIS Server REST resource that represents a layer in a service.

options - - Optional parameters.

Returns:

FindTask

getUrl

public final java.lang.String getUrl()

URL to the ArcGIS Server REST resource that represents a map service.

Returns:

String

execute

public final Deferred execute(FindParameters params,
               FindTaskCallback taskCallback)

Sends a request to the ArcGIS REST map service resource to perform a search based on the FindParameters specified in the findParameters argument. On completion, the onComplete event is fired and the optional callback function is invoked.

Parameters:

params - - Specifies the layers and fields that are used to search against.

taskCallback - - fired when server responds

Returns:

Deferred

execute

public final Deferred execute(FindParameters params)

Sends a request to the ArcGIS REST map service resource to perform a search based on the FindParameters specified in the findParameters argument. On completion, the onComplete event is fired and the optional callback function is invoked.

Parameters:

params - - Specifies the layers and fields that are used to search against.

Returns:

Deferred

addFindTaskCompleteHandler

public final void addFindTaskCompleteHandler(FindTaskCompleteHandler handler)

Add complete handler.

Parameters:

handler - - Fires when the find operation is complete. The result is an array of FindResult.

addErrorHandler

public final void addErrorHandler(ErrorHandler handler)

Add error handler.

Parameters:

handler - - Fires when an error occurs when executing the task.