001: /**
002: * <copyright>
003: * </copyright>
004: *
005: * $Id: ExceptionType.java 7522 2007-09-12 22:00:10Z saul.farber $
006: */package net.opengis.ows;
007:
008: import java.util.List;
009:
010: import org.eclipse.emf.common.util.EList;
011:
012: import org.eclipse.emf.ecore.EObject;
013:
014: /**
015: * <!-- begin-user-doc -->
016: * A representation of the model object '<em><b>Exception Type</b></em>'.
017: * <!-- end-user-doc -->
018: *
019: * <!-- begin-model-doc -->
020: * An Exception element describes one detected error that a server chooses to convey to the client.
021: * <!-- end-model-doc -->
022: *
023: * <p>
024: * The following features are supported:
025: * <ul>
026: * <li>{@link net.opengis.ows.ExceptionType#getExceptionText <em>Exception Text</em>}</li>
027: * <li>{@link net.opengis.ows.ExceptionType#getExceptionCode <em>Exception Code</em>}</li>
028: * <li>{@link net.opengis.ows.ExceptionType#getLocator <em>Locator</em>}</li>
029: * </ul>
030: * </p>
031: *
032: * @see net.opengis.ows.OwsPackage#getExceptionType()
033: * @model extendedMetaData="name='ExceptionType' kind='elementOnly'"
034: * @generated
035: */
036: public interface ExceptionType extends EObject {
037: /**
038: * Returns the value of the '<em><b>Exception Text</b></em>' attribute.
039: * <!-- begin-user-doc -->
040: * <!-- end-user-doc -->
041: * <!-- begin-model-doc -->
042: * Ordered sequence of text strings that describe this specific exception or error. The contents of these strings are left open to definition by each server implementation. A server is strongly encouraged to include at least one ExceptionText value, to provide more information about the detected error than provided by the exceptionCode. When included, multiple ExceptionText values shall provide hierarchical information about one detected error, with the most significant information listed first.
043: * <!-- end-model-doc -->
044: * @return the value of the '<em>Exception Text</em>' attribute.
045: * @see #setExceptionText(String)
046: * @see net.opengis.ows.OwsPackage#getExceptionType_ExceptionText()
047: * @model type="java.lang.String"
048: */
049: EList getExceptionText();
050:
051: /**
052: * Returns the value of the '<em><b>Exception Code</b></em>' attribute.
053: * <!-- begin-user-doc -->
054: * <!-- end-user-doc -->
055: * <!-- begin-model-doc -->
056: * A code representing the type of this exception, which shall be selected from a set of exceptionCode values specified for the specific service operation and server.
057: * <!-- end-model-doc -->
058: * @return the value of the '<em>Exception Code</em>' attribute.
059: * @see #setExceptionCode(String)
060: * @see net.opengis.ows.OwsPackage#getExceptionType_ExceptionCode()
061: * @model unique="false" dataType="org.eclipse.emf.ecore.xml.type.String" required="true"
062: * extendedMetaData="kind='attribute' name='exceptionCode'"
063: * @generated
064: */
065: String getExceptionCode();
066:
067: /**
068: * Sets the value of the '{@link net.opengis.ows.ExceptionType#getExceptionCode <em>Exception Code</em>}' attribute.
069: * <!-- begin-user-doc -->
070: * <!-- end-user-doc -->
071: * @param value the new value of the '<em>Exception Code</em>' attribute.
072: * @see #getExceptionCode()
073: * @generated
074: */
075: void setExceptionCode(String value);
076:
077: /**
078: * Returns the value of the '<em><b>Locator</b></em>' attribute.
079: * <!-- begin-user-doc -->
080: * <!-- end-user-doc -->
081: * <!-- begin-model-doc -->
082: * When included, this locator shall indicate to the client where an exception was encountered in servicing the client's operation request. This locator should be included whenever meaningful information can be provided by the server. The contents of this locator will depend on the specific exceptionCode and OWS service, and shall be specified in the OWS Implementation Specification.
083: * <!-- end-model-doc -->
084: * @return the value of the '<em>Locator</em>' attribute.
085: * @see #setLocator(String)
086: * @see net.opengis.ows.OwsPackage#getExceptionType_Locator()
087: * @model unique="false" dataType="org.eclipse.emf.ecore.xml.type.String"
088: * extendedMetaData="kind='attribute' name='locator'"
089: * @generated
090: */
091: String getLocator();
092:
093: /**
094: * Sets the value of the '{@link net.opengis.ows.ExceptionType#getLocator <em>Locator</em>}' attribute.
095: * <!-- begin-user-doc -->
096: * <!-- end-user-doc -->
097: * @param value the new value of the '<em>Locator</em>' attribute.
098: * @see #getLocator()
099: * @generated
100: */
101: void setLocator(String value);
102:
103: } // ExceptionType
|