com.ibm.etools.sfm.sfpi
Interface SFChannelOutput

All Superinterfaces:
SFOutput

public interface SFChannelOutput
extends SFOutput

SFChannelOutput represents the output to a channel operation.


Method Summary
 SFMessage getMessage()
          Returns the message associated with this SFChannelOutput object.
 java.util.List<SFMessage> getMessages()
          Returns the list of messages associated with this SFChannelOutput object.
 void setMessage(SFMessage message)
          Sets the message associated with this SFChannelOutput object.
 void setMessages(java.util.List<SFMessage> messages)
          Sets the list of messages associated with this SFChannelOutput object.
 

Method Detail

getMessage

SFMessage getMessage()
Returns the message associated with this SFChannelOutput object. If this object contains more than one message, the first message is returned.

Specified by:
getMessage in interface SFOutput
Returns:
A message.

setMessage

void setMessage(SFMessage message)
                throws SFException
Sets the message associated with this SFChannelOutput object. If this object already contains one or more messages, this method replaces the existing messages.

Specified by:
setMessage in interface SFOutput
Parameters:
message - A message.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The message is null. ERROR: The message was not set successfully.

getMessages

java.util.List<SFMessage> getMessages()
Returns the list of messages associated with this SFChannelOutput object.

Returns:
A list of messages.

setMessages

void setMessages(java.util.List<SFMessage> messages)
                 throws SFException
Sets the list of messages associated with this SFChannelOutput object. If this object already contains one or more messages, this method replaces the existing messages.

Parameters:
messages - A list of messages.
Throws:
SFException - One of the following exceptions may result:
Error Description Severity
WZEF1001E_ARGSERROR Illegal arguments. The messages is null. ERROR: The messages was not set successfully.