com.esri.gpt.catalog.search
Class OpenSearchProperties

java.lang.Object
  com.esri.gpt.catalog.search.OpenSearchProperties

public class OpenSearchProperties
extends Object

Maintains property information supporting OpenSearch response elements.

Constructor Summary

OpenSearchProperties()
Default constructor.

Method Summary

String	getBbox()
String	getClientId()
String	getDescriptionURL() Gets the URL for the open search service description.
String	getFirstUrl()
String	getLastUrl()
String	getNextUrl()
int	getNumberOfHits() Gets the number of records hit by the query.
String	getPrevUrl()
int	getRecordsPerPage() Gets number of requested records per page.
String	getRestURL()
String	getSearchText()
String	getSelfUrl() methods =================================================================
String	getShortName() Gets the short name (i.e.
int	getStartRecord() Gets the starting record.
void	setBbox(String bbox)
void	setClientId(String clientId)
void	setDescriptionURL(String url) Sets the URL for the open search service description.
void	setNumberOfHits(int hits) Sets the number of records hit by the query.
void	setRecordsPerPage(int recordsPerPage) Sets number of requested records per page.
void	setRestURL(String restURL)
void	setSearchText(String searchText)
void	setShortName(String name) Sets the short name (i.e.
void	setStartRecord(int startRecord) Sets the starting record.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenSearchProperties

public OpenSearchProperties()

Default constructor.

Method Detail

getDescriptionURL

public String getDescriptionURL()

Gets the URL for the open search service description.

Returns:

the open search description URL

setDescriptionURL

public void setDescriptionURL(String url)

Sets the URL for the open search service description.

Parameters:

url - the open search description URL

getRestURL

public String getRestURL()

setRestURL

public void setRestURL(String restURL)

getSearchText

public String getSearchText()

setSearchText

public void setSearchText(String searchText)

getBbox

public String getBbox()

setBbox

public void setBbox(String bbox)

getClientId

public String getClientId()

setClientId

public void setClientId(String clientId)

getNumberOfHits

public int getNumberOfHits()

Gets the number of records hit by the query.

Returns:

the number of hits

setNumberOfHits

public void setNumberOfHits(int hits)

Sets the number of records hit by the query.

Parameters:

hits - the number of hits

getRecordsPerPage

public int getRecordsPerPage()

Gets number of requested records per page.

Returns:

number of records per page

setRecordsPerPage

public void setRecordsPerPage(int recordsPerPage)

Sets number of requested records per page.

Parameters:

recordsPerPage - number of records per page

getShortName

public String getShortName()

Gets the short name (i.e. title) associated with the open search service.

Returns:

the short name

setShortName

public void setShortName(String name)

Sets the short name (i.e. title) associated with the open search service.

Parameters:

name - the short name

getStartRecord

public int getStartRecord()

Gets the starting record.
The record set starts at 1 not 0.

Returns:

the starting record

setStartRecord

public void setStartRecord(int startRecord)

Sets the starting record.
The record set starts at 1 not 0.
If the supplied value is less that 1, the start record will be set to 1.

Parameters:

startRecord - the starting record

getSelfUrl

public String getSelfUrl()

methods =================================================================

getFirstUrl

public String getFirstUrl()

getLastUrl

public String getLastUrl()

getPrevUrl

public String getPrevUrl()

getNextUrl

public String getNextUrl()