public class TLcdOWSException extends TLcdDataObject
Modifier and Type | Field and Description |
---|---|
static TLcdDataProperty |
EXCEPTION_CODE_PROPERTY
Data property that maps to the
exceptionCode attribute. |
static TLcdDataProperty |
EXCEPTION_TEXT_PROPERTY
Data property that maps to the
ExceptionText element. |
static TLcdDataProperty |
LOCATOR_PROPERTY
Data property that maps to the
locator attribute. |
Constructor and Description |
---|
TLcdOWSException() |
Modifier and Type | Method and Description |
---|---|
void |
addExceptionText(String aExceptionText)
Adds a exception text.
|
String |
getExceptionCode()
Returns the value of the property that maps to the
exceptionCode attribute. |
List<String> |
getExceptionText()
Returns the value of the property that maps to the
ExceptionText element. |
String |
getExceptionText(int aIndex)
Gets the exception text at a given position.
|
int |
getExceptionTextCount()
Gets the number of exception texts.
|
String |
getLocator()
Returns the value of the property that maps to the
locator attribute. |
void |
removeExceptionText(int aIndex)
Removes the exception text at a given position.
|
void |
setExceptionCode(String aValue)
Sets the value of the property that maps to the
exceptionCode attribute. |
void |
setLocator(String aValue)
Sets the value of the property that maps to the
locator attribute. |
String |
toString()
Returns a string representation of the object.
|
clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue
public static final TLcdDataProperty EXCEPTION_CODE_PROPERTY
exceptionCode
attribute.
The possible values for this property are instances of String
.public static final TLcdDataProperty LOCATOR_PROPERTY
locator
attribute.
The possible values for this property are instances of String
.public static final TLcdDataProperty EXCEPTION_TEXT_PROPERTY
ExceptionText
element.
The possible values for this property are instances of List<String>
.public void addExceptionText(String aExceptionText)
Ordered sequence of text strings that describe this specific exception or error.
aExceptionText
- the exception text to be added.public int getExceptionTextCount()
public void removeExceptionText(int aIndex)
aIndex
- the index of the given position.public String getExceptionText(int aIndex)
Ordered sequence of text strings that describe this specific exception or error.
aIndex
- the index of the given position.public String toString()
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.toString
in class TLcdDataObject
public String getExceptionCode()
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.
EXCEPTION_CODE_PROPERTY
property.public void setExceptionCode(String aValue)
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.
aValue
- the value to set for the EXCEPTION_CODE_PROPERTY
property.public String getLocator()
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.
LOCATOR_PROPERTY
property.public void setLocator(String aValue)
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.
aValue
- the value to set for the LOCATOR_PROPERTY
property.public List<String> getExceptionText()
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.
EXCEPTION_TEXT_PROPERTY
property.