nl.b3p.xml.ows.v100

Class ExceptionType

java.lang.Object

nl.b3p.xml.ows.v100.ExceptionType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Exception

public class ExceptionType
extends Object
implements Serializable

An Exception element describes one detected error that a server chooses to convey to the client.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExceptionType()

Method Summary

Modifier and Type	Method and Description
void	addExceptionText(int index, String vExceptionText) Method addExceptionText
void	addExceptionText(String vExceptionText) Method addExceptionText
void	clearExceptionText() Method clearExceptionText
Enumeration	enumerateExceptionText() Method enumerateExceptionText
String	getExceptionCode() Returns the value of field 'exceptionCode'.
String[]	getExceptionText() Method getExceptionText
String	getExceptionText(int index) Method getExceptionText
int	getExceptionTextCount() Method getExceptionTextCount
String	getLocator() Returns the value of field 'locator'.
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
boolean	removeExceptionText(String vExceptionText) Method removeExceptionText
void	setExceptionCode(String exceptionCode) Sets the value of field 'exceptionCode'.
void	setExceptionText(int index, String vExceptionText) Method setExceptionText
void	setExceptionText(String[] exceptionTextArray) Method setExceptionText
void	setLocator(String locator) Sets the value of field 'locator'.
static ExceptionType	unmarshal(Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExceptionType

public ExceptionType()

Method Detail

addExceptionText

public void addExceptionText(String vExceptionText)
                      throws IndexOutOfBoundsException

Method addExceptionText

Parameters:

vExceptionText -

Throws:

IndexOutOfBoundsException

addExceptionText

public void addExceptionText(int index,
                             String vExceptionText)
                      throws IndexOutOfBoundsException

Method addExceptionText

Parameters:

index -

vExceptionText -

Throws:

IndexOutOfBoundsException

clearExceptionText

public void clearExceptionText()

Method clearExceptionText

enumerateExceptionText

public Enumeration enumerateExceptionText()

Method enumerateExceptionText

Returns:

Enumeration

getExceptionCode

public String getExceptionCode()

Returns the value of field 'exceptionCode'. The field 'exceptionCode' has the following description: 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:

String

getExceptionText

public String getExceptionText(int index)
                        throws IndexOutOfBoundsException

Method getExceptionText

Parameters:

index -

Returns:

String

Throws:

IndexOutOfBoundsException

getExceptionText

public String[] getExceptionText()

Method getExceptionText

Returns:

String

getExceptionTextCount

public int getExceptionTextCount()

Method getExceptionTextCount

Returns:

int

getLocator

public String getLocator()

Returns the value of field 'locator'. The field 'locator' has the following description: 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:

String

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

removeExceptionText

public boolean removeExceptionText(String vExceptionText)

Method removeExceptionText

Parameters:

vExceptionText -

Returns:

boolean

setExceptionCode

public void setExceptionCode(String exceptionCode)

Sets the value of field 'exceptionCode'. The field 'exceptionCode' has the following description: 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:

exceptionCode - the value of field 'exceptionCode'.

setExceptionText

public void setExceptionText(int index,
                             String vExceptionText)
                      throws IndexOutOfBoundsException

Method setExceptionText

Parameters:

index -

vExceptionText -

Throws:

IndexOutOfBoundsException

setExceptionText

public void setExceptionText(String[] exceptionTextArray)

Method setExceptionText

Parameters:

exceptionTextArray -

setLocator

public void setLocator(String locator)

Sets the value of field 'locator'. The field 'locator' has the following description: 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:

locator - the value of field 'locator'.

unmarshal

public static ExceptionType unmarshal(Reader reader)
                               throws org.exolab.castor.xml.MarshalException,
                                      org.exolab.castor.xml.ValidationException

Method unmarshal

Parameters:

reader -

Returns:

ExceptionType

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate

Throws:

org.exolab.castor.xml.ValidationException