InstanceMessage (Oracle® Fusion Middleware B2B Instance Message Java API Reference)

java.lang.Object
- oracle.tip.b2b.message.InstanceMessage

All Implemented Interfaces:

java.io.Serializable
```
public class InstanceMessage
extends java.lang.Object
implements java.io.Serializable
```
This class gives an instance of the b2b message.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

InstanceMessage(oracle.tip.b2b.model.instance.Instancemessage model)

Constructors
Constructor and Description
`InstanceMessage(oracle.tip.b2b.model.instance.Instancemessage model)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAcknowledgeMode()` Returns the acknowledgment mode associated with the message
`java.lang.String`	`getAgreement()` Returns the agreement id associated with the message
`byte[]`	`getAppPayload()`
`java.lang.String`	`getB2bMessageId()` Returns the b2b message id associated with the message
`java.util.Date`	`getB2BTimeStamp()`
`java.lang.String`	`getB2BWireMessageId()`
`java.lang.String`	`getBusinessAction()` Returns the business action associated with the message
`java.lang.String`	`getConversationId()` Returns the conversation id associated with the message
`InstanceMessage[]`	`getCorrelatedMessages()` Returns the correlated messages
`java.lang.String`	`getCorrelationId()`
`java.lang.String`	`getDirection()` Returns the direction associated with the message
`java.lang.String`	`getDocumentProtocol()` Returns the document protocol associated with the message
`java.lang.String`	`getDocumentType()`
`java.lang.String`	`getErrorCode()` Returns the error code if this message was resulted in error
`java.lang.String`	`getErrorDescription()` Returns the error description if this message was resulted in error
`java.lang.String`	`getErrorText()` Returns the error text if this message was resulted in error
`java.lang.String`	`getExchangeProtocol()` Returns the exchange protocol associated with the message
`java.lang.String`	`getGroupControlNumber()`
`java.lang.String`	`getInterchangeControlNumber()`
`java.util.Date`	`getMessageDateTime()` Returns the timestamp associated with the message
`java.lang.String`	`getMessageType()` Returns the message type associated with the message
`java.lang.String`	`getPayload()` Returns the b2b business message payload
`java.lang.String`	`getProtocolMessageId()` Returns the protocol message id associated with the message
`java.lang.String`	`getProtocolWorkArea()`
`java.lang.String`	`getReceiverId()` Returns the receiver identification associated with the message
`java.lang.String`	`getReceiverName()` Returns the receiver name associated with the message
`java.math.BigDecimal`	`getRemainingRetry()` Returns the remaining retries associated with the message
`java.lang.String`	`getReplyMode()` Returns the reply mode associated with the message
`java.lang.String`	`getSenderId()` Returns the sender identification associated with the message
`java.lang.String`	`getSenderName()` Returns the sender name associated with the message
`java.lang.String`	`getState()` Returns the message state associated with the message
`java.lang.String`	`getTimeToAck()` Returns the time to acknowledge associated with the message
`java.lang.String`	`getTPAName()`
`java.lang.String`	`getTransactionControlNumber()`
`java.lang.String`	`getTransportheaders()` to get the transport Headers
`java.lang.String`	`getTransportProtocol()` Returns the transport protocol associated with the message
`java.lang.String`	`getURL()`
`byte[]`	`getWirePayload()` Returns the b2b wire message payload
`java.lang.String`	`getXpathExpression1()`
`java.lang.String`	`getXpathExpression2()`
`java.lang.String`	`getXpathExpression3()`
`java.lang.String`	`getXpathName1()`
`java.lang.String`	`getXpathName2()`
`java.lang.String`	`getXpathName3()`
`java.lang.String`	`getXpathValue1()`
`java.lang.String`	`getXpathValue2()`
`java.lang.String`	`getXpathValue3()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - InstanceMessage
```
public InstanceMessage(oracle.tip.b2b.model.instance.Instancemessage model)
                throws oracle.tip.b2b.system.B2BDomainException
