com.messagegears.sdk.v3_1

Class BulkJobErrors

java.lang.Object

com.messagegears.sdk.v3_1.BulkJobErrors

All Implemented Interfaces:

java.io.Serializable

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

Class BulkJobErrors.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BulkJobErrors()

Method Summary

Methods

Modifier and Type	Method and Description
void	addBulkJobError(BulkJobError vBulkJobError)
void	addBulkJobError(int index, BulkJobError vBulkJobError)
java.util.Enumeration<? extends BulkJobError>	enumerateBulkJobError() Method enumerateBulkJobError.
BulkJobError[]	getBulkJobError() Method getBulkJobError.Returns the contents of the collection in an Array.
BulkJobError	getBulkJobError(int index) Method getBulkJobError.
int	getBulkJobErrorCount() Method getBulkJobErrorCount.
boolean	isValid() Method isValid.
java.util.Iterator<? extends BulkJobError>	iterateBulkJobError() Method iterateBulkJobError.
void	marshal(org.xml.sax.ContentHandler handler)
void	marshal(java.io.Writer out)
void	removeAllBulkJobError()
boolean	removeBulkJobError(BulkJobError vBulkJobError) Method removeBulkJobError.
BulkJobError	removeBulkJobErrorAt(int index) Method removeBulkJobErrorAt.
void	setBulkJobError(BulkJobError[] vBulkJobErrorArray)
void	setBulkJobError(int index, BulkJobError vBulkJobError)
static BulkJobErrors	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

BulkJobErrors

public BulkJobErrors()

Method Detail

addBulkJobError

public void addBulkJobError(BulkJobError vBulkJobError)
                     throws java.lang.IndexOutOfBoundsException

Parameters:

vBulkJobError -

Throws:

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

addBulkJobError

public void addBulkJobError(int index,
                   BulkJobError vBulkJobError)
                     throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vBulkJobError -

Throws:

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

enumerateBulkJobError

public java.util.Enumeration<? extends BulkJobError> enumerateBulkJobError()

Method enumerateBulkJobError.

Returns:

an Enumeration over all possible elements of this collection

getBulkJobError

public BulkJobError getBulkJobError(int index)
                             throws java.lang.IndexOutOfBoundsException

Method getBulkJobError.

Parameters:

index -

Returns:

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

Throws:

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

getBulkJobError

public BulkJobError[] getBulkJobError()

Method getBulkJobError.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

getBulkJobErrorCount

public int getBulkJobErrorCount()

Method getBulkJobErrorCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateBulkJobError

public java.util.Iterator<? extends BulkJobError> iterateBulkJobError()

Method iterateBulkJobError.

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

removeAllBulkJobError

public void removeAllBulkJobError()

removeBulkJobError

public boolean removeBulkJobError(BulkJobError vBulkJobError)

Method removeBulkJobError.

Parameters:

vBulkJobError -

Returns:

true if the object was removed from the collection.

removeBulkJobErrorAt

public BulkJobError removeBulkJobErrorAt(int index)

Method removeBulkJobErrorAt.

Parameters:

index -

Returns:

the element removed from the collection

setBulkJobError

public void setBulkJobError(int index,
                   BulkJobError vBulkJobError)
                     throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vBulkJobError -

Throws:

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

setBulkJobError

public void setBulkJobError(BulkJobError[] vBulkJobErrorArray)

Parameters:

vBulkJobErrorArray -

unmarshal

public static BulkJobErrors 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.BulkJobErrors

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