ca.infoway.messagebuilder.transport
Interface RequestMessage

All Known Implementing Classes:

SimpleRequestMessage

public interface RequestMessage

A message that can be sent across a transport layer.

Author:

Intelliware Development sharpen.ignore - transport - TBD!

Method Summary

String	getInteractionId() Obtains the message's interaction id.
Document	getMessageAsDocument() Obtains the message as a DOM, converting the underlying structure if necessary (i.e.
String	getMessageAsString() Obtains the message as a string, converting the underlying structure if necessary (i.e.

Method Detail

getMessageAsString

String getMessageAsString()
                          throws TransportLayerException

Obtains the message as a string, converting the underlying structure if necessary (i.e. DOM -> string).

Returns:

the underlying message rendered as a string

Throws:

TransportLayerException - if a string representation of the message could not be constructed

getInteractionId

String getInteractionId()
                        throws TransportLayerException

Obtains the message's interaction id.

Returns:

the message's interaction id

Throws:

TransportLayerException - if the message's interaction id could not be determined

getMessageAsDocument

Document getMessageAsDocument()
                              throws TransportLayerException

Obtains the message as a DOM, converting the underlying structure if necessary (i.e. string -> DOM).

Returns:

the underlying message in a DOM structure

Throws:

TransportLayerException - if there were problems creating the DOM