Package com.luciad.ogc.ows.model

Class TLcdOWSException

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.ogc.ows.model.TLcdOWSException
All Implemented Interfaces:
ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable
public class TLcdOWSException extends TLcdDataObject
This class describes one detected error that a server chooses to convey to the client.

  • Field Details

    • EXCEPTION_CODE_PROPERTY

      public static final TLcdDataProperty EXCEPTION_CODE_PROPERTY
      Data property that maps to the exceptionCode attribute. The possible values for this property are instances of String.

    • LOCATOR_PROPERTY

      public static final TLcdDataProperty LOCATOR_PROPERTY
      Data property that maps to the locator attribute. The possible values for this property are instances of String.

    • EXCEPTION_TEXT_PROPERTY

      public static final TLcdDataProperty EXCEPTION_TEXT_PROPERTY
      Data property that maps to the ExceptionText element. The possible values for this property are instances of List<String>.

  • Constructor Details

    • TLcdOWSException

      public TLcdOWSException()

  • Method Details

    • addExceptionText

      public void addExceptionText(String aExceptionText)
      Adds a exception text.

      Ordered sequence of text strings that describe this specific exception or error.

      Parameters:
      aExceptionText - the exception text to be added.

    • getExceptionTextCount

      public int getExceptionTextCount()
      Gets the number of exception texts.
      Returns:
      the number of exception texts.

    • removeExceptionText

      public void removeExceptionText(int aIndex)
      Removes the exception text at a given position.
      Parameters:
      aIndex - the index of the given position.

    • getExceptionText

      public String getExceptionText(int aIndex)
      Gets the exception text at a given position.

      Ordered sequence of text strings that describe this specific exception or error.

      Parameters:
      aIndex - the index of the given position.
      Returns:
      the exception text at the given position.

    • toString

      public String toString()
      Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
      Overrides:
      toString in class TLcdDataObject
      Returns:
      a string representation of the object.

    • getExceptionCode

      public String getExceptionCode()
      Returns the value of the property that maps to the exceptionCode attribute.

      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.

      Returns:
      the value of the EXCEPTION_CODE_PROPERTY property.

    • setExceptionCode

      public void setExceptionCode(String aValue)
      Sets the value of the property that maps to the exceptionCode attribute.

      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.

      Parameters:
      aValue - the value to set for the EXCEPTION_CODE_PROPERTY property.

    • getLocator

      public String getLocator()
      Returns the value of the property that maps to the locator attribute.

      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.

      Returns:
      the value of the LOCATOR_PROPERTY property.

    • setLocator

      public void setLocator(String aValue)
      Sets the value of the property that maps to the locator attribute.

      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.

      Parameters:
      aValue - the value to set for the LOCATOR_PROPERTY property.

    • getExceptionText

      public List<String> getExceptionText()
      Returns the value of the property that maps to the ExceptionText element.

      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.

      Returns:
      the value of the EXCEPTION_TEXT_PROPERTY property.