edu.ucdavis.cstars.client.arcgis

Class PortalQueryParams

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.arcgis.PortalQueryParams

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

Define parameters to use when querying

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PortalQueryParams.SortField

Method Summary

Methods

Modifier and Type	Method and Description
int	getNum() The maximum number of results to be included.
java.lang.String	getQ() The query string to search with.
PortalQueryParams.SortField[]	getSortField() A list of field(s) to sort by.
int	getStart() The number of the first entry in the result set response.
void	setNum(int num) Set the num parameter.
void	setQ(java.lang.String q) Set the q parameter.
void	setSortField(PortalQueryParams.SortField[] sortField) Set the sort field parameter.
void	setStart(int start) Set the start parameter.

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

getNum

public final int getNum()

The maximum number of results to be included. The default value is 10 and the maximum allowed value is 100.

Returns:

int

setNum

public final void setNum(int num)

Set the num parameter.

Parameters:

num - - The maximum number of results to be included. The default value is 10 and the maximum allowed value is 100.

getQ

public final java.lang.String getQ()

The query string to search with.

Returns:

String

setQ

public final void setQ(java.lang.String q)

Set the q parameter.

Parameters:

q - - The query string to search with.

getSortField

public final PortalQueryParams.SortField[] getSortField()

A list of field(s) to sort by.

Returns:

SortField[]

setSortField

public final void setSortField(PortalQueryParams.SortField[] sortField)

Set the sort field parameter.

Parameters:

sortField - - A list of field(s) to sort by.

getStart

public final int getStart()

The number of the first entry in the result set response. The index number is 1-based. The start parameter, along with the num parameter can be used to paginate the search results.

Returns:

int

setStart

public final void setStart(int start)

Set the start parameter.

Parameters:

start - - The number of the first entry in the result set response. The index number is 1-based. The start parameter, along with the num parameter can be used to paginate the search results.