nl.b3p.xml.ows.v100

Class ExceptionReport

java.lang.Object

nl.b3p.xml.ows.v100.ExceptionReport

All Implemented Interfaces:

Serializable

public class ExceptionReport
extends Object
implements Serializable

Report message returned to the client that requested any OWS operation when the server detects an error while processing that operation request.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExceptionReport()

Method Summary

Modifier and Type	Method and Description
void	addException(Exception vException) Method addException
void	addException(int index, Exception vException) Method addException
void	clearException() Method clearException
Enumeration	enumerateException() Method enumerateException
Exception[]	getException() Method getException
Exception	getException(int index) Method getException
int	getExceptionCount() Method getExceptionCount
String	getLanguage() Returns the value of field 'language'.
String	getVersion() Returns the value of field 'version'.
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
boolean	removeException(Exception vException) Method removeException
void	setException(Exception[] exceptionArray) Method setException
void	setException(int index, Exception vException) Method setException
void	setLanguage(String language) Sets the value of field 'language'.
void	setVersion(String version) Sets the value of field 'version'.
static ExceptionReport	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

ExceptionReport

public ExceptionReport()

Method Detail

addException

public void addException(Exception vException)
                  throws IndexOutOfBoundsException

Method addException

Parameters:

vException -

Throws:

IndexOutOfBoundsException

addException

public void addException(int index,
                         Exception vException)
                  throws IndexOutOfBoundsException

Method addException

Parameters:

index -

vException -

Throws:

IndexOutOfBoundsException

clearException

public void clearException()

Method clearException

enumerateException

public Enumeration enumerateException()

Method enumerateException

Returns:

Enumeration

getException

public Exception getException(int index)
                       throws IndexOutOfBoundsException

Method getException

Parameters:

index -

Returns:

Exception

Throws:

IndexOutOfBoundsException

getException

public Exception[] getException()

Method getException

Returns:

Exception

getExceptionCount

public int getExceptionCount()

Method getExceptionCount

Returns:

int

getLanguage

public String getLanguage()

Returns the value of field 'language'. The field 'language' has the following description: Identifier of the language used by all included exception text values. These language identifiers shall be as specified in IETF RFC 1766. When this attribute is omitted, the language used is not identified.

Returns:

String

getVersion

public String getVersion()

Returns the value of field 'version'. The field 'version' has the following description: Specification version for OWS operation. The string value shall contain one x.y.z "version" value (e.g., "2.1.3"). A version number shall contain three non-negative integers separated by decimal points, in the form "x.y.z". The integers y and z shall not exceed 99. Each version shall be for the Implementation Specification (document) and the associated XML Schemas to which requested operations will conform. An Implementation Specification version normally specifies XML Schemas against which an XML encoded operation response must conform and should be validated. See Version negotiation subclause for more information.

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

removeException

public boolean removeException(Exception vException)

Method removeException

Parameters:

vException -

Returns:

boolean

setException

public void setException(int index,
                         Exception vException)
                  throws IndexOutOfBoundsException

Method setException

Parameters:

index -

vException -

Throws:

IndexOutOfBoundsException

setException

public void setException(Exception[] exceptionArray)

Method setException

Parameters:

exceptionArray -

setLanguage

public void setLanguage(String language)

Sets the value of field 'language'. The field 'language' has the following description: Identifier of the language used by all included exception text values. These language identifiers shall be as specified in IETF RFC 1766. When this attribute is omitted, the language used is not identified.

Parameters:

language - the value of field 'language'.

setVersion

public void setVersion(String version)

Sets the value of field 'version'. The field 'version' has the following description: Specification version for OWS operation. The string value shall contain one x.y.z "version" value (e.g., "2.1.3"). A version number shall contain three non-negative integers separated by decimal points, in the form "x.y.z". The integers y and z shall not exceed 99. Each version shall be for the Implementation Specification (document) and the associated XML Schemas to which requested operations will conform. An Implementation Specification version normally specifies XML Schemas against which an XML encoded operation response must conform and should be validated. See Version negotiation subclause for more information.

Parameters:

version - the value of field 'version'.

unmarshal

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

Method unmarshal

Parameters:

reader -

Returns:

ExceptionReport

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