Package net.opengis.wfs
Interface BaseRequestType
-
- All Superinterfaces:
EObject
,Notifier
- All Known Subinterfaces:
DescribeFeatureTypeType
,GetFeatureType
,GetFeatureWithLockType
,GetGmlObjectType
,LockFeatureType
,TransactionType
- All Known Implementing Classes:
BaseRequestTypeImpl
,DescribeFeatureTypeTypeImpl
,GetFeatureTypeImpl
,GetFeatureWithLockTypeImpl
,GetGmlObjectTypeImpl
,LockFeatureTypeImpl
,TransactionTypeImpl
public interface BaseRequestType extends EObject
A representation of the model object 'Base Request Type'. XML encoded WFS operation request base, for all operations except GetCapabilities.The following features are supported:
- See Also:
WfsPackage.getBaseRequestType()
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getBaseUrl()
Returns the value of the 'Base Url' attribute.Map
getExtendedProperties()
Extended model properties.String
getHandle()
Returns the value of the 'Handle' attribute.String
getProvidedVersion()
Provided version of service processing the request.String
getService()
Returns the value of the 'Service' attribute.String
getVersion()
Returns the value of the 'Version' attribute.boolean
isSetService()
Returns whether the value of the 'Service
' attribute is set.boolean
isSetVersion()
Returns whether the value of the 'Version
' attribute is set.void
setBaseUrl(String value)
Sets the value of the 'Base Url
' attribute.void
setExtendedProperties(Map value)
Sets the value of the 'Extended Properties
' attribute.void
setHandle(String value)
Sets the value of the 'Handle
' attribute.void
setProvidedVersion(String value)
Sets the value of the 'Provided Version
' attribute.void
setService(String value)
Sets the value of the 'Service
' attribute.void
setVersion(String value)
Sets the value of the 'Version
' attribute.void
unsetService()
Unsets the value of the 'Service
' attribute.void
unsetVersion()
Unsets the value of the 'Version
' attribute.
-
-
-
Method Detail
-
getHandle
String getHandle()
Returns the value of the 'Handle' attribute. The handle attribute allows a client application to assign a client-generated request identifier to a WFS request. The handle is included to facilitate error reporting. A WFS may report the handle in an exception report to identify the offending request or action. If the handle is not present, then the WFS may employ other means to localize the error (e.g. line numbers).- Returns:
- the value of the 'Handle' attribute.
- See Also:
setHandle(String)
,WfsPackage.getBaseRequestType_Handle()
-
setHandle
void setHandle(String value)
Sets the value of the 'Handle
' attribute.- Parameters:
value
- the new value of the 'Handle' attribute.- See Also:
getHandle()
-
getService
String getService()
Returns the value of the 'Service' attribute. The default value is"WFS"
. The service attribute is included to support service endpoints that implement more than one OGC service. For example, a single CGI that implements WMS, WFS and WCS services. The endpoint can inspect the value of this attribute to figure out which service should process the request. The value WFS indicates that a web feature service should process the request. This parameter is somewhat redundant in the XML encoding since the request namespace can be used to determine which service should process any give request. For example, wfs:GetCapabilities and easily be distinguished from wcs:GetCapabilities using the namespaces.- Returns:
- the value of the 'Service' attribute.
- See Also:
isSetService()
,unsetService()
,setService(String)
,WfsPackage.getBaseRequestType_Service()
-
setService
void setService(String value)
Sets the value of the 'Service
' attribute.- Parameters:
value
- the new value of the 'Service' attribute.- See Also:
isSetService()
,unsetService()
,getService()
-
unsetService
void unsetService()
Unsets the value of the 'Service
' attribute.- See Also:
isSetService()
,getService()
,setService(String)
-
isSetService
boolean isSetService()
Returns whether the value of the 'Service
' attribute is set.- Returns:
- whether the value of the 'Service' attribute is set.
- See Also:
unsetService()
,getService()
,setService(String)
-
getVersion
String getVersion()
Returns the value of the 'Version' attribute. The default value is"1.1.0"
. The version attribute is used to indicate the version of the WFS specification that a request conforms to. All requests in this schema conform to V1.1 of the WFS specification. For WFS implementations that support more than one version of a WFS sepcification ... if the version attribute is not specified then the service should assume that the request conforms to greatest available specification version.- Returns:
- the value of the 'Version' attribute.
- See Also:
isSetVersion()
,unsetVersion()
,setVersion(String)
,WfsPackage.getBaseRequestType_Version()
-
setVersion
void setVersion(String value)
Sets the value of the 'Version
' attribute.- Parameters:
value
- the new value of the 'Version' attribute.- See Also:
isSetVersion()
,unsetVersion()
,getVersion()
-
unsetVersion
void unsetVersion()
Unsets the value of the 'Version
' attribute.- See Also:
isSetVersion()
,getVersion()
,setVersion(String)
-
isSetVersion
boolean isSetVersion()
Returns whether the value of the 'Version
' attribute is set.- Returns:
- whether the value of the 'Version' attribute is set.
- See Also:
unsetVersion()
,getVersion()
,setVersion(String)
-
getBaseUrl
String getBaseUrl()
Returns the value of the 'Base Url' attribute.If the meaning of the 'Base Url' attribute isn't clear, there really should be more of a description here...
- Returns:
- the value of the 'Base Url' attribute.
- See Also:
setBaseUrl(String)
,WfsPackage.getBaseRequestType_BaseUrl()
-
setBaseUrl
void setBaseUrl(String value)
Sets the value of the 'Base Url
' attribute. The base url, though not an attribute declared in the schema, is a legacy one added because we need to associate the request url being made by the client with the request object. The reason being that the request object is the only object that makes its way through the entire dispatch chain.- Parameters:
value
- the new value of the 'Base Url' attribute.- See Also:
getBaseUrl()
-
getProvidedVersion
String getProvidedVersion()
Provided version of service processing the request.
-
setProvidedVersion
void setProvidedVersion(String value)
Sets the value of the 'Provided Version
' attribute.- Parameters:
value
- the new value of the 'Provided Version' attribute.- See Also:
getProvidedVersion()
-
getExtendedProperties
Map getExtendedProperties()
Extended model properties.This map allows client to store additional properties with the this request object, properties that are not part of the model proper.
-
setExtendedProperties
void setExtendedProperties(Map value)
Sets the value of the 'Extended Properties
' attribute.- Parameters:
value
- the new value of the 'Extended Properties' attribute.- See Also:
getExtendedProperties()
-
-