Package org.kuali.rice.kcb.service

Interface MessageDeliveryService

All Known Implementing Classes:
MessageDeliveryServiceImpl
public interface MessageDeliveryService
The MessageDeliveryService class is responsible various functions regarding the MessageDelivery records that exist within the system.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Details

    • saveMessageDelivery

      MessageDelivery saveMessageDelivery(MessageDelivery delivery)
      Saves a MessageDelivery
      Parameters:
      delivery - the MessageDelivery to save

    • deleteMessageDelivery

      void deleteMessageDelivery(MessageDelivery delivery)
      Deletes a MessageDelivery
      Parameters:
      delivery - the MessageDelivery to delete

    • getMessageDelivery

      MessageDelivery getMessageDelivery(Long id)
      This method will retrieve a MessageDelivery object from the system, given the id of the actual record.
      Parameters:
      id -
      Returns:
      MessageDelivery

    • getMessageDeliveryByDelivererSystemId

      MessageDelivery getMessageDeliveryByDelivererSystemId(Long id)
      This method will retrieve a MessageDelivery object from the system, given the external deliverer system id registered with the MessageDelivery.
      Parameters:
      id - the external deliverer system id
      Returns:
      MessageDelivery

    • getAllMessageDeliveries

      Collection<MessageDelivery> getAllMessageDeliveries()
      This method will return all MessageDelivery objects in the system
      Returns:
      Collection<MessageDelivery> list of MessageDelivery objects in the system

    • getMessageDeliveries

      Collection<MessageDelivery> getMessageDeliveries(Message message)
      This method will return all MessageDelievery objects generated for the given Message
      Parameters:
      message - the message which generated the message deliveries
      Returns:
      collection of NotificationMessageDelivery objects generated for the given Notification for the given user

    • lockAndTakeMessageDeliveries

      Collection<MessageDelivery> lockAndTakeMessageDeliveries(Long messageId, MessageDeliveryStatus[] status)
      Locks and takes all message deliveries of a given message in the system with any of the specified statuses
      Parameters:
      messageId - the id of the message whose deliveries to take
      status - the statuses of message deliveries to take
      Returns:
      a collection of message deliveries

    • lockAndTakeMessageDeliveries

      Collection<MessageDelivery> lockAndTakeMessageDeliveries(MessageDeliveryStatus[] status)
      Locks and takes all message deliveries in the system with any of the specified statuses
      Parameters:
      status - the statuses of message deliveries to take
      Returns:
      a collection of message deliveries