Class DeliveryFunctionProcessor


  • public class DeliveryFunctionProcessor
    extends Object
    Provides Delivery Function execution capabilities.
    Since:
    17.10.0
    • Constructor Detail

      • DeliveryFunctionProcessor

        public DeliveryFunctionProcessor()
    • Method Detail

      • setExecuteCompleted

        public DeliveryFunctionProcessor setExecuteCompleted​(boolean executeCompleted)
        Parameters:
        executeCompleted - the execute the function even if already completed
        Returns:
        the delivery function processor
      • setFormData

        public DeliveryFunctionProcessor setFormData​(Document formData)
        Parameters:
        formData - the formData to set
        Returns:
        the delivery function processor
      • setSubmission

        public DeliveryFunctionProcessor setSubmission​(Submission submission)
        Parameters:
        submission - the submission to set
        Returns:
        the delivery function processor
      • setTriggerType

        public DeliveryFunctionProcessor setTriggerType​(String triggerType)
        Parameters:
        triggerType - the triggerType to set
        Returns:
        the delivery function processor
      • setUserAccount

        public DeliveryFunctionProcessor setUserAccount​(UserAccount userAccount)
        Parameters:
        userAccount - the userAccount to set
        Returns:
        the delivery function processor
      • registerSubmissionDeliveryFunctions

        public boolean registerSubmissionDeliveryFunctions​(Submission submission)
        Register any available submission delivery function records and return true if the submission has delivery functions registered.
        Parameters:
        submission - the submission record (required)
        Returns:
        true if the submission has delivery functions registered
      • execute

        public boolean execute​(IFluentFunction function)
        Execute the specified submission delivery function. This method is designed to be executed on the HTTP user thread.
        Parameters:
        function - the delivery function service definition (required)
        Returns:
        true to continue processing fluent functions
      • excecuteAllDeliveryFunctions

        public String excecuteAllDeliveryFunctions​(Submission submission)
        Register the configured submission delivery function records. This method is designed to be called by the TransactionProcessor in a background Quartz scheduled job.
        Parameters:
        submission - the submission record (required)
        Returns:
        status message
      • updateDeliveryStatus

        public String updateDeliveryStatus​(Submission submission)
        Update the delivery status based on the current delivery functions.
        Parameters:
        submission - the submission delivery status to update (required)
        Returns:
        the delivery status message