com.ibm.websphere.sibx.smobo
Interface HeadersType

All Known Implementing Classes:
HeadersTypeImpl

public interface HeadersType

A representation of the model object 'Headers Type'.

The Headers Type should be considered as a folder that contains all other headers, SOAP Fault information and message properties.

The following features are supported:

See Also:
ServiceMessageObjectPackage.getHeadersType()

Field Summary
static java.lang.String $sccsid
           
static java.lang.String COPYRIGHT
           
 
Method Summary
 JMSHeaderType getJMSHeader()
          Returns the value of the 'JMS Header' containment reference.
 java.util.List getProperties()
          Returns the value of the 'Properties' containment reference list.
 SMOHeaderType getSMOHeader()
          Returns the value of the 'SMO Header' containment reference.
 SOAPFaultInfoType getSOAPFaultInfo()
          Returns the value of the 'SOAP Fault Info' containment reference.
 java.util.List getSOAPHeader()
          Returns the value of the 'SOAP Header' containment reference list.
 void setJMSHeader(JMSHeaderType value)
          Sets the value of the 'JMS Header' containment reference.
 void setSMOHeader(SMOHeaderType value)
          Sets the value of the 'SMO Header' containment reference.
 void setSOAPFaultInfo(SOAPFaultInfoType value)
          Sets the value of the 'SOAP Fault Info' containment reference.
 

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
Method Detail

getSMOHeader

public SMOHeaderType getSMOHeader()
Returns the value of the 'SMO Header' containment reference.

Returns the value of the ServiceMessageObject header.

Returns:
the value of the 'SMO Header' containment reference.
See Also:
setSMOHeader(SMOHeaderType), ServiceMessageObjectPackage.getHeadersType_SMOHeader()

setSMOHeader

public void setSMOHeader(SMOHeaderType value)
Sets the value of the 'SMO Header' containment reference.

Parameters:
value - the new value of the 'SMO Header' containment reference.
See Also:
getSMOHeader()

getJMSHeader

public JMSHeaderType getJMSHeader()
Returns the value of the 'JMS Header' containment reference.

This JMS Header contains all of Header Fields defined in the JMS specification. This header is typically only present when the message has flowed over either JMS (or possibly SOAP over JMS). Any JMS properties will be presented in the properties folder.

Returns:
the value of the 'JMS Header' containment reference.
See Also:
setJMSHeader(JMSHeaderType), ServiceMessageObjectPackage.getHeadersType_JMSHeader()

setJMSHeader

public void setJMSHeader(JMSHeaderType value)
Sets the value of the 'JMS Header' containment reference.

Parameters:
value - the new value of the 'JMS Header' containment reference.
See Also:
getJMSHeader()

getSOAPHeader

public java.util.List getSOAPHeader()
Returns the value of the 'SOAP Header' containment reference list. The list contents are of type SOAPHeaderType.

This a list of all of the SOAP Headers found in the inbound message.

Returns:
the value of the 'SOAP Header' containment reference list.
See Also:
ServiceMessageObjectPackage.getHeadersType_SOAPHeader()

getSOAPFaultInfo

public SOAPFaultInfoType getSOAPFaultInfo()
Returns the value of the 'SOAP Fault Info' containment reference.

Returns:
the value of the 'SOAP Fault Info' containment reference.
See Also:
setSOAPFaultInfo(SOAPFaultInfoType), ServiceMessageObjectPackage.getHeadersType_SOAPFaultInfo()

setSOAPFaultInfo

public void setSOAPFaultInfo(SOAPFaultInfoType value)
Sets the value of the 'SOAP Fault Info' containment reference.

Parameters:
value - the new value of the 'SOAP Fault Info' containment reference.
See Also:
getSOAPFaultInfo()

getProperties

public java.util.List getProperties()
Returns the value of the 'Properties' containment reference list. The list contents are of type PropertyType.

This is a list of the properties associated with the message and each list entry consists of a name/value pair.

Returns:
the value of the 'Properties' containment reference list.
See Also:
ServiceMessageObjectPackage.getHeadersType_Properties()