Package com.onenetwork.platform.integ.edi

Interface EDI824Service

All Superinterfaces:
Service
public interface EDI824Service
extends Service
The EDI824Service class has common methods to help
  • create 824 transaction set
  • create 824 envelope
  • create generic EDI824ErrorDef
  • create EDI824ErrorDef when business error occurs

  • Method Details

    • createEDI824TransactionSet

      com.americancoders.edi.TransactionSet createEDI824TransactionSet​(EDI824ErrorDef edi824ErrorDef, EDIMessagingContext ediMessagingContext) throws java.lang.Exception
      Creates and 824 transaction set using the errors captured in EDI824ErrorDef
      Parameters:
      edi824ErrorDef -
      ediMessagingContext -
      Returns:
      the 824 transaction set created
      Throws:
      java.lang.Exception

    • createEDI824Envelope

      com.americancoders.edi.Envelope createEDI824Envelope​(ModelList wfResponse, EDIMessagingContext ediMessagingContext) throws java.lang.Exception
      Creates and 824 envelope using the workflow response
      Parameters:
      wfResponse -
      ediMessagingContext -
      Returns:
      the 824 envelope created
      Throws:
      java.lang.Exception

    • createGenericEDI824ErrorDef

      EDI824ErrorDef createGenericEDI824ErrorDef​(com.americancoders.edi.Envelope envelope)
      Build a generic EDI824ErrorDef using the details from the parent envelope
      Parameters:
      envelope - - the parent transaction's envelope for which the 824 is needed
      Returns:
      EDI824ErrorDef created

    • createEDI824ErrorDef

      EDI824ErrorDef createEDI824ErrorDef​(com.americancoders.edi.DocumentErrors docErrors, java.lang.String edi824AckCode, java.lang.String ediErrorCode, EDIMessagingContext ediMsgContext)
      Create EDI824ErrorDef using the errors captured in DocumentErrors. The 824 will have the ackCode and errorCode as specified.
      Parameters:
      docErrors -
      edi824AckCode -
      ediErrorCode -
      ediMsgContext -
      Returns:
      EDI824ErrorDef created

    • populateRefTransNumberOn824

      void populateRefTransNumberOn824​(com.americancoders.edi.Envelope envelope824, EDIMessagingContext ediMsgContext)
      Use this method to update the reference transaction numbers on the EDI 824. For example if the 824 is being generated for a business error on shipment, then the ref trans number would be the shipment number which will be populated on the REF segment within OTI loop.
      Parameters:
      envelope824 - - envelope of the EDI 824
      ediMsgContext -