org.apache.ode.bpel.dao

## Interface MessageExchangeDAO

- All Known Implementing Classes:
    MessageExchangeDaoImpl, MessageExchangeDAOImpl, MessageExchangeDAOImpl

      public interface MessageExchangeDAO

  Data access object for a message exchange.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static char` | `DIR_BPEL_INVOKES_PARTNERROLE`
    `static char` | `DIR_PARTNER_INVOKES_MYROLE`

  - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `MessageDAO` | `createMessage(javax.xml.namespace.QName type)` Create a new message associated with this message-exchange
    `javax.xml.namespace.QName` | `getCallee()` Get the "callee"--the id of the process being invoked in a myRole exchange.
    `java.lang.String` | `getChannel()` Get the response channel.
    `java.lang.String` | `getCorrelationId()` Get the correlation identifier/client id
    `java.lang.String` | `getCorrelationStatus()`
    `java.util.Date` | `getCreateTime()` Creation time of the message exchange
    `char` | `getDirection()` Get the direction of the message exchange.
    `org.w3c.dom.Element` | `getEPR()`
    `javax.xml.namespace.QName` | `getFault()`
    `java.lang.String` | `getFaultExplanation()`
    `ProcessInstanceDAO` | `getInstance()`
    `java.lang.String` | `getMessageExchangeId()` Instance id of the message exchange.
    `java.lang.String` | `getOperation()` Get the operation name of this message exchange.
    `PartnerLinkDAO` | `getPartnerLink()`
    `int` | `getPartnerLinkModelId()` Get the model id for the partner link to which this message exchange relates.
    `java.lang.String` | `getPattern()`
    `java.lang.String` | `getPipedMessageExchangeId()` Gets the mex id for the message exchange that has been piped with this one in a process to process interaction.
    `javax.xml.namespace.QName` | `getPortType()` The qualified name of the WSDL port type.
    `ProcessDAO` | `getProcess()` Get the process associate with this message exchange.
    `boolean` | `getPropagateTransactionFlag()`
    `java.lang.String` | `getProperty(java.lang.String key)`
    `java.util.Set<java.lang.String>` | `getPropertyNames()`
    `MessageDAO` | `getRequest()` Get the input message.
    `MessageDAO` | `getResponse()` Get output message (could be fault message)
    `java.lang.String` | `getStatus()` Get state of last message sent/received.
    `int` | `getSubscriberCount()`
    `boolean` | `lockPremieMessages()`
    `void` | `release(boolean doClean)`
    `void` | `releasePremieMessages()` Deletes messages that arrived before the route is setup
    `void` | `setCallee(javax.xml.namespace.QName callee)` Set the "callee"--the id of the process being invoked in a myRole exchange.
    `void` | `setChannel(java.lang.String string)` Set the response channel.
    `void` | `setCorrelationId(java.lang.String correlationId)` Set the correlation identifier/client id
    `void` | `setCorrelationStatus(java.lang.String cstatus)`
    `void` | `setCreateTime(java.util.Date createTime)`
    `void` | `setEPR(org.w3c.dom.Element epr)`
    `void` | `setFault(javax.xml.namespace.QName faultType)`
    `void` | `setFaultExplanation(java.lang.String explanation)`
    `void` | `setInstance(ProcessInstanceDAO dao)`
    `void` | `setOperation(java.lang.String opname)`
    `void` | `setPartnerLink(PartnerLinkDAO plinkDAO)`
    `void` | `setPartnerLinkModelId(int modelId)` Set the model id for the partner link to which this message exchange relates
    `void` | `setPattern(java.lang.String string)`
    `void` | `setPipedMessageExchangeId(java.lang.String mexId)`
    `void` | `setPortType(javax.xml.namespace.QName porttype)` Set the port type.
    `void` | `setProcess(ProcessDAO process)`
    `void` | `setProperty(java.lang.String key, java.lang.String value)`
    `void` | `setRequest(MessageDAO msg)` Creates an input message DAO.
    `void` | `setResponse(MessageDAO msg)` Creates an output message DAO.
    `void` | `setStatus(java.lang.String status)` Set state of last message sent/received.
    `void` | `setSubscriberCount(int subscriberCount)`

- - ### Field Detail

    - #### DIR_BPEL_INVOKES_PARTNERROLE

          static final char DIR_BPEL_INVOKES_PARTNERROLE

      See Also:
        Constant Field Values

    - #### DIR_PARTNER_INVOKES_MYROLE

          static final char DIR_PARTNER_INVOKES_MYROLE

      See Also:
        Constant Field Values

  - ### Method Detail

    - #### getMessageExchangeId

          java.lang.String getMessageExchangeId()

      Instance id of the message exchange.
      Returns:
        message exchange id.

    - #### getResponse

          MessageDAO getResponse()

      Get output message (could be fault message)
      Returns:
        output message DAO

    - #### getCreateTime

          java.util.Date getCreateTime()

      Creation time of the message exchange
      Returns:
        create time

    - #### setCreateTime

          void setCreateTime(java.util.Date createTime)

    - #### getRequest

          MessageDAO getRequest()

      Get the input message.
      Returns:
        input message DAO

    - #### getOperation

          java.lang.String getOperation()

      Get the operation name of this message exchange.
      Returns:
        operation name.

    - #### getPortType

          javax.xml.namespace.QName getPortType()

      The qualified name of the WSDL port type.
      Returns:
        port type name

    - #### setPortType

          void setPortType(javax.xml.namespace.QName porttype)

      Set the port type.
      Parameters:
        `porttype` - port type

    - #### setStatus

          void setStatus(java.lang.String status)

      Set state of last message sent/received.
      Parameters:
        `status` - state to be set

    - #### getStatus

          java.lang.String getStatus()

      Get state of last message sent/received.
      Returns:
        the state

    - #### createMessage

          MessageDAO createMessage(javax.xml.namespace.QName type)

      Create a new message associated with this message-exchange
      Parameters:
        `type` - message type
      Returns:
        new `MessageDAO`

    - #### setRequest

          void setRequest(MessageDAO msg)

      Creates an input message DAO.

    - #### setResponse

          void setResponse(MessageDAO msg)

      Creates an output message DAO.

    - #### getPartnerLinkModelId

          int getPartnerLinkModelId()

      Get the model id for the partner link to which this message exchange relates.
      Returns:

    - #### setPartnerLinkModelId

          void setPartnerLinkModelId(int modelId)

      Set the model id for the partner link to which this message exchange relates
      Parameters:
        `modelId` -

    - #### getCorrelationId

          java.lang.String getCorrelationId()

      Get the correlation identifier/client id
      Returns:
        correlation identifier

    - #### setCorrelationId

          void setCorrelationId(java.lang.String correlationId)

      Set the correlation identifier/client id
      Parameters:
        `correlationId` - identifier

    - #### setPattern

          void setPattern(java.lang.String string)

    - #### setOperation

          void setOperation(java.lang.String opname)

    - #### setEPR

          void setEPR(org.w3c.dom.Element epr)

    - #### getEPR

          org.w3c.dom.Element getEPR()

    - #### getPattern

          java.lang.String getPattern()

    - #### getChannel

          java.lang.String getChannel()

      Get the response channel.
      Returns:
        response channel.

    - #### setChannel

          void setChannel(java.lang.String string)

      Set the response channel.
      Parameters:
        `string` - response channel

    - #### getPropagateTransactionFlag

          boolean getPropagateTransactionFlag()

    - #### getFault

          javax.xml.namespace.QName getFault()

    - #### setFault

          void setFault(javax.xml.namespace.QName faultType)

    - #### getFaultExplanation

          java.lang.String getFaultExplanation()

    - #### setFaultExplanation

          void setFaultExplanation(java.lang.String explanation)

    - #### setCorrelationStatus

          void setCorrelationStatus(java.lang.String cstatus)

    - #### getCorrelationStatus

          java.lang.String getCorrelationStatus()

    - #### getProcess

          ProcessDAO getProcess()

      Get the process associate with this message exchange. The process should always be available for partnerRole message exchanges. However, for myRole message exchanges, it is possible that no process is associated with the message exchange (i.e. if the EPR routing fails).
      Returns:
        process associated with the message exchange

    - #### setProcess

          void setProcess(ProcessDAO process)

    - #### setInstance

          void setInstance(ProcessInstanceDAO dao)

    - #### getInstance

          ProcessInstanceDAO getInstance()

    - #### getDirection

          char getDirection()

      Get the direction of the message exchange.
      Returns:

    - #### getCallee

          javax.xml.namespace.QName getCallee()

      Get the "callee"--the id of the process being invoked in a myRole exchange.
      Returns:

    - #### setCallee

          void setCallee(javax.xml.namespace.QName callee)

      Set the "callee"--the id of the process being invoked in a myRole exchange.
      Parameters:
        `callee` -

    - #### getProperty

          java.lang.String getProperty(java.lang.String key)

    - #### setProperty

          void setProperty(java.lang.String key,
                           java.lang.String value)

    - #### getPropertyNames

          java.util.Set<java.lang.String> getPropertyNames()

    - #### setPartnerLink

          void setPartnerLink(PartnerLinkDAO plinkDAO)

    - #### getPartnerLink

          PartnerLinkDAO getPartnerLink()

    - #### getPipedMessageExchangeId

          java.lang.String getPipedMessageExchangeId()

      Gets the mex id for the message exchange that has been piped with this one in a process to process interaction.
      Returns:

    - #### setPipedMessageExchangeId

          void setPipedMessageExchangeId(java.lang.String mexId)

    - #### getSubscriberCount

          int getSubscriberCount()

    - #### setSubscriberCount

          void setSubscriberCount(int subscriberCount)

    - #### release

          void release(boolean doClean)

    - #### releasePremieMessages

          void releasePremieMessages()

      Deletes messages that arrived before the route is setup

    - #### lockPremieMessages

          boolean lockPremieMessages()