org.deegree.services.wcas.protocol
Interface CASGetRecordRequest

All Superinterfaces:

OGCWebServiceRequest

All Known Implementing Classes:

CASGetRecordRequest_Impl

public interface CASGetRecordRequest

extends OGCWebServiceRequest

A query request against a catalog service is described using the >GetRecord< element. The getRecord request bases on the request specified at the "OGC Web Services Stateless Catalog Profile" and is enhanced by some parameters defined within the GDI NRW Testbed II.

--------------------------------------------------------------------

Version:

$Revision: 1.2 $ $Date: 2004/03/29 10:34:32 $

Author:

Axel Schaefer

Method Summary

Filter	getFilter() returns a Filter object that is common to all queries definied in a getRecord request
int	getMaxRecords() returns the maximum amount of records that shall be returned as result of a getRecord request. if getMaxRecords returns a value that is larger than the maxRecords defined in the capabilities of the service the last one will be used.
java.lang.String	getOutputFormat() returns the name of the format the result of the request have to be formatted (default = XML)
java.lang.String	getOutputRecType() returns the record type the result shall be formated in. a catalog may offers different metadata formats for different kind of metadata (service- versus data-metadata) or different formats for the same kind of metadata (e.g. different profils on ISO19115).
CASQuery[]	getQuery() returns the query objects of the getRecord request that specifies the query in detail
int	getQueryScope() returns a number that indicates if the request is part of a cascading request
int	getStartPosition() returns the position (e.g. row of a table) where to start the query.
void	setQueryScope(int queryScope)

Methods inherited from interface org.deegree.services.OGCWebServiceRequest

getId, getRequest, getRequestParameter, getService, getVendorSpecificParameter, getVendorSpecificParameters, getVersion

Method Detail

getQuery

public CASQuery[] getQuery()

returns the query objects of the getRecord request that specifies the query in detail

getFilter

public Filter getFilter()

returns a Filter object that is common to all queries definied in a getRecord request

getMaxRecords

public int getMaxRecords()

returns the maximum amount of records that shall be returned as result of a getRecord request. if getMaxRecords returns a value that is larger than the maxRecords defined in the capabilities of the service the last one will be used.

getStartPosition

public int getStartPosition()

returns the position (e.g. row of a table) where to start the query. this is a usefull parameter if you like to retrieve the result of a query in block of e.g. 20 entries.

getQueryScope

public int getQueryScope()

returns a number that indicates if the request is part of a cascading request

setQueryScope

public void setQueryScope(int queryScope)

See Also:

because the queryScope changes (it is lowered) if the request is forced to the the next server at the cascade it have to be changable.

getOutputFormat

public java.lang.String getOutputFormat()

returns the name of the format the result of the request have to be formatted (default = XML)

getOutputRecType

public java.lang.String getOutputRecType()

returns the record type the result shall be formated in. a catalog may offers different metadata formats for different kind of metadata (service- versus data-metadata) or different formats for the same kind of metadata (e.g. different profils on ISO19115).