Package net.opengis.cat.csw20

Interface GetRecordsType

All Superinterfaces:

EObject, Notifier, RequestBaseType

All Known Implementing Classes:

GetRecordsTypeImpl

public interface GetRecordsType
extends RequestBaseType

A representation of the model object 'Get Records Type'. 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.

The following features are supported:

• Distributed Search
• Response Handler
• Any
• Max Records
• Output Format
• Output Schema
• Request Id
• Result Type
• Start Position
• Query

See Also:

• Csw20Package.getGetRecordsType()

Method Summary

Modifier and Type	Method	Description
FeatureMap	getAny()	Returns the value of the 'Any' attribute list.
DistributedSearchType	getDistributedSearch()	Returns the value of the 'Distributed Search' containment reference.
Integer	getMaxRecords()	Returns the value of the 'Max Records' attribute.
String	getOutputFormat()	Returns the value of the 'Output Format' attribute.
String	getOutputSchema()	Returns the value of the 'Output Schema' attribute.
Object	getQuery()	Returns the value of the 'Abstract Query' containment reference.
String	getRequestId()	Returns the value of the 'Request Id' attribute.
String	getResponseHandler()	Returns the value of the 'Response Handler' attribute.
ResultType	getResultType()	Returns the value of the 'Result Type' attribute.
Integer	getStartPosition()	Returns the value of the 'Start Position' attribute.
boolean	isSetOutputFormat()	Returns whether the value of the 'Output Format' attribute is set.
boolean	isSetResultType()	Returns whether the value of the 'Result Type' attribute is set.
void	setDistributedSearch(DistributedSearchType value)	Sets the value of the 'Distributed Search' containment reference.
void	setMaxRecords(Integer value)	Sets the value of the 'Max Records' attribute.
void	setOutputFormat(String value)	Sets the value of the 'Output Format' attribute.
void	setOutputSchema(String value)	Sets the value of the 'Output Schema' attribute.
void	setQuery(Object value)	Sets the value of the 'Query' attribute.
void	setRequestId(String value)	Sets the value of the 'Request Id' attribute.
void	setResponseHandler(String value)	Sets the value of the 'Response Handler' attribute.
void	setResultType(ResultType value)	Sets the value of the 'Result Type' attribute.
void	setStartPosition(Integer value)	Sets the value of the 'Start Position' attribute.
void	unsetOutputFormat()	Unsets the value of the 'Output Format' attribute.
void	unsetResultType()	Unsets the value of the 'Result Type' attribute.

Methods inherited from interface EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface RequestBaseType

getBaseUrl, getExtendedProperties, getService, getVersion, isSetService, isSetVersion, setBaseUrl, setExtendedProperties, setService, setVersion, unsetService, unsetVersion

Method Details

getDistributedSearch

DistributedSearchType getDistributedSearch()

Returns the value of the 'Distributed Search' containment reference.

If the meaning of the 'Distributed Search' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Distributed Search' containment reference.

See Also:

• setDistributedSearch(DistributedSearchType)
• Csw20Package.getGetRecordsType_DistributedSearch()

setDistributedSearch

void setDistributedSearch(DistributedSearchType value)

Sets the value of the 'Distributed Search' containment reference.

Parameters:

value - the new value of the 'Distributed Search' containment reference.

See Also:

• getDistributedSearch()

getResponseHandler

String getResponseHandler()

Returns the value of the 'Response Handler' attribute.

If the meaning of the 'Response Handler' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Response Handler' attribute.

See Also:

• setResponseHandler(String)
• Csw20Package.getGetRecordsType_ResponseHandler()

setResponseHandler

void setResponseHandler(String value)

Sets the value of the 'Response Handler' attribute.

Parameters:

value - the new value of the 'Response Handler' attribute.

See Also:

• getResponseHandler()

getQuery

Object getQuery()

Returns the value of the 'Abstract Query' containment reference.

If the meaning of the 'Abstract Query' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Abstract Query' containment reference.

See Also:

• net.opengis.cat.csw20.Csw20Package#getGetRecordsType_AbstractQuery()

setQuery

void setQuery(Object value)

Sets the value of the 'Query' attribute.

Parameters:

value - the new value of the 'Query' attribute.

See Also:

• getQuery()

getAny

FeatureMap getAny()

