Package com.onenetwork.platform.integ.edi

Class EDIMessagingContext

java.lang.Object
com.onenetwork.platform.integ.edi.EDIMessagingContext
public class EDIMessagingContext
extends java.lang.Object
EDI Messaging Context contains the current messaging context details pertaining to an EDI. For an inbound EDI, this contains the messaging context pertaining to an inbound EDI

- like the inbound transaction set, sender/receiver info, plt context, etc.

For an outbound EDI, this contains the details pertaining to the outbound flow.

- like the sender/receiver info, plt user context, etc

  • Constructor Details

  • Method Details

    • getInboundTransactionSet

      public com.americancoders.edi.TransactionSet getInboundTransactionSet()
      Returns:
      the inboundTransactionSet - the current transaction set being processed inbound.

    • setInboundTransactionSet

      public void setInboundTransactionSet​(com.americancoders.edi.TransactionSet inboundTransactionSet)
      Parameters:
      inboundTransactionSet - the inboundTransactionSet to set

    • getEnvelope

      public com.americancoders.edi.Envelope getEnvelope()
      Returns:
      for inbound messages only, contains the envelope for the message

    • setEnvelope

      public void setEnvelope​(com.americancoders.edi.Envelope envelope)
      Parameters:
      envelope - for inbound messages only, contains the envelope for the message

    • getTransactionSetIdentifier

      public java.lang.String getTransactionSetIdentifier()
      Returns:
      the transactionSetIdentifier

      The message type of the EDI being processed. Example: 850, 856

    • setTransactionSetIdentifier

      public void setTransactionSetIdentifier​(java.lang.String transactionSetIdentifier)
      Parameters:
      transactionSetIdentifier - the transactionSetIdentifier to set

    • getEdiFormat

      public java.lang.String getEdiFormat()
      Returns:
      the ediFormat

      The EDI format like X12 or EDIFact

    • setEdiFormat

      public void setEdiFormat​(java.lang.String ediFormat)
      Parameters:
      ediFormat - the ediFormat to set

    • getFromEnterpriseName

      public java.lang.String getFromEnterpriseName()
      Returns:
      the fromEnterpriseName The sender enterprise name.

    • setFromEnterpriseName

      public void setFromEnterpriseName​(java.lang.String fromEnterpriseName)
      Parameters:
      fromEnterpriseName - the fromEnterpriseName to set

    • getToEnterpriseName

      public java.lang.String getToEnterpriseName()
      Returns:
      the toEnterpriseName The receiver enterprise name

    • setToEnterpriseName

      public void setToEnterpriseName​(java.lang.String toEnterpriseName)
      Parameters:
      toEnterpriseName - the toEnterpriseName to set

    • getMessage

      public Message getMessage()
      Returns:
      the message The encapsulating PLT message for the EDI to process.

    • setMessage

      public void setMessage​(Message message)
      Parameters:
      message - the message to set

    • getFunctionalGroupIdentifier

      public java.lang.String getFunctionalGroupIdentifier()
      Returns:
      the functionalGroupIdentifier The functional group type like PO, SH, FA etc

    • setFunctionalGroupIdentifier

      public void setFunctionalGroupIdentifier​(java.lang.String functionalGroupIdentifier)
      Parameters:
      functionalGroupIdentifier - the functionalGroupIdentifier to set

    • getEdiMessageQueueRef

      public EdiMessageQueue getEdiMessageQueueRef()
      Returns:
      the ediMessageQueueRef The EdiMessageQueue reference for the transaction set in process.

    • setEdiMessageQueueRef

      public void setEdiMessageQueueRef​(EdiMessageQueue ediMessageQueueRef)
      Parameters:
      ediMessageQueueRef - the ediMessageQueueRef to set

    • getEdiMessageQueueRefFor997

      public EdiMessageQueue getEdiMessageQueueRefFor997()
      Returns:
      the ediMessageQueueRefFor997 The EdiMessageQueue reference for the functional ack (997/CONTRL) of the inbound transaction set.

      Note - Applicable for inbound only. Null for outbound

    • setEdiMessageQueueRefFor997

      public void setEdiMessageQueueRefFor997​(EdiMessageQueue ediMessageQueueRefFor997)
      Parameters:
      ediMessageQueueRefFor997 - the ediMessageQueueRefFor997 to set

    • getEdiMessageQueueRefFor824

      public EdiMessageQueue getEdiMessageQueueRefFor824()
      Returns:
      the ediMessageQueueRefFor824 The EdiMessageQueue reference for the 824/application advice of the inbound transaction set.

      Note - Applicable for inbound only. Null for outbound

    • setEdiMessageQueueRefFor824

      public void setEdiMessageQueueRefFor824​(EdiMessageQueue ediMessageQueueRefFor824)
      Parameters:
      ediMessageQueueRefFor824 - the ediMessageQueueRefFor824 to set

    • setSenderGsId

      public void setSenderGsId​(java.lang.String senderGsId)
      Parameters:
      senderGsId - the senderGsId to set

    • getSenderGsId

      public java.lang.String getSenderGsId()
      Returns:
      the senderGsId

    • setReceiverGsId

      public void setReceiverGsId​(java.lang.String receiverGsId)
      Parameters:
      receiverGsId - the receiverGsId to set

    • getReceiverGsId

      public java.lang.String getReceiverGsId()
      Returns:
      the receiverGsId

    • setPartner

      public void setPartner​(Partner partner)
      Parameters:
      partner - the partner to set The partner usually corresponding to the sender/receiver combination. This is also the partner to be used to process the EDI.

    • getPartner

      public Partner getPartner()
      Returns:
      the partner

    • setSenderIsaId

      public void setSenderIsaId​(java.lang.String senderIsaId)
      Parameters:
      senderIsaId - the senderIsaId to set

    • getSenderIsaId

      public java.lang.String getSenderIsaId()
      Returns:
      the senderIsaId

    • setReceiverIsaId

      public void setReceiverIsaId​(java.lang.String receiverIsaId)
      Parameters:
      receiverIsaId - the receiverIsaId to set

    • getReceiverIsaId

      public java.lang.String getReceiverIsaId()
      Returns:
      the receiverIsaId

    • setSenderIsaQualifier

      public void setSenderIsaQualifier​(java.lang.String senderIsaQualifier)
      Parameters:
      senderIsaQualifier - the senderIsaQualifier to set

    • getSenderIsaQualifier

      public java.lang.String getSenderIsaQualifier()
      Returns:
      the senderIsaQualifier

    • setReceiverIsaQualifier

      public void setReceiverIsaQualifier​(java.lang.String receiverIsaQualifier)
      Parameters:
      receiverIsaQualifier - the receiverIsaQualifier to set

    • getReceiverIsaQualifier

      public java.lang.String getReceiverIsaQualifier()
      Returns:
      the receiverIsaQualifier

    • getDvceContext

      @Deprecated public <T extends PlatformUserContext> T getDvceContext()
      Deprecated.
      Use getUserContext()

    • setDvceContext

      @Deprecated public <T extends PlatformUserContext> void setDvceContext​(T pltUsrContext)
      Deprecated.
      Use setUserContext(PlatformUserContext)

    • getUserContext

      public PlatformUserContext getUserContext()
      Method to get the PLT user context which is the user context being used for the EDI processing
      Returns:
      PlatformUserContext

    • setUserContext

      public void setUserContext​(PlatformUserContext pltUsrContext)
      Method to set the PLT user context which will the user context used for the EDI processing
      Parameters:
      pltUsrContext -

    • getFileStructure

      public java.lang.String getFileStructure()
      Returns a String with one of two possible values - XML or FlatFile to indicate which format is used for IDoc data
      Returns:
      the fileStructure

    • setFileStructure

      public void setFileStructure​(java.lang.String fileStructure)
      Set one of two possible values - XML or FlatFile to indicate which format is used for IDoc data
      Parameters:
      fileStructure - the fileStructure to set

    • getEdiVersion

      public java.lang.String getEdiVersion()
      Returns:
      the ediVersion

    • setEdiVersion

      public void setEdiVersion​(java.lang.String ediVersion)
      Parameters:
      ediVersion - the ediVersion to set