public class TLcdWFSLockFeatureRequest extends Object implements ILcdOWSRequest
LockFeature
request. Instances of this class can not be created directly. An
instance can be created using the TLcdWFSClient.createLockFeatureRequest()
method. This
method will ensure a request object is created that is compatible with the WFS version
implemented by the WFS server.Modifier and Type | Class and Description |
---|---|
static class |
TLcdWFSLockFeatureRequest.LockAction
An enumeration that corresponds to the 'LockAction' attribute of 'GetFeaturesWithLock' and
'LockFeatures' requests.
|
Modifier and Type | Method and Description |
---|---|
void |
addFeatures(QName aTypeName,
TLcdOGCFilter aFilter,
String aHandle)
Adds a set of features which should be locked by this request.
|
Map |
getKVPEncoding()
LockFeature requests do not support KVP encoding. |
URI |
getRestEncoding(URI aBaseURI)
Returns
null , REST encoding is not supported. |
Object |
getTransportData()
Returns an object representing data to be used by the transportation layer (see
ILcdOWSTransport )
to perform this OGC Web Service request. |
InputStream |
getXMLEncoding()
Returns the XML encoding of this request.
|
void |
setExpiry(int aExpiry)
Sets the requested expiry time for the lock in seconds.
|
void |
setHandle(String aHandle)
Sets the optional handle of this request.
|
void |
setLockAction(TLcdWFSLockFeatureRequest.LockAction aLockAction)
Sets the lock action.
|
public void setLockAction(TLcdWFSLockFeatureRequest.LockAction aLockAction)
ALL
and SOME
, as
defined in this class. By default, ALL
is set.
Set to null
to reset to the default.aLockAction
- The lock action which should be set on this request.TLcdWFSLockFeatureRequest.LockAction.ALL
,
TLcdWFSLockFeatureRequest.LockAction.SOME
public void setExpiry(int aExpiry)
aExpiry
- A positive integer which represent the lock expiry time in seconds.public void setHandle(String aHandle)
aHandle
- A String which can be used to identify this request,
or null
if no handle should be used.public void addFeatures(QName aTypeName, TLcdOGCFilter aFilter, String aHandle)
aTypeName
- The type name of the featuresaFilter
- A filter which specifies which features of type aTypeName should be locked.aHandle
- A handle which will be used by the server in an exception report if present.
Can be set to null.public Map getKVPEncoding()
LockFeature
requests do not support KVP encoding.getKVPEncoding
in interface ILcdOWSRequest
null
, indicating that KVP encoding is not supported for LockFeature
requests.public Object getTransportData()
ILcdOWSRequest
ILcdOWSTransport
)
to perform this OGC Web Service request. The type of object and the data contained in it depends on
the ILcdOWSTransport
object used to perform this request.
An example in the case of a HTTP transport connection is a map of request properties
(see URLConnection.getRequestProperties()
) to be used
for the request.getTransportData
in interface ILcdOWSRequest
public InputStream getXMLEncoding()
ILcdOWSRequest
null
should be returned.getXMLEncoding
in interface ILcdOWSRequest
public URI getRestEncoding(URI aBaseURI)
null
, REST encoding is not supported.getRestEncoding
in interface ILcdOWSRequest
aBaseURI
- null