com.sonicsw.xq
Interface XQEnvelope

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable, XQCloneable

public interface XQEnvelope
extends XQCloneable, java.io.Serializable

An XQEnvelope combines an XQMessage along w/ a set of XQAddresses to which this message should be sent.

See Also:

XQEnvelopeFactory, XQMessage, XQAddress

Method Summary

void	addAddress(XQAddress address) Adds an address to the set of "To:" addresses.
void	addAddresses(java.util.List<XQAddress> addresses) Adds all of the addresses in a list of addresses to the set of "To:" addresses.
void	clearAddresses() Clears the set of "To:" addresses for this envelope.
java.util.Iterator<XQAddress>	getAddresses() Returns an Iterator containing the "To:" addresses of this envelope.
XQMessage	getMessage() Returns the message that this envelope contains.
void	removeAddress(XQAddress address) Removes a particular address from the set of "To:" addresses for this envelope.
void	setMessage(XQMessage message) Sets the message for this envelope.

Methods inherited from interface com.sonicsw.xq.XQCloneable

clone

Method Detail

setMessage

void setMessage(XQMessage message)

Sets the message for this envelope.

Parameters:

message - the XQMessage to set

getMessage

XQMessage getMessage()

Returns the message that this envelope contains.

Returns:

the XQMessage in the envelope

addAddress

void addAddress(XQAddress address)

Adds an address to the set of "To:" addresses. If the specified address is already in the set, or is null, this method has no effect.

Parameters:

address - an XQAddress to which this message should be sent

addAddresses

void addAddresses(java.util.List<XQAddress> addresses)

Adds all of the addresses in a list of addresses to the set of "To:" addresses.

Parameters:

addresses - a java.util.List of XQAddresses to which this message should be sent

getAddresses

java.util.Iterator<XQAddress> getAddresses()

Returns an Iterator containing the "To:" addresses of this envelope.

Returns:

a java.util.Iterator containing the XQAddresses to which this message should be sent

clearAddresses

void clearAddresses()

Clears the set of "To:" addresses for this envelope.

removeAddress

void removeAddress(XQAddress address)

Removes a particular address from the set of "To:" addresses for this envelope. If the specified XQAddress is not found in the "To:" set, this method has no effect.

Parameters:

address - the XQAddress to remove from the list of addresses to which this message should be sent