```
    Throws:
    
    oracle.tip.b2b.system.B2BDomainException
- Method Detail
  - getAgreement
```
public java.lang.String getAgreement()
```
    Returns the agreement id associated with the message
    
    Returns:
    
    String the agreement id
  - getDocumentProtocol
```
public java.lang.String getDocumentProtocol()
```
    Returns the document protocol associated with the message
    
    Returns:
    
    String document protocol name and revision. Example: X12 4010
  - getExchangeProtocol
```
public java.lang.String getExchangeProtocol()
```
    Returns the exchange protocol associated with the message
    
    Returns:
    
    String exchange protocol name and revision. Example: AS2 1.0
  - getTransportProtocol
```
public java.lang.String getTransportProtocol()
```
    Returns the transport protocol associated with the message
    
    Returns:
    
    String transport protocol name and revision. Example: HTTP 1.1
  - getReceiverId
```
public java.lang.String getReceiverId()
```
    Returns the receiver identification associated with the message
    
    Returns:
    
    String receiver identification type and value. Example: DUNS 987654321
  - getSenderId
```
public java.lang.String getSenderId()
```
    Returns the sender identification associated with the message
    
    Returns:
    
    String sender identification type and value. Example: DUNS 123456789
  - getSenderName
```
public java.lang.String getSenderName()
```
    Returns the sender name associated with the message
    
    Returns:
    
    String sender name. Example: Acme
  - getReceiverName
```
public java.lang.String getReceiverName()
```
    Returns the receiver name associated with the message
    
    Returns:
    
    String receiver name. Example: GlobalChips
  - getB2bMessageId
```
public java.lang.String getB2bMessageId()
```
    Returns the b2b message id associated with the message
    
    Returns:
    
    String b2b message id
  - getAcknowledgeMode
```
public java.lang.String getAcknowledgeMode()
```
    Returns the acknowledgment mode associated with the message
    
    Returns:
    
    String acknowledgment mode
  - getReplyMode
```
public java.lang.String getReplyMode()
```
    Returns the reply mode associated with the message
    
    Returns:
    
    String reply mode
  - getMessageDateTime
```
public java.util.Date getMessageDateTime()
```
    Returns the timestamp associated with the message
    
    Returns:
    
    String message timestamp
  - getMessageType
```
public java.lang.String getMessageType()
```
    Returns the message type associated with the message
    
    Returns:
    
    String message type. Example Request/Response
  - getState
```
public java.lang.String getState()
```
    Returns the message state associated with the message
    
    Returns:
    
    String message state
  - getRemainingRetry
```
public java.math.BigDecimal getRemainingRetry()
```
    Returns the remaining retries associated with the message
    
    Returns:
    
    BigDecimal remaining retries
  - getDirection
```
public java.lang.String getDirection()
```
    Returns the direction associated with the message
    
    Returns:
    
    String direction. Example: Inbound/Outbound
  - getTimeToAck
```
public java.lang.String getTimeToAck()
```
    Returns the time to acknowledge associated with the message
    
    Returns:
    
    BigDecimal time to acknowledge in minutes
  - getErrorCode
```
public java.lang.String getErrorCode()
```
    Returns the error code if this message was resulted in error
    
    Returns:
    
    String error code. Example: AIP-11111
  - getErrorText
```
public java.lang.String getErrorText()
```
    Returns the error text if this message was resulted in error
    
    Returns:
    
    String error text
  - getErrorDescription
```
public java.lang.String getErrorDescription()
```
    Returns the error description if this message was resulted in error
    
    Returns:
    
    String error description
  - getPayload
```
public java.lang.String getPayload()
```
    Returns the b2b business message payload
    
    Returns:
    
    byte[] payload of the b2b business message
  - getWirePayload
```
public byte[] getWirePayload()
```
    Returns the b2b wire message payload
    
    Returns:
    
    ByteArrayInputStream payload of the b2b wire message
  - getProtocolMessageId
```
public java.lang.String getProtocolMessageId()
```
    Returns the protocol message id associated with the message
    
    Returns:
    
    String protocol message id
  - getConversationId
```
public java.lang.String getConversationId()
```
    Returns the conversation id associated with the message
    
    Returns:
    
    String conversation id
  - getBusinessAction
```
public java.lang.String getBusinessAction()
```
    Returns the business action associated with the message
    
    Returns:
    
    String business action and revision. Example: Process_850 1.0
  - getCorrelatedMessages
```
public InstanceMessage[] getCorrelatedMessages()
```
    Returns the correlated messages
    
    Returns:
    
    B2BInstanceMessage[] the instance message array which are correlated.
  - getTPAName
```
public java.lang.String getTPAName()
```
  - getXpathExpression1
```
public java.lang.String getXpathExpression1()
```
  - getXpathExpression2
```
public java.lang.String getXpathExpression2()
```
  - getXpathExpression3
```
public java.lang.String getXpathExpression3()
```
  - getDocumentType
```
public java.lang.String getDocumentType()
```
  - getCorrelationId
```
public java.lang.String getCorrelationId()
```
  - getTransactionControlNumber
```
public java.lang.String getTransactionControlNumber()
```
  - getGroupControlNumber
```
public java.lang.String getGroupControlNumber()
```
  - getInterchangeControlNumber
```
public java.lang.String getInterchangeControlNumber()
```
  - getProtocolWorkArea
```
public java.lang.String getProtocolWorkArea()
```
  - getB2BWireMessageId
```
public java.lang.String getB2BWireMessageId()
```
  - getB2BTimeStamp
```
public java.util.Date getB2BTimeStamp()
```
  - getURL
```
public java.lang.String getURL()
```
  - getXpathName1
```
public java.lang.String getXpathName1()
```
  - getXpathName2
```
public java.lang.String getXpathName2()
```
  - getXpathName3
```
public java.lang.String getXpathName3()
```
  - getXpathValue1
```
public java.lang.String getXpathValue1()
```
  - getXpathValue2
```
public java.lang.String getXpathValue2()
```
  - getXpathValue3
```
public java.lang.String getXpathValue3()
```
  - getAppPayload
```
public byte[] getAppPayload()
```
  - getTransportheaders
```
public java.lang.String getTransportheaders()
```
    to get the transport Headers
    
    Returns:
    
    list of transport headers

Class InstanceMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstanceMessage

Method Detail

getAgreement

getDocumentProtocol

getExchangeProtocol

getTransportProtocol

getReceiverId

getSenderId

getSenderName

getReceiverName

getB2bMessageId

getAcknowledgeMode

getReplyMode

getMessageDateTime

getMessageType

getState

getRemainingRetry

getDirection

getTimeToAck

getErrorCode

getErrorText

getErrorDescription

getPayload

getWirePayload

getProtocolMessageId

getConversationId

getBusinessAction

getCorrelatedMessages

getTPAName

getXpathExpression1

getXpathExpression2

getXpathExpression3

getDocumentType

getCorrelationId

getTransactionControlNumber

getGroupControlNumber

getInterchangeControlNumber

getProtocolWorkArea

getB2BWireMessageId

getB2BTimeStamp

getURL

getXpathName1

getXpathName2

getXpathName3

getXpathValue1

getXpathValue2

getXpathValue3

getAppPayload

getTransportheaders