net.opengis.wfs
Interface LockFeatureType

All Superinterfaces:
BaseRequestType, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Implementing Classes:
LockFeatureTypeImpl

public interface LockFeatureType
extends BaseRequestType

A representation of the model object 'Lock Feature Type'. This type defines the LockFeature operation. The LockFeature element contains one or more Lock elements that define which features of a particular type should be locked. A lock identifier (lockId) is returned to the client application which can be used by subsequent operations to reference the locked features.

The following features are supported:

See Also:
WfsPackage.getLockFeatureType()

Method Summary
 java.math.BigInteger getExpiry()
          Returns the value of the 'Expiry' attribute.
 org.eclipse.emf.common.util.EList getLock()
          Returns the value of the 'Lock' containment reference list.
 AllSomeType getLockAction()
          Returns the value of the 'Lock Action' attribute.
 boolean isSetExpiry()
          Returns whether the value of the 'Expiry' attribute is set.
 boolean isSetLockAction()
          Returns whether the value of the 'Lock Action' attribute is set.
 void setExpiry(java.math.BigInteger value)
          Sets the value of the 'Expiry' attribute.
 void setLockAction(AllSomeType value)
          Sets the value of the 'Lock Action' attribute.
 void unsetExpiry()
          Unsets the value of the 'Expiry' attribute.
 void unsetLockAction()
          Unsets the value of the 'Lock Action' attribute.
 
Methods inherited from interface net.opengis.wfs.BaseRequestType
getBaseUrl, getHandle, getProvidedVersion, getService, getVersion, isSetService, isSetVersion, setBaseUrl, setHandle, setProvidedVersion, setService, setVersion, unsetService, unsetVersion
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getLock

org.eclipse.emf.common.util.EList getLock()
Returns the value of the 'Lock' containment reference list. The list contents are of type LockType. The lock element is used to indicate which feature instances of particular type are to be locked.

Returns:
the value of the 'Lock' containment reference list.
See Also:
WfsPackage.getLockFeatureType_Lock()

getExpiry

java.math.BigInteger getExpiry()
Returns the value of the 'Expiry' attribute. The default value is "5". The expiry attribute is used to set the length of time (expressed in minutes) that features will remain locked as a result of a LockFeature request. After the expiry period elapses, the locked resources must be released. If the expiry attribute is not set, then the default value of 5 minutes will be enforced.

Returns:
the value of the 'Expiry' attribute.
See Also:
isSetExpiry(), unsetExpiry(), setExpiry(BigInteger), WfsPackage.getLockFeatureType_Expiry()

setExpiry

void setExpiry(java.math.BigInteger value)
Sets the value of the 'Expiry' attribute.

Parameters:
value - the new value of the 'Expiry' attribute.
See Also:
isSetExpiry(), unsetExpiry(), getExpiry()

unsetExpiry

void unsetExpiry()
Unsets the value of the 'Expiry' attribute.

See Also:
isSetExpiry(), getExpiry(), setExpiry(BigInteger)

isSetExpiry

boolean isSetExpiry()
Returns whether the value of the 'Expiry' attribute is set.

Returns:
whether the value of the 'Expiry' attribute is set.
See Also:
unsetExpiry(), getExpiry(), setExpiry(BigInteger)

getLockAction

AllSomeType getLockAction()
Returns the value of the 'Lock Action' attribute. The default value is "ALL". The literals are from the enumeration AllSomeType. The lockAction attribute is used to indicate what a Web Feature Service should do when it encounters a feature instance that has already been locked by another client application. Valid values are ALL or SOME. ALL means that the Web Feature Service must acquire locks on all the requested feature instances. If it cannot acquire those locks then the request should fail. In this instance, all locks acquired by the operation should be released. SOME means that the Web Feature Service should lock as many of the requested features as it can.

Returns:
the value of the 'Lock Action' attribute.
See Also:
AllSomeType, isSetLockAction(), unsetLockAction(), setLockAction(AllSomeType), WfsPackage.getLockFeatureType_LockAction()

setLockAction

void setLockAction(AllSomeType value)
Sets the value of the 'Lock Action' attribute.

Parameters:
value - the new value of the 'Lock Action' attribute.
See Also:
AllSomeType, isSetLockAction(), unsetLockAction(), getLockAction()

unsetLockAction

void unsetLockAction()
Unsets the value of the 'Lock Action' attribute.

See Also:
isSetLockAction(), getLockAction(), setLockAction(AllSomeType)

isSetLockAction

boolean isSetLockAction()
Returns whether the value of the 'Lock Action' attribute is set.

Returns:
whether the value of the 'Lock Action' attribute is set.
See Also:
unsetLockAction(), getLockAction(), setLockAction(AllSomeType)


Copyright © 1996-2010 Geotools. All Rights Reserved.