Package com.avoka.fc.core.service

Class DeliveryResult

java.lang.Object
com.avoka.fc.core.service.DeliveryResult
public class DeliveryResult extends Object
Provides a Submission Delivery Process Service result class, which can be returned by the IDeliveryProcessService.
Since:
3.6.0
See Also:

  • Constructor Details

    • DeliveryResult

      public DeliveryResult(DeliveryResult.Status status)
      Create a delivery results object with the given delivery status.
      Parameters:
      status - the submission delivery status to set

  • Method Details

    • getDeliveryStatus

      public String getDeliveryStatus()
      Returns:
      the submission delivery status

    • isStatusReady

      public boolean isStatusReady()
      Return true of the delivery status is "Ready"
      Returns:
      true of the delivery status is "Ready"

    • isStatusInProgress

      public boolean isStatusInProgress()
      Return true of the delivery status is "In Progress"
      Returns:
      true of the delivery status is "In Progress"

    • isStatusPending

      public boolean isStatusPending()
      Return true of the delivery status is "Pending"
      Returns:
      true of the delivery status is "Pending"

    • isStatusCompleted

      public boolean isStatusCompleted()
      Return true of the delivery status is "Completed"
      Returns:
      true of the delivery status is "Completed"

    • isStatusError

      public boolean isStatusError()
      Return true of the delivery status is "Error"
      Returns:
      true of the delivery status is "Error"

    • isStatusUndeliverable

      public boolean isStatusUndeliverable()
      Return true of the delivery status is "Undeliverable"
      Returns:
      true of the delivery status is "Undeliverable"

    • getMessage

      public String getMessage()
      Return the delivery message to be recorded.
      Returns:
      the delivery message

    • setMessage

      public void setMessage(String message)
      Set the delivery message to be recorded.
      Parameters:
      message - the delivery message to set

    • getNextDeliveryTime

      public Date getNextDeliveryTime()
      Return the next schedule time to attempt a delivery.
      Returns:
      the nextDeliveryTime

    • setNextDeliveryTime

      public void setNextDeliveryTime(Date nextDeliveryTime)
      Set the next schedule time to attempt a delivery.
      Parameters:
      nextDeliveryTime - the nextDeliveryTime to set

    • getMaxDeliveryAttempts

      public int getMaxDeliveryAttempts()
      Return the maximum number of delivery attempts which should be performed.
      Returns:
      the maxDeliveryAttempts

    • setMaxDeliveryAttempts

      public void setMaxDeliveryAttempts(int maxDeliveryAttempts)
      Set the maximum number of delivery attempts which should be performed.
      Parameters:
      maxDeliveryAttempts - the maxDeliveryAttempts to set

    • getDataPurgeTime

      public Date getDataPurgeTime()
      Return the schedule submission data purge time for completed and undeliverable submissions.
      Returns:
      the submission dataPurgeTime

    • setDataPurgeTime

      public void setDataPurgeTime(Date dataPurgeTime)
      Set the schedule submission data purge time for completed and undeliverable submissions.
      Parameters:
      dataPurgeTime - the submission dataPurgeTime to set

    • getDeliveryChannel

      public String getDeliveryChannel()
      Return the delivery channel for submission.
      Returns:
      the delivery channel for submission
      Since:
      5.0.2

    • setDeliveryChannel

      public void setDeliveryChannel(String deliveryChannel)
      Set the delivery channel for submission.
      Parameters:
      deliveryChannel - the delivery channel for submission
      Since:
      5.0.2

    • toDeliveryStatus

      public static DeliveryResult.Status toDeliveryStatus(String status)
      Return the corresponding Status enumeration for the text status.
      Parameters:
      status - the text status value
      Returns:
      the corresponding Status enumeration for the text status
      Since:
      5.0

    • toString

      public String toString()
      Overrides:
      toString in class Object
      Returns:
      the string representation of this object