org.codice.ddf.spatial.ogc.csw.catalog.common

Class GetRecordsRequest

java.lang.Object

org.codice.ddf.spatial.ogc.csw.catalog.common.CswRequest

org.codice.ddf.spatial.ogc.csw.catalog.common.GetRecordsRequest

public class GetRecordsRequest
extends CswRequest

JAX-RS Parameter Bean Class for the GetRecords request. The member variables will be automatically injected by the JAX-RS annotations.

Constructor Summary

Constructors

Constructor and Description
GetRecordsRequest()
GetRecordsRequest(String service, String version)

Method Summary

Modifier and Type	Method and Description
GetRecordsType	get202RecordsType() Convert the KVP values into a GetRecordsType, validates format of fields and enumeration constraints required to meet the schema requirements of the GetRecordsType.
String	getConstraint()
String	getConstraintLanguage()
Boolean	getDistributedSearch()
String	getElementName()
String	getElementSetName()
BigInteger	getHopCount()
BigInteger	getMaxRecords()
String	getNamespace()
String	getOutputFormat()
String	getOutputSchema()
String	getRequestId()
String	getResponseHandler()
String	getResultType()
String	getSortBy()
BigInteger	getStartPosition()
String	getTypeNames()
String	getVersion()
void	setConstraint(String constraint)
void	setConstraintLanguage(String constraintLanguage)
void	setDistributedSearch(Boolean distributedSearch)
void	setElementName(String elementName)
void	setElementSetName(String elementSetName)
void	setHopCount(BigInteger hopCount)
void	setMaxRecords(BigInteger maxRecords)
void	setNamespace(String namespace)
void	setOutputFormat(String outputFormat)
void	setOutputSchema(String outputSchema)
void	setRequestId(String requestId)
void	setResponseHandler(String responseHandler)
void	setResultType(String resultType)
void	setSortBy(String sortBy)
void	setStartPosition(BigInteger startPosition)
void	setTypeNames(String typeNames)
void	setVersion(String version)

Methods inherited from class org.codice.ddf.spatial.ogc.csw.catalog.common.CswRequest

getRequest, getService, parseNamespaces, setRequest, setService, typeStringToQNames

Methods inherited from class java.lang.Object

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

Constructor Detail

GetRecordsRequest

public GetRecordsRequest()

GetRecordsRequest

public GetRecordsRequest(String service,
                         String version)

Method Detail

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getRequestId

public String getRequestId()

setRequestId

public void setRequestId(String requestId)

getNamespace

public String getNamespace()

setNamespace

public void setNamespace(String namespace)

getResultType

public String getResultType()

setResultType

public void setResultType(String resultType)

getOutputFormat

public String getOutputFormat()

setOutputFormat

public void setOutputFormat(String outputFormat)

getOutputSchema

public String getOutputSchema()

setOutputSchema

public void setOutputSchema(String outputSchema)

getStartPosition

public BigInteger getStartPosition()

setStartPosition

public void setStartPosition(BigInteger startPosition)

getMaxRecords

public BigInteger getMaxRecords()

setMaxRecords

public void setMaxRecords(BigInteger maxRecords)

getTypeNames

public String getTypeNames()

setTypeNames

public void setTypeNames(String typeNames)

getElementName

public String getElementName()

setElementName

public void setElementName(String elementName)

getElementSetName

public String getElementSetName()

setElementSetName

public void setElementSetName(String elementSetName)

getConstraintLanguage

public String getConstraintLanguage()

setConstraintLanguage

public void setConstraintLanguage(String constraintLanguage)

getConstraint

public String getConstraint()

setConstraint

public void setConstraint(String constraint)

getSortBy

public String getSortBy()

setSortBy

public void setSortBy(String sortBy)

getDistributedSearch

public Boolean getDistributedSearch()

setDistributedSearch

public void setDistributedSearch(Boolean distributedSearch)

getHopCount

public BigInteger getHopCount()

setHopCount

public void setHopCount(BigInteger hopCount)

getResponseHandler

public String getResponseHandler()

setResponseHandler

public void setResponseHandler(String responseHandler)

get202RecordsType

public GetRecordsType get202RecordsType()
                                 throws CswException

Convert the KVP values into a GetRecordsType, validates format of fields and enumeration constraints required to meet the schema requirements of the GetRecordsType. No further validation is done at this point

Returns:

GetRecordsType representation of this key-value representation

Throws:

CswException - An exception when some field cannot be converted to the equivalent GetRecordsType value