001: /**
002: * <copyright>
003: * </copyright>
004: *
005: * $Id: LockFeatureType.java 7522 2007-09-12 22:00:10Z saul.farber $
006: */package net.opengis.wfs;
007:
008: import java.math.BigInteger;
009:
010: import org.eclipse.emf.common.util.EList;
011:
012: /**
013: * <!-- begin-user-doc -->
014: * A representation of the model object '<em><b>Lock Feature Type</b></em>'.
015: * <!-- end-user-doc -->
016: *
017: * <!-- begin-model-doc -->
018: *
019: * This type defines the LockFeature operation. The LockFeature
020: * element contains one or more Lock elements that define which
021: * features of a particular type should be locked. A lock
022: * identifier (lockId) is returned to the client application which
023: * can be used by subsequent operations to reference the locked
024: * features.
025: * <!-- end-model-doc -->
026: *
027: * <p>
028: * The following features are supported:
029: * <ul>
030: * <li>{@link net.opengis.wfs.LockFeatureType#getLock <em>Lock</em>}</li>
031: * <li>{@link net.opengis.wfs.LockFeatureType#getExpiry <em>Expiry</em>}</li>
032: * <li>{@link net.opengis.wfs.LockFeatureType#getLockAction <em>Lock Action</em>}</li>
033: * </ul>
034: * </p>
035: *
036: * @see net.opengis.wfs.WfsPackage#getLockFeatureType()
037: * @model extendedMetaData="name='LockFeatureType' kind='elementOnly'"
038: * @generated
039: */
040: public interface LockFeatureType extends BaseRequestType {
041: /**
042: * Returns the value of the '<em><b>Lock</b></em>' containment reference list.
043: * The list contents are of type {@link net.opengis.wfs.LockType}.
044: * <!-- begin-user-doc -->
045: * <!-- end-user-doc -->
046: * <!-- begin-model-doc -->
047: *
048: * The lock element is used to indicate which feature
049: * instances of particular type are to be locked.
050: * <!-- end-model-doc -->
051: * @return the value of the '<em>Lock</em>' containment reference list.
052: * @see net.opengis.wfs.WfsPackage#getLockFeatureType_Lock()
053: * @model type="net.opengis.wfs.LockType" containment="true" required="true"
054: * extendedMetaData="kind='element' name='Lock' namespace='##targetNamespace'"
055: * @generated
056: */
057: EList getLock();
058:
059: /**
060: * Returns the value of the '<em><b>Expiry</b></em>' attribute.
061: * The default value is <code>"5"</code>.
062: * <!-- begin-user-doc -->
063: * <!-- end-user-doc -->
064: * <!-- begin-model-doc -->
065: *
066: * The expiry attribute is used to set the length
067: * of time (expressed in minutes) that features will
068: * remain locked as a result of a LockFeature
069: * request. After the expiry period elapses, the
070: * locked resources must be released. If the
071: * expiry attribute is not set, then the default
072: * value of 5 minutes will be enforced.
073: * <!-- end-model-doc -->
074: * @return the value of the '<em>Expiry</em>' attribute.
075: * @see #isSetExpiry()
076: * @see #unsetExpiry()
077: * @see #setExpiry(BigInteger)
078: * @see net.opengis.wfs.WfsPackage#getLockFeatureType_Expiry()
079: * @model default="5" unique="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.PositiveInteger"
080: * extendedMetaData="kind='attribute' name='expiry'"
081: * @generated
082: */
083: BigInteger getExpiry();
084:
085: /**
086: * Sets the value of the '{@link net.opengis.wfs.LockFeatureType#getExpiry <em>Expiry</em>}' attribute.
087: * <!-- begin-user-doc -->
088: * <!-- end-user-doc -->
089: * @param value the new value of the '<em>Expiry</em>' attribute.
090: * @see #isSetExpiry()
091: * @see #unsetExpiry()
092: * @see #getExpiry()
093: * @generated
094: */
095: void setExpiry(BigInteger value);
096:
097: /**
098: * Unsets the value of the '{@link net.opengis.wfs.LockFeatureType#getExpiry <em>Expiry</em>}' attribute.
099: * <!-- begin-user-doc -->
100: * <!-- end-user-doc -->
101: * @see #isSetExpiry()
102: * @see #getExpiry()
103: * @see #setExpiry(BigInteger)
104: * @generated
105: */
106: void unsetExpiry();
107:
108: /**
109: * Returns whether the value of the '{@link net.opengis.wfs.LockFeatureType#getExpiry <em>Expiry</em>}' attribute is set.
110: * <!-- begin-user-doc -->
111: * <!-- end-user-doc -->
112: * @return whether the value of the '<em>Expiry</em>' attribute is set.
113: * @see #unsetExpiry()
114: * @see #getExpiry()
115: * @see #setExpiry(BigInteger)
116: * @generated
117: */
118: boolean isSetExpiry();
119:
120: /**
121: * Returns the value of the '<em><b>Lock Action</b></em>' attribute.
122: * The default value is <code>"ALL"</code>.
123: * The literals are from the enumeration {@link net.opengis.wfs.AllSomeType}.
124: * <!-- begin-user-doc -->
125: * <!-- end-user-doc -->
126: * <!-- begin-model-doc -->
127: *
128: * The lockAction attribute is used to indicate what
129: * a Web Feature Service should do when it encounters
130: * a feature instance that has already been locked by
131: * another client application.
132: *
133: * Valid values are ALL or SOME.
134: *
135: * ALL means that the Web Feature Service must acquire
136: * locks on all the requested feature instances. If it
137: * cannot acquire those locks then the request should
138: * fail. In this instance, all locks acquired by the
139: * operation should be released.
140: *
141: * SOME means that the Web Feature Service should lock
142: * as many of the requested features as it can.
143: * <!-- end-model-doc -->
144: * @return the value of the '<em>Lock Action</em>' attribute.
145: * @see net.opengis.wfs.AllSomeType
146: * @see #isSetLockAction()
147: * @see #unsetLockAction()
148: * @see #setLockAction(AllSomeType)
149: * @see net.opengis.wfs.WfsPackage#getLockFeatureType_LockAction()
150: * @model default="ALL" unique="false" unsettable="true"
151: * extendedMetaData="kind='attribute' name='lockAction'"
152: * @generated
153: */
154: AllSomeType getLockAction();
155:
156: /**
157: * Sets the value of the '{@link net.opengis.wfs.LockFeatureType#getLockAction <em>Lock Action</em>}' attribute.
158: * <!-- begin-user-doc -->
159: * <!-- end-user-doc -->
160: * @param value the new value of the '<em>Lock Action</em>' attribute.
161: * @see net.opengis.wfs.AllSomeType
162: * @see #isSetLockAction()
163: * @see #unsetLockAction()
164: * @see #getLockAction()
165: * @generated
166: */
167: void setLockAction(AllSomeType value);
168:
169: /**
170: * Unsets the value of the '{@link net.opengis.wfs.LockFeatureType#getLockAction <em>Lock Action</em>}' attribute.
171: * <!-- begin-user-doc -->
172: * <!-- end-user-doc -->
173: * @see #isSetLockAction()
174: * @see #getLockAction()
175: * @see #setLockAction(AllSomeType)
176: * @generated
177: */
178: void unsetLockAction();
179:
180: /**
181: * Returns whether the value of the '{@link net.opengis.wfs.LockFeatureType#getLockAction <em>Lock Action</em>}' attribute is set.
182: * <!-- begin-user-doc -->
183: * <!-- end-user-doc -->
184: * @return whether the value of the '<em>Lock Action</em>' attribute is set.
185: * @see #unsetLockAction()
186: * @see #getLockAction()
187: * @see #setLockAction(AllSomeType)
188: * @generated
189: */
190: boolean isSetLockAction();
191:
192: } // LockFeatureType
|