Returns the value of the 'Any' attribute list. The list contents are of type FeatureMap.Entry.

If the meaning of the 'Any' attribute list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Any' attribute list.

See Also:

• Csw20Package.getGetRecordsType_Any()

getMaxRecords

Integer getMaxRecords()

Returns the value of the 'Max Records' attribute. The default value is "10".

If the meaning of the 'Max Records' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Max Records' attribute.

See Also:

• #isSetMaxRecords()
• #unsetMaxRecords()
• #setMaxRecords(BigInteger)
• Csw20Package.getGetRecordsType_MaxRecords()

setMaxRecords

void setMaxRecords(Integer value)

Sets the value of the 'Max Records' attribute.

Parameters:

value - the new value of the 'Max Records' attribute.

See Also:

• getMaxRecords()

getOutputFormat

String getOutputFormat()

Returns the value of the 'Output Format' attribute. The default value is "application/xml".

If the meaning of the 'Output Format' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Output Format' attribute.

See Also:

• isSetOutputFormat()
• unsetOutputFormat()
• setOutputFormat(String)
• Csw20Package.getGetRecordsType_OutputFormat()

setOutputFormat

void setOutputFormat(String value)

Sets the value of the 'Output Format' attribute.

Parameters:

value - the new value of the 'Output Format' attribute.

See Also:

• isSetOutputFormat()
• unsetOutputFormat()
• getOutputFormat()

unsetOutputFormat

void unsetOutputFormat()

Unsets the value of the 'Output Format' attribute.

See Also:

• isSetOutputFormat()
• getOutputFormat()
• setOutputFormat(String)

isSetOutputFormat

boolean isSetOutputFormat()

Returns whether the value of the 'Output Format' attribute is set.

Returns:

whether the value of the 'Output Format' attribute is set.

See Also:

• unsetOutputFormat()
• getOutputFormat()
• setOutputFormat(String)

getOutputSchema

String getOutputSchema()

Returns the value of the 'Output Schema' attribute.

If the meaning of the 'Output Schema' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Output Schema' attribute.

See Also:

• setOutputSchema(String)
• Csw20Package.getGetRecordsType_OutputSchema()

setOutputSchema

void setOutputSchema(String value)

Sets the value of the 'Output Schema' attribute.

Parameters:

value - the new value of the 'Output Schema' attribute.

See Also:

• getOutputSchema()

getRequestId

String getRequestId()

Returns the value of the 'Request Id' attribute.

If the meaning of the 'Request Id' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Request Id' attribute.

See Also:

• setRequestId(String)
• Csw20Package.getGetRecordsType_RequestId()

setRequestId

void setRequestId(String value)

Sets the value of the 'Request Id' attribute.

Parameters:

value - the new value of the 'Request Id' attribute.

See Also:

• getRequestId()

getResultType

ResultType getResultType()

Returns the value of the 'Result Type' attribute. The default value is "hits". The literals are from the enumeration ResultType.

If the meaning of the 'Result Type' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Result Type' attribute.

See Also:

• ResultType
• isSetResultType()
• unsetResultType()
• setResultType(ResultType)
• Csw20Package.getGetRecordsType_ResultType()

setResultType

void setResultType(ResultType value)

Sets the value of the 'Result Type' attribute.

Parameters:

value - the new value of the 'Result Type' attribute.

See Also:

• ResultType
• isSetResultType()
• unsetResultType()
• getResultType()

unsetResultType

void unsetResultType()

Unsets the value of the 'Result Type' attribute.

See Also:

• isSetResultType()
• getResultType()
• setResultType(ResultType)

isSetResultType

boolean isSetResultType()

Returns whether the value of the 'Result Type' attribute is set.

Returns:

whether the value of the 'Result Type' attribute is set.

See Also:

• unsetResultType()
• getResultType()
• setResultType(ResultType)

getStartPosition

Integer getStartPosition()

Returns the value of the 'Start Position' attribute. The default value is "1".

If the meaning of the 'Start Position' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Start Position' attribute.

See Also:

• setStartPosition(Integer)
• Csw20Package.getGetRecordsType_StartPosition()

setStartPosition

void setStartPosition(Integer value)

Sets the value of the 'Start Position' attribute.

Parameters:

value - the new value of the 'Start Position' attribute.

See Also:

• getStartPosition()