com.tsgrp.opencontent.core.notification

Interface INotification

All Known Implementing Classes:

ActivitiNotificationImpl, DCTMNotificationImpl, DynamoNotificationImpl, HBaseNotificationImpl

public interface INotification

Method Summary

Modifier and Type	Method and Description
boolean	deleteNotification(java.lang.String ticket, java.lang.String notificationId) Deletes a notification by calling the dequeue method on the queueitem.
java.util.List<Notification>	getNotifications(java.lang.String ticket, java.lang.String eventName, int maxToReturn) Gets notifications for user
boolean	sendNotification(SendNotificationRequest request) Creates and sends a new notification.

Method Detail

sendNotification

boolean sendNotification(SendNotificationRequest request)

Creates and sends a new notification.

Parameters:

request - a SendNotificationRequest

Returns:

true if successfully created

getNotifications

java.util.List<Notification> getNotifications(java.lang.String ticket,
                                              java.lang.String eventName,
                                              int maxToReturn)

Gets notifications for user

Parameters:

ticket -

eventName -

maxToReturn - - if the eventName is null or empty, the implementation should return all events. If the maxToReturn is -1, the implementation should return all notifications. If the user has no notifications, this method will return an empty List

Returns:

List

deleteNotification

boolean deleteNotification(java.lang.String ticket,
                           java.lang.String notificationId)

Deletes a notification by calling the dequeue method on the queueitem. The return boolean lets you know if the entire transaction was successful.

Parameters:

ticket - an authentication ticket

notificationId - a valid workitem IDs to be completed

Returns:

true if all items could be deleted, false otherwise