nl.b3p.xml.ogc.v100.exception

Class ServiceExceptionType

java.lang.Object

nl.b3p.xml.ogc.v100.exception.ServiceExceptionType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ServiceException

public class ServiceExceptionType
extends Object
implements Serializable

The ServiceExceptionType type defines the ServiceException element. The content of the element is an exception message that the service wished to convey to the client application.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ServiceExceptionType()

Method Summary

Modifier and Type	Method and Description
String	getCode() Returns the value of field 'code'.
String	getContent() Returns the value of field 'content'.
String	getLocator() Returns the value of field 'locator'.
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
void	setCode(String code) Sets the value of field 'code'.
void	setContent(String content) Sets the value of field 'content'.
void	setLocator(String locator) Sets the value of field 'locator'.
static ServiceExceptionType	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

ServiceExceptionType

public ServiceExceptionType()

Method Detail

getCode

public String getCode()

Returns the value of field 'code'. The field 'code' has the following description: A service may associate a code with an exception by using the code attribute.

Returns:

String

getContent

public String getContent()

Returns the value of field 'content'. The field 'content' has the following description: internal content storage

Returns:

String

getLocator

public String getLocator()

Returns the value of field 'locator'. The field 'locator' has the following description: The locator attribute may be used by a service to indicate to a client where in the client's request an exception was encountered. If the request included a 'handle' attribute, this may be used to identify the offending component of the request. Otherwise the service may try to use other means to locate the exception such as line numbers or byte offset from the begining of the request, etc ...

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

setCode

public void setCode(String code)

Sets the value of field 'code'. The field 'code' has the following description: A service may associate a code with an exception by using the code attribute.

Parameters:

code - the value of field 'code'.

setContent

public void setContent(String content)

Sets the value of field 'content'. The field 'content' has the following description: internal content storage

Parameters:

content - the value of field 'content'.

setLocator

public void setLocator(String locator)

Sets the value of field 'locator'. The field 'locator' has the following description: The locator attribute may be used by a service to indicate to a client where in the client's request an exception was encountered. If the request included a 'handle' attribute, this may be used to identify the offending component of the request. Otherwise the service may try to use other means to locate the exception such as line numbers or byte offset from the begining of the request, etc ...

Parameters:

locator - the value of field 'locator'.

unmarshal

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

Method unmarshal

Parameters:

reader -

Returns:

ServiceExceptionType

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