com.infoengine.object
Class IeRequest

java.lang.Object
  com.infoengine.object.IeObject
      com.infoengine.object.IeRequest

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

public class IeRequest
extends IeObject
implements java.lang.Cloneable

See Also:

Serialized Form

Constructor Summary

IeRequest()
Constructs a new IeRequest

IeRequest(java.lang.String name)
Constructs a new IeRequest and sets the request name to the given String.

Method Summary

void	addCollection(IeCollection collection) Adds a collection to the request.
java.lang.Object	deepClone() Returns a deep copy of the request.
IeCollection	firstCollection() Returns the first collection contained in the request.
IeCollection	getCollection(java.lang.String name) Returns a collection by name.
IeCollection	getCollectionAt(int index) Returns the collection located at a specified index.
int	getCollectionCount() Returns the number of collections contained in the request.
java.util.Enumeration	getCollections() Returns all of the collections contained in the request.
java.lang.String	getNodeName() Returns the name of this DOM node.
IeCollection	lastCollection() Returns the last collection contained in the request.
void	removeAllCollections() Removes all of the collections contained in the request.
void	removeCollection(IeCollection collection) Removes a specified collection from the request.
void	removeCollection(java.lang.String name) Removes a collection by name.
void	setCollectionAt(IeCollection collection, int index) Sets the collection at a specified index.

Methods inherited from class com.infoengine.object.IeObject

addAtt, addMeta, addMeta, addMeta, addMeta, addMetaDatum, addMetaValue, addMetaValues, appendMetaDatum, canonicalize, canonicalize, clone, containsMetaValue, deepCopy, firstAtt, firstChild, firstMetaValue, getAtt, getAttAt, getAttByMeta, getAttCount, getAttribute, getAtts, getChildCount, getChildren, getHasChanged, getMeta, getMetaNames, getMetaValue, getMetaValueAt, getMetaValueCount, getMetaValues, getName, getTagName, getType, hasChildren, indexOfMetaValue, lastAtt, lastChild, lastMetaValue, readExternal, removeAllAtts, removeAllMeta, removeAllMetaValues, removeAtt, removeAtt, removeAttAt, removeAttribute, removeChild, removeMeta, removeMetaValue, removeMetaValueAt, removeName, removeType, replaceChild, setAttAt, setAttribute, setHasChanged, setMeta, setMeta, setMeta, setMeta, setMetaValue, setMetaValueAt, setName, setType, shallowCopy, writeExternal

Methods inherited from class java.lang.Object

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

Constructor Detail

IeRequest

public IeRequest()

Constructs a new IeRequest

IeRequest

public IeRequest(java.lang.String name)

Constructs a new IeRequest and sets the request name to the given String.

Parameters:

name - The name of the request object

Method Detail

addCollection

public void addCollection(IeCollection collection)

Adds a collection to the request.

Parameters:

collection - the collection to be added

firstCollection

public IeCollection firstCollection()

Returns the first collection contained in the request.

Returns:

The first collection, or null if the request does not contain any collections

getCollection

public IeCollection getCollection(java.lang.String name)

Returns a collection by name.

Parameters:

name - the name of the collection to be returned

Returns:

The named collection, or null if the request does not contain the collection

getCollections

public java.util.Enumeration getCollections()

Returns all of the collections contained in the request.

Returns:

The collections contained in the request

getCollectionAt

public IeCollection getCollectionAt(int index)

Returns the collection located at a specified index.

Parameters:

index - the index of the collection to be returned

Returns:

The collection located at the specified index, or null if the index exceeds the number of collections contained in the request

getCollectionCount

public int getCollectionCount()

Returns the number of collections contained in the request.

Returns:

The number of collections in the request

lastCollection

public IeCollection lastCollection()

Returns the last collection contained in the request.

Returns:

The last collection, or null if the request does not contain any collections

removeAllCollections

public void removeAllCollections()

Removes all of the collections contained in the request.

removeCollection

public void removeCollection(java.lang.String name)

Removes a collection by name.

Parameters:

name - the name of the collection to be removed

removeCollection

public void removeCollection(IeCollection collection)

Removes a specified collection from the request.

Parameters:

collection - the collection to be removed

setCollectionAt

public void setCollectionAt(IeCollection collection,
                            int index)

Sets the collection at a specified index.

Parameters:

collection - the new collection to be set

index - the index at which to set the new collection

getNodeName

public java.lang.String getNodeName()

Returns the name of this DOM node.

Overrides:

getNodeName in class IeObject

Returns:

The name of this DOM node.

deepClone

public final java.lang.Object deepClone()

Returns a deep copy of the request.

Overrides:

deepClone in class IeObject

Returns:

The deep copy