com.tomtom.speedtools.services.sms

Interface SMSDeliveryReportProcessor

public interface SMSDeliveryReportProcessor

This processor is a strategy for processing delivery reports. An implementation is provided by every SMSProviderConnector, allowing for SMSProvider specific processing.

Method Summary

Modifier and Type	Method and Description
SMSDeliveryReportListener.DeliveryStatus	getDeliveryStatus() Get the delivery status for the delivery report.
long	getReferenceNumber() Get the reference number for the delivery report.
boolean	skip() Indicates whether or not to continue with this particular report.

Method Detail

skip

boolean skip()

Indicates whether or not to continue with this particular report. For instance, an SMSProvider might deliver intermediate reports that do not lead to an action on the back-end side. If skip is true, the other methods on this processor must not be called.

Returns:

True to skip this report.

getReferenceNumber

long getReferenceNumber()
                 throws SMSDeliveryReportParameterException

Get the reference number for the delivery report. The reference number was passed to the SMSProvider when sending the message. The back-end ensures that sms messages are uniquely numbered (> 0).

Returns:

The reference number.

Throws:

SMSDeliveryReportParameterException - If error.

getDeliveryStatus

@Nonnull
SMSDeliveryReportListener.DeliveryStatus getDeliveryStatus()
                                                             throws SMSDeliveryReportParameterException

Get the delivery status for the delivery report.

Returns:

The delivery status.

Throws:

SMSDeliveryReportParameterException - If error.