com.esri.gpt.agp.client
Class AgpSearchCriteria

java.lang.Object
  com.esri.gpt.agp.client.AgpSearchCriteria

public class AgpSearchCriteria
extends Object

The criteria for a search request.

Constructor Summary

AgpSearchCriteria()
Default constructor.

Method Summary

void	appendURLParameters(StringBuilder parameters) Appends parameters to a URL request buffer.
String	getBBox() Gets the bounding box for a spatial search.
long	getDeepTotal() Gets the maximum number of results to process for a deep search.
int	getNum() Gets the maximum number of matches to return.
String	getQ() Gets the query to execute.
String	getSortField() Gets the sort field.
String	getSortOrder() Gets the sort order.
long	getStart() Gets the number of the first entry in the result set response.
void	setBBox(String bbox) Sets the bounding box for a spatial search.
void	setDeepTotal(long deepTotal) Sets the maximum number of results to process for a deep search.
void	setNum(int num) Sets the maximum number of matches to return.
void	setQ(String q) Sets the query to execute.
void	setSortField(String sortField) Sets the sort field.
void	setSortOrder(String sortOrder) Sets the sort order.
void	setStart(long start) Sets the number of the first entry in the result set response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AgpSearchCriteria

public AgpSearchCriteria()

Default constructor.

Method Detail

getBBox

public String getBBox()

Gets the bounding box for a spatial search.
Defined as minx, miny, maxx, maxy.
Search requires q, bbox or both.
Document extent is assumed to be in the WGS84 geographic coordinate system.

Returns:

the bounding box

setBBox

public void setBBox(String bbox)

Sets the bounding box for a spatial search.
Defined as minx, miny, maxx, maxy.
Search requires q, bbox or both.
Document extent is assumed to be in the WGS84 geographic coordinate system.

Parameters:

bbox - the bounding box

getDeepTotal

public long getDeepTotal()

Gets the maximum number of results to process for a deep search.
A deep search is a paged search.

Returns:

the deep total

setDeepTotal

public void setDeepTotal(long deepTotal)

Sets the maximum number of results to process for a deep search.
A deep search is a paged search.

Parameters:

deepTotal - the deep total

getNum

public int getNum()

Gets the maximum number of matches to return.
The default value is 10 and the maximum allowed value is 100.

Returns:

the maximum number of matches to return

setNum

public void setNum(int num)

Sets the maximum number of matches to return.
The default value is 10 and the maximum allowed value is 100.

Parameters:

num - the maximum number of matches to return

getQ

public String getQ()

Gets the query to execute.

Returns:

the query to execute

setQ

public void setQ(String q)

Sets the query to execute.

Parameters:

q - the query to execute

getSortField

public String getSortField()

Gets the sort field.
You can also sort by multiple fields for an item, comma separated. The allowed sort field names are title, created, type, owner, avgRating, numRatings, numComments and numViews.

Returns:

the query to execute

setSortField

public void setSortField(String sortField)

Sets the sort field.
You can also sort by multiple fields for an item, comma separated. The allowed sort field names are title, created, type, owner, avgRating, numRatings, numComments and numViews.

Parameters:

sortField - the sort field

getSortOrder

public String getSortOrder()

Gets the sort order.
Values: asc | desc (default is asc).

Returns:

the sort order

setSortOrder

public void setSortOrder(String sortOrder)

Sets the sort order.
Values: asc | desc (default is asc).

Parameters:

sortOrder - the sort order

getStart

public long getStart()

Gets the number of the first entry in the result set response.
The index number is 1-based, the default is 1.

Returns:

the starting index

setStart

public void setStart(long start)

Sets the number of the first entry in the result set response.
The index number is 1-based, the default is 1.

Parameters:

start - the starting index

appendURLParameters

public void appendURLParameters(StringBuilder parameters)

Appends parameters to a URL request buffer.

Parameters:

parameters - the URL request buffer