com.ibm.websphere.sibx.smobo
Interface ServiceMessageObject


public interface ServiceMessageObject

Provides the interface for the Service Message Object.

The following features are supported:

See Also:
ServiceMessageObjectPackage.getServiceMessageObject()

Field Summary
static java.lang.String $sccsid
           
static java.lang.String COPYRIGHT
           
static java.lang.String SMO_EXCEPTION_TYPE
          This is the value set into the MessageType field of the SMOHeader when the SMO represents an exception message.
static java.lang.String SMO_REQUEST_TYPE
          This is the value set into the MessageType field of the SMOHeader when the SMO represents a request message.
static java.lang.String SMO_RESPONSE_TYPE
          This is the value set into the MessageType field of the SMOHeader when the SMO represents a response message.
static java.lang.String UNMODELLED_FAULT_ORIGIN
          This is the value set into the failInfo.origin field for an unmodelled fault
 
Method Summary
 java.lang.Object getBody()
          Returns the value of the 'Body' containment reference.
 java.lang.Object getBodyForSCAMessage(boolean copySMOBody)
           
 boolean getBodyPopulated()
           
 ContextType getContext()
          Returns the value of the 'Context' containment reference.
 HeadersType getHeaders()
          Returns the value of the 'Headers' containment reference.
 boolean getSoapFaultInfoPopulated()
           
 void saveSCAData(com.ibm.wsspi.sca.message.Message donorSCAMessage, ServiceMessageObject requestSMO)
           
 void setBody(java.lang.Object value)
          Sets the value of the 'Body' containment reference.
 void setBodyPopulated()
           
 void setContext(ContextType value)
          Sets the value of the 'Context' containment reference.
 void setHeaders(HeadersType value)
          Sets the value of the 'Headers' containment reference.
 void setSoapFaultInfoPopulated()
           
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

$sccsid

public static final java.lang.String $sccsid
See Also:
Constant Field Values

SMO_REQUEST_TYPE

public static final java.lang.String SMO_REQUEST_TYPE
This is the value set into the MessageType field of the SMOHeader when the SMO represents a request message.

See Also:
Constant Field Values

SMO_RESPONSE_TYPE

public static final java.lang.String SMO_RESPONSE_TYPE
This is the value set into the MessageType field of the SMOHeader when the SMO represents a response message.

See Also:
Constant Field Values

SMO_EXCEPTION_TYPE

public static final java.lang.String SMO_EXCEPTION_TYPE
This is the value set into the MessageType field of the SMOHeader when the SMO represents an exception message.

See Also:
Constant Field Values

UNMODELLED_FAULT_ORIGIN

public static final java.lang.String UNMODELLED_FAULT_ORIGIN
This is the value set into the failInfo.origin field for an unmodelled fault

See Also:
Constant Field Values
Method Detail

getContext

public ContextType getContext()
Returns the value of the 'Context' containment reference.

This context folder contains both the transient and correlation contexts.

Returns:
the value of the 'Context' containment reference.
See Also:
setContext(ContextType), ServiceMessageObjectPackage.getServiceMessageObject_Context()

setContext

public void setContext(ContextType value)
Sets the value of the 'Context' containment reference.

Parameters:
value - the new value of the 'Context' containment reference.
See Also:
getContext()

getHeaders

public HeadersType getHeaders()
Returns the value of the 'Headers' containment reference.

This headers folder contains all of the other headers, fault information and message properties.

Returns:
the value of the 'Headers' containment reference.
See Also:
setHeaders(HeadersType), ServiceMessageObjectPackage.getServiceMessageObject_Headers()

setHeaders

public void setHeaders(HeadersType value)
Sets the value of the 'Headers' containment reference.

Parameters:
value - the new value of the 'Headers' containment reference.
See Also:
getHeaders()

getBody

public java.lang.Object getBody()
Returns the value of the 'Body' containment reference.

This body is the payload of the message and might typically contain application data.

Returns:
the value of the 'Body' containment reference.
See Also:
setBody(Object), ServiceMessageObjectPackage.getServiceMessageObject_Body()

setBody

public void setBody(java.lang.Object value)
Sets the value of the 'Body' containment reference.

Parameters:
value - the new value of the 'Body' containment reference.
See Also:
getBody()

getBodyForSCAMessage

public java.lang.Object getBodyForSCAMessage(boolean copySMOBody)

getBodyPopulated

public boolean getBodyPopulated()

setBodyPopulated

public void setBodyPopulated()

getSoapFaultInfoPopulated

public boolean getSoapFaultInfoPopulated()

setSoapFaultInfoPopulated

public void setSoapFaultInfoPopulated()

saveSCAData

public void saveSCAData(com.ibm.wsspi.sca.message.Message donorSCAMessage,
                        ServiceMessageObject requestSMO)