nl.b3p.csw.jaxb.csw

Class GetRecordsType

java.lang.Object

nl.b3p.csw.jaxb.csw.RequestBaseType

nl.b3p.csw.jaxb.csw.GetRecordsType

public class GetRecordsType
extends RequestBaseType

The principal means of searching the catalogue. The matching catalogue entries may be included with the response. The client may assign a requestId (absolute URI). A distributed search is performed if the DistributedSearch element is present and the catalogue is a member of a federation. Profiles may allow alternative query expressions.

Java class for GetRecordsType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="GetRecordsType">
   <complexContent>
     <extension base="{http://www.opengis.net/cat/csw/2.0.2}RequestBaseType">
       <sequence>
         <element name="DistributedSearch" type="{http://www.opengis.net/cat/csw/2.0.2}DistributedSearchType" minOccurs="0"/>
         <element name="ResponseHandler" type="{http://www.w3.org/2001/XMLSchema}anyURI" maxOccurs="unbounded" minOccurs="0"/>
         <choice>
           <element ref="{http://www.opengis.net/cat/csw/2.0.2}AbstractQuery"/>
           <any namespace='##other'/>
         </choice>
       </sequence>
       <attGroup ref="{http://www.opengis.net/cat/csw/2.0.2}BasicRetrievalOptions"/>
       <attribute name="requestId" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="resultType" type="{http://www.opengis.net/cat/csw/2.0.2}ResultType" default="hits" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected JAXBElement<? extends AbstractQueryType>	abstractQuery
protected Object	any
protected DistributedSearchType	distributedSearch
protected BigInteger	maxRecords
protected String	outputFormat
protected String	outputSchema
protected String	requestId
protected List<String>	responseHandler
protected ResultType	resultType
protected BigInteger	startPosition

Fields inherited from class nl.b3p.csw.jaxb.csw.RequestBaseType

service, version

Constructor Summary

Constructors

Constructor and Description
GetRecordsType() Default no-arg constructor
GetRecordsType(String service, String version, DistributedSearchType distributedSearch, List<String> responseHandler, JAXBElement<? extends AbstractQueryType> abstractQuery, Object any, String requestId, ResultType resultType, String outputFormat, String outputSchema, BigInteger startPosition, BigInteger maxRecords) Fully-initialising value constructor

Method Summary

Modifier and Type	Method and Description
JAXBElement<? extends AbstractQueryType>	getAbstractQuery() Gets the value of the abstractQuery property.
Object	getAny() Gets the value of the any property.
DistributedSearchType	getDistributedSearch() Gets the value of the distributedSearch property.
BigInteger	getMaxRecords() Gets the value of the maxRecords property.
String	getOutputFormat() Gets the value of the outputFormat property.
String	getOutputSchema() Gets the value of the outputSchema property.
String	getRequestId() Gets the value of the requestId property.
List<String>	getResponseHandler() Gets the value of the responseHandler property.
ResultType	getResultType() Gets the value of the resultType property.
BigInteger	getStartPosition() Gets the value of the startPosition property.
void	setAbstractQuery(JAXBElement<? extends AbstractQueryType> value) Sets the value of the abstractQuery property.
void	setAny(Object value) Sets the value of the any property.
void	setDistributedSearch(DistributedSearchType value) Sets the value of the distributedSearch property.
void	setMaxRecords(BigInteger value) Sets the value of the maxRecords property.
void	setOutputFormat(String value) Sets the value of the outputFormat property.
void	setOutputSchema(String value) Sets the value of the outputSchema property.
void	setRequestId(String value) Sets the value of the requestId property.
void	setResultType(ResultType value) Sets the value of the resultType property.
void	setStartPosition(BigInteger value) Sets the value of the startPosition property.

Methods inherited from class nl.b3p.csw.jaxb.csw.RequestBaseType

getService, getVersion, setService, setVersion

Methods inherited from class java.lang.Object

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

Field Detail

distributedSearch

protected DistributedSearchType distributedSearch

responseHandler

protected List<String> responseHandler

abstractQuery

protected JAXBElement<? extends AbstractQueryType> abstractQuery

any

protected Object any

requestId

protected String requestId

resultType

protected ResultType resultType

outputFormat

protected String outputFormat

outputSchema

protected String outputSchema

startPosition

protected BigInteger startPosition

maxRecords

protected BigInteger maxRecords

Constructor Detail

GetRecordsType

public GetRecordsType()

Default no-arg constructor

GetRecordsType

public GetRecordsType(String service,
                      String version,
                      DistributedSearchType distributedSearch,
                      List<String> responseHandler,
                      JAXBElement<? extends AbstractQueryType> abstractQuery,
                      Object any,
                      String requestId,
                      ResultType resultType,
                      String outputFormat,
                      String outputSchema,
                      BigInteger startPosition,
                      BigInteger maxRecords)

Fully-initialising value constructor

Method Detail

getDistributedSearch

public DistributedSearchType getDistributedSearch()

Gets the value of the distributedSearch property.

Returns:

possible object is DistributedSearchType

setDistributedSearch

public void setDistributedSearch(DistributedSearchType value)

Sets the value of the distributedSearch property.

Parameters:

value - allowed object is DistributedSearchType

getResponseHandler

public List<String> getResponseHandler()

Gets the value of the responseHandler property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the responseHandler property.

For example, to add a new item, do as follows:

    getResponseHandler().add(newItem);
 

Objects of the following type(s) are allowed in the list String

getAbstractQuery

public JAXBElement<? extends AbstractQueryType> getAbstractQuery()

Gets the value of the abstractQuery property.

Returns:

possible object is AbstractQuery Query

setAbstractQuery

public void setAbstractQuery(JAXBElement<? extends AbstractQueryType> value)

Sets the value of the abstractQuery property.

Parameters:

value - allowed object is AbstractQuery Query

getAny

public Object getAny()

Gets the value of the any property.

Returns:

possible object is Object

setAny

public void setAny(Object value)

Sets the value of the any property.

Parameters:

value - allowed object is Object

getRequestId

public String getRequestId()

Gets the value of the requestId property.

Returns:

possible object is String

setRequestId

public void setRequestId(String value)

Sets the value of the requestId property.

Parameters:

value - allowed object is String

getResultType

public ResultType getResultType()

Gets the value of the resultType property.

Returns:

possible object is ResultType

setResultType

public void setResultType(ResultType value)

Sets the value of the resultType property.

Parameters:

value - allowed object is ResultType

getOutputFormat

public String getOutputFormat()

Gets the value of the outputFormat property.

Returns:

possible object is String

setOutputFormat

public void setOutputFormat(String value)

Sets the value of the outputFormat property.

Parameters:

value - allowed object is String

getOutputSchema

public String getOutputSchema()

Gets the value of the outputSchema property.

Returns:

possible object is String

setOutputSchema

public void setOutputSchema(String value)

Sets the value of the outputSchema property.

Parameters:

value - allowed object is String

getStartPosition

public BigInteger getStartPosition()

Gets the value of the startPosition property.

Returns:

possible object is BigInteger

setStartPosition

public void setStartPosition(BigInteger value)

Sets the value of the startPosition property.

Parameters:

value - allowed object is BigInteger

getMaxRecords

public BigInteger getMaxRecords()

Gets the value of the maxRecords property.

Returns:

possible object is BigInteger

setMaxRecords

public void setMaxRecords(BigInteger value)

Sets the value of the maxRecords property.

Parameters:

value - allowed object is BigInteger