001: /**
002: * <copyright>
003: * </copyright>
004: *
005: * $Id: BaseRequestType.java 7710 2007-11-05 16:23:18Z groldan $
006: */package net.opengis.wfs;
007:
008: import org.eclipse.emf.ecore.EObject;
009:
010: /**
011: * <!-- begin-user-doc -->
012: * A representation of the model object '<em><b>Base Request Type</b></em>'.
013: * <!-- end-user-doc -->
014: *
015: * <!-- begin-model-doc -->
016: *
017: * XML encoded WFS operation request base, for all operations
018: * except GetCapabilities.
019: * <!-- end-model-doc -->
020: *
021: * <p>
022: * The following features are supported:
023: * <ul>
024: * <li>{@link net.opengis.wfs.BaseRequestType#getHandle <em>Handle</em>}</li>
025: * <li>{@link net.opengis.wfs.BaseRequestType#getService <em>Service</em>}</li>
026: * <li>{@link net.opengis.wfs.BaseRequestType#getVersion <em>Version</em>}</li>
027: * <li>{@link net.opengis.wfs.BaseRequestType#getBaseUrl <em>Base Url</em>}</li>
028: * </ul>
029: * </p>
030: *
031: * @see net.opengis.wfs.WfsPackage#getBaseRequestType()
032: * @model abstract="true"
033: * extendedMetaData="name='BaseRequestType' kind='empty'"
034: * @generated
035: */
036: public interface BaseRequestType extends EObject {
037: /**
038: * Returns the value of the '<em><b>Handle</b></em>' attribute.
039: * <!-- begin-user-doc -->
040: * <!-- end-user-doc -->
041: * <!-- begin-model-doc -->
042: *
043: * The handle attribute allows a client application
044: * to assign a client-generated request identifier
045: * to a WFS request. The handle is included to
046: * facilitate error reporting. A WFS may report the
047: * handle in an exception report to identify the
048: * offending request or action. If the handle is not
049: * present, then the WFS may employ other means to
050: * localize the error (e.g. line numbers).
051: * <!-- end-model-doc -->
052: * @return the value of the '<em>Handle</em>' attribute.
053: * @see #setHandle(String)
054: * @see net.opengis.wfs.WfsPackage#getBaseRequestType_Handle()
055: * @model unique="false" dataType="org.eclipse.emf.ecore.xml.type.String"
056: * extendedMetaData="kind='attribute' name='handle'"
057: * @generated
058: */
059: String getHandle();
060:
061: /**
062: * Sets the value of the '{@link net.opengis.wfs.BaseRequestType#getHandle <em>Handle</em>}' attribute.
063: * <!-- begin-user-doc -->
064: * <!-- end-user-doc -->
065: * @param value the new value of the '<em>Handle</em>' attribute.
066: * @see #getHandle()
067: * @generated
068: */
069: void setHandle(String value);
070:
071: /**
072: * Returns the value of the '<em><b>Service</b></em>' attribute.
073: * The default value is <code>"WFS"</code>.
074: * <!-- begin-user-doc -->
075: * <!-- end-user-doc -->
076: * <!-- begin-model-doc -->
077: *
078: * The service attribute is included to support service
079: * endpoints that implement more than one OGC service.
080: * For example, a single CGI that implements WMS, WFS
081: * and WCS services.
082: * The endpoint can inspect the value of this attribute
083: * to figure out which service should process the request.
084: * The value WFS indicates that a web feature service should
085: * process the request.
086: * This parameter is somewhat redundant in the XML encoding
087: * since the request namespace can be used to determine
088: * which service should process any give request. For example,
089: * wfs:GetCapabilities and easily be distinguished from
090: * wcs:GetCapabilities using the namespaces.
091: * <!-- end-model-doc -->
092: * @return the value of the '<em>Service</em>' attribute.
093: * @see #isSetService()
094: * @see #unsetService()
095: * @see #setService(String)
096: * @see net.opengis.wfs.WfsPackage#getBaseRequestType_Service()
097: * @model default="WFS" unique="false" unsettable="true" dataType="net.opengis.wfs.ServiceType"
098: * extendedMetaData="kind='attribute' name='service'"
099: * @generated
100: */
101: String getService();
102:
103: /**
104: * Sets the value of the '{@link net.opengis.wfs.BaseRequestType#getService <em>Service</em>}' attribute.
105: * <!-- begin-user-doc -->
106: * <!-- end-user-doc -->
107: * @param value the new value of the '<em>Service</em>' attribute.
108: * @see #isSetService()
109: * @see #unsetService()
110: * @see #getService()
111: * @generated
112: */
113: void setService(String value);
114:
115: /**
116: * Unsets the value of the '{@link net.opengis.wfs.BaseRequestType#getService <em>Service</em>}' attribute.
117: * <!-- begin-user-doc -->
118: * <!-- end-user-doc -->
119: * @see #isSetService()
120: * @see #getService()
121: * @see #setService(String)
122: * @generated
123: */
124: void unsetService();
125:
126: /**
127: * Returns whether the value of the '{@link net.opengis.wfs.BaseRequestType#getService <em>Service</em>}' attribute is set.
128: * <!-- begin-user-doc -->
129: * <!-- end-user-doc -->
130: * @return whether the value of the '<em>Service</em>' attribute is set.
131: * @see #unsetService()
132: * @see #getService()
133: * @see #setService(String)
134: * @generated
135: */
136: boolean isSetService();
137:
138: /**
139: * Returns the value of the '<em><b>Version</b></em>' attribute.
140: * The default value is <code>"1.1.0"</code>.
141: * <!-- begin-user-doc -->
142: * <!-- end-user-doc -->
143: * <!-- begin-model-doc -->
144: *
145: * The version attribute is used to indicate the version of the
146: * WFS specification that a request conforms to. All requests in
147: * this schema conform to V1.1 of the WFS specification.
148: * For WFS implementations that support more than one version of
149: * a WFS sepcification ... if the version attribute is not
150: * specified then the service should assume that the request
151: * conforms to greatest available specification version.
152: * <!-- end-model-doc -->
153: * @return the value of the '<em>Version</em>' attribute.
154: * @see #isSetVersion()
155: * @see #unsetVersion()
156: * @see #setVersion(String)
157: * @see net.opengis.wfs.WfsPackage#getBaseRequestType_Version()
158: * @model default="1.1.0" unique="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.String"
159: * extendedMetaData="kind='attribute' name='version'"
160: * @generated
161: */
162: String getVersion();
163:
164: /**
165: * Sets the value of the '{@link net.opengis.wfs.BaseRequestType#getVersion <em>Version</em>}' attribute.
166: * <!-- begin-user-doc -->
167: * <!-- end-user-doc -->
168: * @param value the new value of the '<em>Version</em>' attribute.
169: * @see #isSetVersion()
170: * @see #unsetVersion()
171: * @see #getVersion()
172: * @generated
173: */
174: void setVersion(String value);
175:
176: /**
177: * Unsets the value of the '{@link net.opengis.wfs.BaseRequestType#getVersion <em>Version</em>}' attribute.
178: * <!-- begin-user-doc -->
179: * <!-- end-user-doc -->
180: * @see #isSetVersion()
181: * @see #getVersion()
182: * @see #setVersion(String)
183: * @generated
184: */
185: void unsetVersion();
186:
187: /**
188: * Returns whether the value of the '{@link net.opengis.wfs.BaseRequestType#getVersion <em>Version</em>}' attribute is set.
189: * <!-- begin-user-doc -->
190: * <!-- end-user-doc -->
191: * @return whether the value of the '<em>Version</em>' attribute is set.
192: * @see #unsetVersion()
193: * @see #getVersion()
194: * @see #setVersion(String)
195: * @generated
196: */
197: boolean isSetVersion();
198:
199: /**
200: * Returns the value of the '<em><b>Base Url</b></em>' attribute.
201: * <!-- begin-user-doc -->
202: * <p>
203: * If the meaning of the '<em>Base Url</em>' attribute isn't clear,
204: * there really should be more of a description here...
205: * </p>
206: * <!-- end-user-doc -->
207: * @return the value of the '<em>Base Url</em>' attribute.
208: * @see #setBaseUrl(String)
209: * @see net.opengis.wfs.WfsPackage#getBaseRequestType_BaseUrl()
210: * @model dataType="org.eclipse.emf.ecore.xml.type.String"
211: * @generated
212: */
213: String getBaseUrl();
214:
215: /**
216: * Sets the value of the '{@link net.opengis.wfs.BaseRequestType#getBaseUrl <em>Base Url</em>}'
217: * attribute. <!-- begin-user-doc -->
218: * The base url, though not an attribute
219: * declared in the schema, is a legacy one added because we need to
220: * associate the request url being made by the client with the request
221: * object. The reason being that the request object is the only object that
222: * makes its way through the entire dispatch chain.
223: * <!-- end-user-doc -->
224: *
225: * @param value
226: * the new value of the '<em>Base Url</em>' attribute.
227: * @see #getBaseUrl()
228: * @generated
229: */
230: void setBaseUrl(String value);
231:
232: } // BaseRequestType
|