001: /**
002: * <copyright>
003: * </copyright>
004: *
005: * $Id: GetLogType.java 7988 2007-12-12 20:29:15Z aaime $
006: */package net.opengis.wfsv;
007:
008: import java.math.BigInteger;
009:
010: import net.opengis.wfs.BaseRequestType;
011: import net.opengis.wfs.ResultTypeType;
012:
013: import org.eclipse.emf.common.util.EList;
014:
015: /**
016: * <!-- begin-user-doc -->
017: * A representation of the model object '<em><b>Get Log Type</b></em>'.
018: * <!-- end-user-doc -->
019: *
020: * <!-- begin-model-doc -->
021: *
022: * A GetLog element contains one or more DifferenceQuery elements that describe a diffence
023: * query operation on one feature type. In response to a GetLog request, a Web Feature Service
024: * must be able to generate a list of logs entries for features matched by the DifferenceQuery
025: * parameters. Each log entry is an instance of the ChangeSet feature type. In response to a
026: * GetFeature request, a Versioning Web Feature Service must be able to generate a GML3
027: * response that validates using a schema generated by the DescribeFeatureType request against
028: * the ChangeSets feature type. A Web Feature Service may support other possibly non-XML (and
029: * even binary) output formats as long as those formats are advertised in the capabilities
030: * document.
031: *
032: * <!-- end-model-doc -->
033: *
034: * <p>
035: * The following features are supported:
036: * <ul>
037: * <li>{@link net.opengis.wfsv.GetLogType#getDifferenceQuery <em>Difference Query</em>}</li>
038: * <li>{@link net.opengis.wfsv.GetLogType#getMaxFeatures <em>Max Features</em>}</li>
039: * <li>{@link net.opengis.wfsv.GetLogType#getOutputFormat <em>Output Format</em>}</li>
040: * <li>{@link net.opengis.wfsv.GetLogType#getResultType <em>Result Type</em>}</li>
041: * </ul>
042: * </p>
043: *
044: * @see net.opengis.wfsv.WfsvPackage#getGetLogType()
045: * @model extendedMetaData="name='GetLogType' kind='elementOnly'"
046: * @generated
047: */
048: public interface GetLogType extends BaseRequestType {
049: /**
050: * Returns the value of the '<em><b>Difference Query</b></em>' containment reference list.
051: * The list contents are of type {@link net.opengis.wfsv.DifferenceQueryType}.
052: * <!-- begin-user-doc -->
053: * <!-- end-user-doc -->
054: * <!-- begin-model-doc -->
055: *
056: * The DifferenceFilter element is used to gather differences in features matched by a standard
057: * OGC filter at starting and ending featureVersion, and a filter used to match
058: *
059: * <!-- end-model-doc -->
060: * @return the value of the '<em>Difference Query</em>' containment reference list.
061: * @see net.opengis.wfsv.WfsvPackage#getGetLogType_DifferenceQuery()
062: * @model type="net.opengis.wfsv.DifferenceQueryType" containment="true" required="true"
063: * extendedMetaData="kind='element' name='DifferenceQuery' namespace='##targetNamespace'"
064: * @generated
065: */
066: EList getDifferenceQuery();
067:
068: /**
069: * Returns the value of the '<em><b>Max Features</b></em>' attribute.
070: * <!-- begin-user-doc -->
071: * <!-- end-user-doc -->
072: * <!-- begin-model-doc -->
073: *
074: * The maxFeatures attribute is used to specify the maximum number of features that a
075: * GetFeature operation should generate (regardless of the actual number of query hits).
076: *
077: * <!-- end-model-doc -->
078: * @return the value of the '<em>Max Features</em>' attribute.
079: * @see #setMaxFeatures(BigInteger)
080: * @see net.opengis.wfsv.WfsvPackage#getGetLogType_MaxFeatures()
081: * @model dataType="org.eclipse.emf.ecore.xml.type.PositiveInteger"
082: * extendedMetaData="kind='attribute' name='maxFeatures'"
083: * @generated
084: */
085: BigInteger getMaxFeatures();
086:
087: /**
088: * Sets the value of the '{@link net.opengis.wfsv.GetLogType#getMaxFeatures <em>Max Features</em>}' attribute.
089: * <!-- begin-user-doc -->
090: * <!-- end-user-doc -->
091: * @param value the new value of the '<em>Max Features</em>' attribute.
092: * @see #getMaxFeatures()
093: * @generated
094: */
095: void setMaxFeatures(BigInteger value);
096:
097: /**
098: * Returns the value of the '<em><b>Output Format</b></em>' attribute.
099: * The default value is <code>"text/xml; subtype=gml/3.1.1"</code>.
100: * <!-- begin-user-doc -->
101: * <!-- end-user-doc -->
102: * <!-- begin-model-doc -->
103: *
104: * The outputFormat attribute is used to specify the output format that the Versioning
105: * Web Feature Service should generate in response to a GetLog element. The default value
106: * of 'text/xml; subtype=gml/3.1.1' indicates that the output is an XML document that
107: * conforms to the Geography Markup Language (GML) Implementation Specification V3.1.1.
108: * For the purposes of experimentation, vendor extension, or even extensions that serve a
109: * specific community of interest, other acceptable output format values may be used to
110: * specify other formats as long as those values are advertised in the capabilities
111: * document.
112: *
113: * <!-- end-model-doc -->
114: * @return the value of the '<em>Output Format</em>' attribute.
115: * @see #isSetOutputFormat()
116: * @see #unsetOutputFormat()
117: * @see #setOutputFormat(String)
118: * @see net.opengis.wfsv.WfsvPackage#getGetLogType_OutputFormat()
119: * @model default="text/xml; subtype=gml/3.1.1" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.String"
120: * extendedMetaData="kind='attribute' name='outputFormat'"
121: * @generated
122: */
123: String getOutputFormat();
124:
125: /**
126: * Sets the value of the '{@link net.opengis.wfsv.GetLogType#getOutputFormat <em>Output Format</em>}' attribute.
127: * <!-- begin-user-doc -->
128: * <!-- end-user-doc -->
129: * @param value the new value of the '<em>Output Format</em>' attribute.
130: * @see #isSetOutputFormat()
131: * @see #unsetOutputFormat()
132: * @see #getOutputFormat()
133: * @generated
134: */
135: void setOutputFormat(String value);
136:
137: /**
138: * Unsets the value of the '{@link net.opengis.wfsv.GetLogType#getOutputFormat <em>Output Format</em>}' attribute.
139: * <!-- begin-user-doc -->
140: * <!-- end-user-doc -->
141: * @see #isSetOutputFormat()
142: * @see #getOutputFormat()
143: * @see #setOutputFormat(String)
144: * @generated
145: */
146: void unsetOutputFormat();
147:
148: /**
149: * Returns whether the value of the '{@link net.opengis.wfsv.GetLogType#getOutputFormat <em>Output Format</em>}' attribute is set.
150: * <!-- begin-user-doc -->
151: * <!-- end-user-doc -->
152: * @return whether the value of the '<em>Output Format</em>' attribute is set.
153: * @see #unsetOutputFormat()
154: * @see #getOutputFormat()
155: * @see #setOutputFormat(String)
156: * @generated
157: */
158: boolean isSetOutputFormat();
159:
160: /**
161: * Returns the value of the '<em><b>Result Type</b></em>' attribute.
162: * The default value is <code>"results"</code>.
163: * The literals are from the enumeration {@link net.opengis.wfs.ResultTypeType}.
164: * <!-- begin-user-doc -->
165: * <!-- end-user-doc -->
166: * <!-- begin-model-doc -->
167: *
168: * The resultType attribute is used to indicate what response a wfsv should return to
169: * user once a GetFeature request is processed. Possible values are: results - meaning
170: * that the full response set (i.e. all the feature instances) should be returned. hits -
171: * meaning that an empty response set should be returned (i.e. no feature instances
172: * should be returned) but the "numberOfFeatures" attribute should be set to the number
173: * of feature instances that would be returned.
174: *
175: * <!-- end-model-doc -->
176: * @return the value of the '<em>Result Type</em>' attribute.
177: * @see net.opengis.wfs.ResultTypeType
178: * @see #isSetResultType()
179: * @see #unsetResultType()
180: * @see #setResultType(ResultTypeType)
181: * @see net.opengis.wfsv.WfsvPackage#getGetLogType_ResultType()
182: * @model default="results" unsettable="true"
183: * extendedMetaData="kind='attribute' name='resultType'"
184: * @generated
185: */
186: ResultTypeType getResultType();
187:
188: /**
189: * Sets the value of the '{@link net.opengis.wfsv.GetLogType#getResultType <em>Result Type</em>}' attribute.
190: * <!-- begin-user-doc -->
191: * <!-- end-user-doc -->
192: * @param value the new value of the '<em>Result Type</em>' attribute.
193: * @see net.opengis.wfs.ResultTypeType
194: * @see #isSetResultType()
195: * @see #unsetResultType()
196: * @see #getResultType()
197: * @generated
198: */
199: void setResultType(ResultTypeType value);
200:
201: /**
202: * Unsets the value of the '{@link net.opengis.wfsv.GetLogType#getResultType <em>Result Type</em>}' attribute.
203: * <!-- begin-user-doc -->
204: * <!-- end-user-doc -->
205: * @see #isSetResultType()
206: * @see #getResultType()
207: * @see #setResultType(ResultTypeType)
208: * @generated
209: */
210: void unsetResultType();
211:
212: /**
213: * Returns whether the value of the '{@link net.opengis.wfsv.GetLogType#getResultType <em>Result Type</em>}' attribute is set.
214: * <!-- begin-user-doc -->
215: * <!-- end-user-doc -->
216: * @return whether the value of the '<em>Result Type</em>' attribute is set.
217: * @see #unsetResultType()
218: * @see #getResultType()
219: * @see #setResultType(ResultTypeType)
220: * @generated
221: */
222: boolean isSetResultType();
223:
224: } // GetLogType
|