Package org.kuali.rice.ksb.messaging.service

Interface MessageQueueService

All Known Implementing Classes:
MessageQueueServiceImpl
public interface MessageQueueService
Service for interfacing with the queue of asynchronous messages.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Method Details

    • delete

      void delete(PersistedMessageBO routeQueue)

    • save

      PersistedMessageBO save(PersistedMessageBO routeQueue)

    • findAll

      List<PersistedMessageBO> findAll(int maxRows)

    • findByRouteQueueId

      PersistedMessageBO findByRouteQueueId(Long routeQueueId)
      Finds the PersistedMessageBO identified by the passed-in primary key, if one is available, otherwise returns a null object.
      Parameters:
      routeQueueId - The primary key routeQueueId of the message desired.
      Returns:
      A populated PersistedMessageBO instance, if the routeQueueId exists, otherwise a null object.

    • getNextDocuments

      List<PersistedMessageBO> getNextDocuments(Integer maxDocuments)
      Returns a List of RouteQueue documents which are queued for routing. Will not return more RouteQueues than the value of maxDocuments.

    • findByValues

      List<PersistedMessageBO> findByValues(Map<String,String> criteriaValues, int maxRows)
      Finds the persisted messages that match the values passed into the criteriaValues Map, with an auto-wildcard function, if no wildcard is passed in.
      Parameters:
      criteriaValues - A Map of Key/Value pairs, where the Key is a string holding the field name, and the Value is a string holding the value to match.
      maxRows - the maximum number of rows to return from the query. If -1, then all rows will be returned.
      Returns:
      A populated (or empty) list containing the results of the search. If no matches are made, an empty list will be returned.