curam.util.workflow.impl

Interface NotificationDelivery

@Implementable
 @AccessLevel(value=EXTERNAL)
public interface NotificationDelivery

The NotificationDelivery callback interface must be implemented to define how notifications should be delivered. The workflow engine will retrieve the required NotificationDelivery implementation class via the application property curam.custom.notifications.notificationdelivery and call the associated deliverNotification function to deliver the specified notification based on the evaluated allocation targets.

A default implementation of this interface is provided but if a different delivery strategy is required this default class can be overridden by creating a new class that implements this interface and updating the property above to point to that new class.

Method Summary

Modifier and Type	Method and Description
boolean	deliverNotification(NotificationDetails notificationDetails, java.util.Map<java.lang.String,java.lang.String> allocationTargets) Delivers the specified notification using the Map of allocation targets defined.
boolean	deliverNotification(NotificationDetails notificationDetails, java.lang.Object allocationTargets) Delivers the specified notification using the list of allocation targets defined.
boolean	deliverNotification(NotificationDetails notificationDetails, java.lang.String allocationTargetID) Delivers the specified notification using the allocation target identifier defined.

Method Detail

deliverNotification

boolean deliverNotification(NotificationDetails notificationDetails,
                            java.lang.Object allocationTargets)

Delivers the specified notification using the list of allocation targets defined.

Parameters:

notificationDetails - The details of the notification that will be delivered.

allocationTargets - The list of allocation targets used in the delivery of the notification.

Returns:

True if the notification has been successfully delivered to at least one user, otherwise False.

deliverNotification

boolean deliverNotification(NotificationDetails notificationDetails,
                            java.util.Map<java.lang.String,java.lang.String> allocationTargets)

Delivers the specified notification using the Map of allocation targets defined.

Parameters:

notificationDetails - The details of the notification that will be delivered.

allocationTargets - A Map of allocation target names to allocation target types.

Returns:

True if the notification has been successfully delivered to at least one user, otherwise False.

deliverNotification

boolean deliverNotification(NotificationDetails notificationDetails,
                            java.lang.String allocationTargetID)

Delivers the specified notification using the allocation target identifier defined.

Parameters:

notificationDetails - The details of the notification that will be delivered.

allocationTargetID - The identifier of an allocation target.

Returns:

True if the notification has been successfully delivered to at least one user, otherwise False.