com.messagegears.sdk.v3_1

Class RequestErrors

java.lang.Object

com.messagegears.sdk.v3_1.RequestErrors

All Implemented Interfaces:

java.io.Serializable

public class RequestErrors
extends java.lang.Object
implements java.io.Serializable

Class RequestErrors.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RequestErrors()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRequestError(int index, RequestError vRequestError)
void	addRequestError(RequestError vRequestError)
java.util.Enumeration<? extends RequestError>	enumerateRequestError() Method enumerateRequestError.
RequestError[]	getRequestError() Method getRequestError.Returns the contents of the collection in an Array.
RequestError	getRequestError(int index) Method getRequestError.
int	getRequestErrorCount() Method getRequestErrorCount.
boolean	isValid() Method isValid.
java.util.Iterator<? extends RequestError>	iterateRequestError() Method iterateRequestError.
void	marshal(org.xml.sax.ContentHandler handler)
void	marshal(java.io.Writer out)
void	removeAllRequestError()
boolean	removeRequestError(RequestError vRequestError) Method removeRequestError.
RequestError	removeRequestErrorAt(int index) Method removeRequestErrorAt.
void	setRequestError(int index, RequestError vRequestError)
void	setRequestError(RequestError[] vRequestErrorArray)
static RequestErrors	unmarshal(java.io.Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestErrors

public RequestErrors()

Method Detail

addRequestError

public void addRequestError(RequestError vRequestError)
                     throws java.lang.IndexOutOfBoundsException

Parameters:

vRequestError -

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addRequestError

public void addRequestError(int index,
                   RequestError vRequestError)
                     throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vRequestError -

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateRequestError

public java.util.Enumeration<? extends RequestError> enumerateRequestError()

Method enumerateRequestError.

Returns:

an Enumeration over all possible elements of this collection

getRequestError

public RequestError getRequestError(int index)
                             throws java.lang.IndexOutOfBoundsException

Method getRequestError.

Parameters:

index -

Returns:

the value of the com.messagegears.sdk.v3_1.RequestError at the given index

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getRequestError

public RequestError[] getRequestError()

Method getRequestError.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getRequestErrorCount

public int getRequestErrorCount()

Method getRequestErrorCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateRequestError

public java.util.Iterator<? extends RequestError> iterateRequestError()

Method iterateRequestError.

Returns:

an Iterator over all possible elements in this collection

marshal

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

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

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

Parameters:

handler -

Throws:

java.io.IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllRequestError

public void removeAllRequestError()

removeRequestError

public boolean removeRequestError(RequestError vRequestError)

Method removeRequestError.

Parameters:

vRequestError -

Returns:

true if the object was removed from the collection.

removeRequestErrorAt

public RequestError removeRequestErrorAt(int index)

Method removeRequestErrorAt.

Parameters:

index -

Returns:

the element removed from the collection

setRequestError

public void setRequestError(int index,
                   RequestError vRequestError)
                     throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vRequestError -

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setRequestError

public void setRequestError(RequestError[] vRequestErrorArray)

Parameters:

vRequestErrorArray -

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled com.messagegears.sdk.v3_1.RequestErrors

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

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

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema