com.nitido.nim
Class NotificationStatus

java.lang.Object
  com.nitido.nim.NotificationStatus

public class NotificationStatus
extends java.lang.Object

A notification status object that contains information about the delivery of the message to one or more recipients.

Constructor Summary

NotificationStatus(java.lang.String ticket)
Default constructor of NotificationStatus

Method Summary

void	addRecipientStatus(java.lang.String recipient, IndividualStatus is)
java.util.Set<java.lang.String>	getRecipients() The IDs of all the recipients that this message was supposed to be sent to.
java.util.Collection<IndividualStatus>	getRecipientsStatuses() Returns a list of all the individual status objects for all the recipients of this message.
IndividualStatus	getRecipientStatus(java.lang.String recipient) Get an individual status object for one of the intended recipients of this message.
java.lang.String	getTicket() Get the ticket string.
boolean	isFinalStatus() The service will not have any updated status information for any of the recipients to whom this message was sent out.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NotificationStatus

public NotificationStatus(java.lang.String ticket)

Default constructor of NotificationStatus

Method Detail

getTicket

public java.lang.String getTicket()

Get the ticket string.

addRecipientStatus

public void addRecipientStatus(java.lang.String recipient,
                               IndividualStatus is)

getRecipientStatus

public IndividualStatus getRecipientStatus(java.lang.String recipient)

Get an individual status object for one of the intended recipients of this message.

Parameters:

recipient - the recipient's ID

Returns:

the status details for the message and its progress in being delivered to this particular recipient

getRecipients

public java.util.Set<java.lang.String> getRecipients()

The IDs of all the recipients that this message was supposed to be sent to.

Returns:

one or more recipient IDs

getRecipientsStatuses

public java.util.Collection<IndividualStatus> getRecipientsStatuses()

Returns a list of all the individual status objects for all the recipients of this message.

Returns:

a list of all the individual status objects for all the recipients of this message.

isFinalStatus

public boolean isFinalStatus()

The service will not have any updated status information for any of the recipients to whom this message was sent out.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object