Package com.avoka.fc.core.service

Interface IDeliveryProcessService

All Known Implementing Classes:
FluentDeliveryProcessService, GroovyDeliveryProcessService, TrashCanDeliveryProcess
public interface IDeliveryProcessService
Provides a service interface for the submission delivery process.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    deliverSubmission(Submission submission, DeliveryDetails deliveryDetails)
    Deliver the given submission using a delivery process and return the process invocation identifier.
    int
    getMaxCheckpointDeliveryAttempts()
    Return the maximum number of times the checkpoint delivery process should be attempted.
    int
    getMaxDeliveryAttempts()
    Return the maximum number of times the form submission delivery should be attempted if an error occurs.
    int
    getRetryDelayMins()
    Return the minimum submission delivery retry in minutes.
    boolean
    isDeliverAttachments()
    Return true if attachments are going to be delivered.

  • Method Details

    • deliverSubmission

      Object deliverSubmission(Submission submission, DeliveryDetails deliveryDetails) throws DeliveryException
      Deliver the given submission using a delivery process and return the process invocation identifier.
      Parameters:
      submission - the submission to deliver
      deliveryDetails - the submission delivery details (optional, will not be specified for abandoned submissions)
      Returns:
      the invocation results, either a DeliveryResult object or a String LiveCycle process invocation ID
      Throws:
      DeliveryException - if an error occurs

    • getMaxDeliveryAttempts

      int getMaxDeliveryAttempts()
      Return the maximum number of times the form submission delivery should be attempted if an error occurs.
      Returns:
      the maximum number of attempts at delivery for this service

    • getMaxCheckpointDeliveryAttempts

      int getMaxCheckpointDeliveryAttempts()
      Return the maximum number of times the checkpoint delivery process should be attempted.
      Returns:
      the maximum number of times the checkpoint delivery process should be attempted
      Since:
      4.3.4

    • getRetryDelayMins

      int getRetryDelayMins()
      Return the minimum submission delivery retry in minutes.
      Returns:
      the minimum submission delivery retry in minutes

    • isDeliverAttachments

      boolean isDeliverAttachments()
      Return true if attachments are going to be delivered.
      Returns:
      true if attachments are going to be delivered