Package com.avoka.fc.core.service

Interface ISubmissionDeliveryController

All Known Implementing Classes:
SubmissionDeliveryControllerService
public interface ISubmissionDeliveryController
Provides an interface for Submission delivery service.

  • Method Details

    • deliverSubmission

      String deliverSubmission(Submission submission)
      Deliver the given submission and return a delivery status message.
      Parameters:
      submission - the submission to deliver
      Returns:
      a delivery status message

    • getNextRESTSubmission

      Submission getNextRESTSubmission(DeliveryDetails deliveryDetails)
      Return the next submission ready for delivery for the given REST Service delivery details, and set the Submission delivery status to 'In Progress' or null otherwise.
      Parameters:
      deliveryDetails - the 'REST Service' delivery details (required)
      Returns:
      the next submission if available, or null otherwise.
      Since:
      4.2.0

    • completeRESTDelivery

      Submission completeRESTDelivery(DeliveryDetails deliveryDetails, Submission submission, boolean deleteData, String processingStatus)
      Complete REST Service submission delivery and return the completed submission.
      Parameters:
      deliveryDetails - the REST Service delivery details (required)
      submission - the submission to complete, must be associated with 'REST Service' delivery details (required)
      deleteData - specify whether to delete transaction data immediately
      processingStatus - the submission processing status message to set (optional)
      Returns:
      the completed submission
      Since:
      4.1.8

    • errorRESTDelivery

      Submission errorRESTDelivery(DeliveryDetails deliveryDetails, Submission submission, String errorMessage, jakarta.servlet.http.HttpServletRequest request)
      Set a REST submission delivery error and return the updated submission.
      Parameters:
      deliveryDetails - the REST Service delivery details (required)
      submission - the submission to update with an Error delivery status, must be associated with 'REST Service'
      errorMessage - the submission processing status message to set (optional)
      request - the REST operation request (required)
      Returns:
      the updated submission
      Since:
      4.3.0

    • setAttachmentDeliveryCompleted

      void setAttachmentDeliveryCompleted(Attachment attachment, String dataHash) throws Exception
      Set the attachment delivery status as completed.
      Parameters:
      attachment - the attachment to update as delivery completed
      dataHash - the attachment SHA-256 data confirmation hash
      Throws:
      Exception - if an error occurs

    • setSubmissionDeliveryCompleted

      void setSubmissionDeliveryCompleted(Submission submission, String dataHash) throws Exception
      Set the submission delivery status as completed and delete the submission data if configured. Note this method does not commit these changes, that is the responsibility of the calling code.
      Parameters:
      submission - the submission to update as delivery completed
      dataHash - the attachment SHA-256 data confirmation hash
      Throws:
      Exception - if an error occurs

    • sendEmailReminder

      void sendEmailReminder(Submission submission)
      Send an submission delivery reminder email.
      Parameters:
      submission - the submission to send the reminder email to

    • sendEmailEscalation

      void sendEmailEscalation(Client client, List<UserAccount> recipients, long numberOfEscalations)
      Send a submission delivery escalation email.
      Parameters:
      client - the client for which an email should be sent
      recipients - the users to send the escalation email to
      numberOfEscalations - the number of undelivered submissions

    • setEmailSubmissionDeliveryCompleted

      void setEmailSubmissionDeliveryCompleted(Submission submission)
      Set the submission delivery status as completed.
      Parameters:
      submission - the submission to update as delivery completed

    • setSubmissionDeliveryCompletedByAdmin

      void setSubmissionDeliveryCompletedByAdmin(Submission submission, String userName)
      Set the submission delivery status as completed.
      Parameters:
      submission - the submission to update as delivery completed
      userName - the login name for the administrator who set delivery to be completed

    • getSecureEmailReminderAgeHours

      String getSecureEmailReminderAgeHours()
      Return The maximum age in hours before secure submission delivery reminder emails are sent out.
      Returns:
      the maximum age in hours before secure submission delivery reminder emails are sent out.

    • getDeliveryEmailEscalationAgeHours

      String getDeliveryEmailEscalationAgeHours()
      Return The maximum age in hours before late secure submission delivery escalation emails.
      Returns:
      the maximum age in hours before late secure submission delivery escalation emails.