Package com.luciad.ogc.wfs.client

Class TLcdWFSGetFeatureWithLockRequest

java.lang.Object

com.luciad.ogc.wfs.client.TLcdWFSGetFeatureRequest

com.luciad.ogc.wfs.client.TLcdWFSGetFeatureWithLockRequest

All Implemented Interfaces:

ILcdOWSRequest

public class TLcdWFSGetFeatureWithLockRequest
extends TLcdWFSGetFeatureRequest

A WFS GetFeatureWithLock request. Instances of this class can not be created directly. An instance can be created using the TLcdWFSClient.createGetFeatureWithLockRequest() method. This method will ensure a request object is created that is compatible with the WFS version implemented by the WFS server.

This class extends the GetFeature request class with the necessary properties to request a lock.

Since:

10.0

Field Summary

Fields inherited from class com.luciad.ogc.wfs.client.TLcdWFSGetFeatureRequest

RESULT_TYPE_HITS, RESULT_TYPE_RESULTS

Method Summary

Modifier and Type	Method	Description
Map	getKVPEncoding()	Returns a key-value pair (KVP) encoding of this 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	setLockAction(TLcdWFSLockFeatureRequest.LockAction aLockAction)	Sets the lock action.

Methods inherited from class com.luciad.ogc.wfs.client.TLcdWFSGetFeatureRequest

getRestEncoding, getTransportData, setBoundingBox, setBoundingBox, setMaxFeatures, setOGCFilter, setOGCFilters, setOGCSortBy, setOutputFormat, setResultType, setTransportData, setTypeName, setTypeNames

Methods inherited from class java.lang.Object

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

Method Details

setExpiry

public void setExpiry(int aExpiry)

Sets the requested expiry time for the lock in seconds. The expiry determines how long the lock will remain valid after its creation. The expiry of a lock can also be reset by other requests. By default, the expiry is set to 300 seconds. In case the WFS server does not support WFS 2.0.0, the expiry time is automatically converted to minutes, which is the time unit used by WFS 1.0.0 and 1.1.0. If this conversion results in a decimal value, the next minute is used; for example, 100 seconds results in 2 minutes.

Parameters:

aExpiry - A positive integer which represent the lock expiry time in seconds.

setLockAction

public void setLockAction(TLcdWFSLockFeatureRequest.LockAction aLockAction)

Sets the lock action. Valid values are the enumeration values ALL and SOME, as defined in TLcdWFSLockFeatureRequest. By default, this is set to ALL. Set to null to reset to the default. Note that this parameter is not officially supported in WFS 1.0.0 for GetFeatureWithLock requests. It will still be included in KVP requests but not in XML requests, to remain compliant with the OGC WFS 1.0.0 XML Schemas.

Parameters:

aLockAction - The lock action which should be set on this request.

See Also:

• TLcdWFSLockFeatureRequest.LockAction.ALL
• TLcdWFSLockFeatureRequest.LockAction.SOME

getKVPEncoding

public Map getKVPEncoding()

Description copied from class: TLcdWFSGetFeatureRequest

Returns a key-value pair (KVP) encoding of this request.

If no key-value pairs are defined, an empty map should be returned. If no key-value pair encoding is supported for this request, null should be returned.

Specified by:

getKVPEncoding in interface ILcdOWSRequest

Overrides:

getKVPEncoding in class TLcdWFSGetFeatureRequest

Returns:

the key-value pair (KVP) representation of this request.

getXMLEncoding

public InputStream getXMLEncoding()

Description copied from class: TLcdWFSGetFeatureRequest

Returns the XML encoding of this request.

If no XML encoding is supported for this request, nullshould be returned.

Specified by:

getXMLEncoding in interface ILcdOWSRequest

Overrides:

getXMLEncoding in class TLcdWFSGetFeatureRequest

Returns:

the XML representation of this request.