001: /**
002: * <copyright>
003: * </copyright>
004: *
005: * $Id: TransactionResponseType.java 7522 2007-09-12 22:00:10Z saul.farber $
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>Transaction Response Type</b></em>'.
013: * <!-- end-user-doc -->
014: *
015: * <!-- begin-model-doc -->
016: *
017: * The response for a transaction request that was successfully
018: * completed. If the transaction failed for any reason, an
019: * exception report is returned instead.
020: * <!-- end-model-doc -->
021: *
022: * <p>
023: * The following features are supported:
024: * <ul>
025: * <li>{@link net.opengis.wfs.TransactionResponseType#getTransactionSummary <em>Transaction Summary</em>}</li>
026: * <li>{@link net.opengis.wfs.TransactionResponseType#getTransactionResults <em>Transaction Results</em>}</li>
027: * <li>{@link net.opengis.wfs.TransactionResponseType#getInsertResults <em>Insert Results</em>}</li>
028: * <li>{@link net.opengis.wfs.TransactionResponseType#getVersion <em>Version</em>}</li>
029: * </ul>
030: * </p>
031: *
032: * @see net.opengis.wfs.WfsPackage#getTransactionResponseType()
033: * @model extendedMetaData="name='TransactionResponseType' kind='elementOnly'"
034: * @generated
035: */
036: public interface TransactionResponseType extends EObject {
037: /**
038: * Returns the value of the '<em><b>Transaction Summary</b></em>' containment reference.
039: * <!-- begin-user-doc -->
040: * <!-- end-user-doc -->
041: * <!-- begin-model-doc -->
042: *
043: * The TransactionSummary element is used to summarize
044: * the number of feature instances affected by the
045: * transaction.
046: * <!-- end-model-doc -->
047: * @return the value of the '<em>Transaction Summary</em>' containment reference.
048: * @see #setTransactionSummary(TransactionSummaryType)
049: * @see net.opengis.wfs.WfsPackage#getTransactionResponseType_TransactionSummary()
050: * @model containment="true" required="true"
051: * extendedMetaData="kind='element' name='TransactionSummary' namespace='##targetNamespace'"
052: * @generated
053: */
054: TransactionSummaryType getTransactionSummary();
055:
056: /**
057: * Sets the value of the '{@link net.opengis.wfs.TransactionResponseType#getTransactionSummary <em>Transaction Summary</em>}' containment reference.
058: * <!-- begin-user-doc -->
059: * <!-- end-user-doc -->
060: * @param value the new value of the '<em>Transaction Summary</em>' containment reference.
061: * @see #getTransactionSummary()
062: * @generated
063: */
064: void setTransactionSummary(TransactionSummaryType value);
065:
066: /**
067: * Returns the value of the '<em><b>Transaction Results</b></em>' containment reference.
068: * <!-- begin-user-doc -->
069: * <!-- end-user-doc -->
070: * <!-- begin-model-doc -->
071: *
072: * For systems that do not support atomic transactions,
073: * the TransactionResults element may be used to report
074: * exception codes and messages for all actions of a
075: * transaction that failed to execute successfully.
076: * <!-- end-model-doc -->
077: * @return the value of the '<em>Transaction Results</em>' containment reference.
078: * @see #setTransactionResults(TransactionResultsType)
079: * @see net.opengis.wfs.WfsPackage#getTransactionResponseType_TransactionResults()
080: * @model containment="true"
081: * extendedMetaData="kind='element' name='TransactionResults' namespace='##targetNamespace'"
082: * @generated
083: */
084: TransactionResultsType getTransactionResults();
085:
086: /**
087: * Sets the value of the '{@link net.opengis.wfs.TransactionResponseType#getTransactionResults <em>Transaction Results</em>}' containment reference.
088: * <!-- begin-user-doc -->
089: * <!-- end-user-doc -->
090: * @param value the new value of the '<em>Transaction Results</em>' containment reference.
091: * @see #getTransactionResults()
092: * @generated
093: */
094: void setTransactionResults(TransactionResultsType value);
095:
096: /**
097: * Returns the value of the '<em><b>Insert Results</b></em>' containment reference.
098: * <!-- begin-user-doc -->
099: * <!-- end-user-doc -->
100: * <!-- begin-model-doc -->
101: *
102: * A transaction is a collection of Insert,Update and Delete
103: * actions. The Update and Delete actions modify features
104: * that already exist. The Insert action, however, creates
105: * new features. The InsertResults element is used to
106: * report the identifiers of the newly created features.
107: * <!-- end-model-doc -->
108: * @return the value of the '<em>Insert Results</em>' containment reference.
109: * @see #setInsertResults(InsertResultsType)
110: * @see net.opengis.wfs.WfsPackage#getTransactionResponseType_InsertResults()
111: * @model containment="true" required="true"
112: * extendedMetaData="kind='element' name='InsertResults' namespace='##targetNamespace'"
113: * @generated
114: */
115: InsertResultsType getInsertResults();
116:
117: /**
118: * Sets the value of the '{@link net.opengis.wfs.TransactionResponseType#getInsertResults <em>Insert Results</em>}' containment reference.
119: * <!-- begin-user-doc -->
120: * <!-- end-user-doc -->
121: * @param value the new value of the '<em>Insert Results</em>' containment reference.
122: * @see #getInsertResults()
123: * @generated
124: */
125: void setInsertResults(InsertResultsType value);
126:
127: /**
128: * Returns the value of the '<em><b>Version</b></em>' attribute.
129: * The default value is <code>"1.1.0"</code>.
130: * <!-- begin-user-doc -->
131: * <!-- end-user-doc -->
132: * <!-- begin-model-doc -->
133: *
134: * The version attribute contains the version of the request
135: * that generated this response. So a V1.1.0 transaction
136: * request generates a V1.1.0 transaction response.
137: * <!-- end-model-doc -->
138: * @return the value of the '<em>Version</em>' attribute.
139: * @see #isSetVersion()
140: * @see #unsetVersion()
141: * @see #setVersion(String)
142: * @see net.opengis.wfs.WfsPackage#getTransactionResponseType_Version()
143: * @model default="1.1.0" unique="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.String" required="true"
144: * extendedMetaData="kind='attribute' name='version'"
145: * @generated
146: */
147: String getVersion();
148:
149: /**
150: * Sets the value of the '{@link net.opengis.wfs.TransactionResponseType#getVersion <em>Version</em>}' attribute.
151: * <!-- begin-user-doc -->
152: * <!-- end-user-doc -->
153: * @param value the new value of the '<em>Version</em>' attribute.
154: * @see #isSetVersion()
155: * @see #unsetVersion()
156: * @see #getVersion()
157: * @generated
158: */
159: void setVersion(String value);
160:
161: /**
162: * Unsets the value of the '{@link net.opengis.wfs.TransactionResponseType#getVersion <em>Version</em>}' attribute.
163: * <!-- begin-user-doc -->
164: * <!-- end-user-doc -->
165: * @see #isSetVersion()
166: * @see #getVersion()
167: * @see #setVersion(String)
168: * @generated
169: */
170: void unsetVersion();
171:
172: /**
173: * Returns whether the value of the '{@link net.opengis.wfs.TransactionResponseType#getVersion <em>Version</em>}' attribute is set.
174: * <!-- begin-user-doc -->
175: * <!-- end-user-doc -->
176: * @return whether the value of the '<em>Version</em>' attribute is set.
177: * @see #unsetVersion()
178: * @see #getVersion()
179: * @see #setVersion(String)
180: * @generated
181: */
182: boolean isSetVersion();
183:
184: } // TransactionResponseType
|