com.esri.gpt.agp.client
Class AgpCursor

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

public class AgpCursor
extends Object

Cursor information associated with a search result.

Constructor Summary

AgpCursor()
Default constructor.

Method Summary

long	getNextStart() Gets the start index for the next result page.
int	getNum() Gets the maximum number of matches to return.
String	getQuery() Gets the query that was executed.
long	getStart() Gets the start index for the result page.
long	getTotal() Gets the total number of hits.
void	parseResponse(org.json.JSONObject jsoResponse) Parse the JSON response.
void	setNextStart(long nextStart) Sets the start index for the next result page.
void	setNum(int num) Sets the maximum number of matches to return.
void	setQuery(String query) Sets the query that was executed.
void	setStart(long start) Sets the start index for the result page.
void	setTotal(long total) Sets the total number of hits.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AgpCursor

public AgpCursor()

Default constructor.

Method Detail

getNextStart

public long getNextStart()

Gets the start index for the next result page.

Returns:

the start index for the next result page

setNextStart

public void setNextStart(long nextStart)

Sets the start index for the next result page.

Parameters:

nextStart - the start index for the next result page

getNum

public int getNum()

Gets the maximum number of matches to return.

Returns:

the maximum number of matches to return

setNum

public void setNum(int num)

Sets the maximum number of matches to return.

Parameters:

num - the maximum number of matches to return

getQuery

public String getQuery()

Gets the query that was executed.

Returns:

the query that was executed

setQuery

public void setQuery(String query)

Sets the query that was executed.

Parameters:

query - the query that was executed

getStart

public long getStart()

Gets the start index for the result page.

Returns:

the start index for the result page

setStart

public void setStart(long start)

Sets the start index for the result page.

Parameters:

start - the start index for the result page

getTotal

public long getTotal()

Gets the total number of hits.

Returns:

the total number of hits

setTotal

public void setTotal(long total)

Sets the total number of hits.

Parameters:

total - the total number of hits

parseResponse

public void parseResponse(org.json.JSONObject jsoResponse)
                   throws org.json.JSONException

Parse the JSON response.

Parameters:

jsoResponse - the JSON response

Throws:

Exception - if an exception occurs

org.json.JSONException

toString

public String toString()

Overrides:

toString in class Object