Interface NotificationHandler
-
public interface NotificationHandlerNotify users about events on Cyclos, according to his/hers preferences
-
-
Field Summary
Fields Modifier and Type Field Description static StringATTR_ENTITYScript attribute: the related entity.static StringATTR_TYPEScript attribute: the notification type AdminNotificationType or any of the UserNotificationType implementations Never nullstatic StringATTR_USERScript attribute: the user being notified Never null
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AdminNotificationsHandleradmin()It returns a handler to allow to notify administrators.CustomNotificationSendercustom(BasicUser user)Returns a handler for scripts to send custom notifications<E extends SimpleEntity>
EntityNotificationProcessingHandler<E>getProcessingHandler(NotificationProcessingEntityType<E> type)Returns aEntityNotificationProcessingHandlerfor the given typeUserNotificationsHandlerAccessoruser(BasicUser user)It returns an accessor used to get a handler to allow notify the specified user.
-
-
-
Field Detail
-
ATTR_USER
static final String ATTR_USER
Script attribute: the user being notified Never null- See Also:
- Constant Field Values
-
ATTR_TYPE
static final String ATTR_TYPE
Script attribute: the notification type AdminNotificationType or any of the UserNotificationType implementations Never null- See Also:
- Constant Field Values
-
ATTR_ENTITY
static final String ATTR_ENTITY
Script attribute: the related entity. E.g. theTransactionforAccountNotificationType.AUTHORIZED_PAYMENT_CANCELEDNever null- See Also:
- Constant Field Values
-
-
Method Detail
-
admin
AdminNotificationsHandler admin()
It returns a handler to allow to notify administrators.
-
custom
CustomNotificationSender custom(BasicUser user)
Returns a handler for scripts to send custom notifications
-
getProcessingHandler
<E extends SimpleEntity> EntityNotificationProcessingHandler<E> getProcessingHandler(NotificationProcessingEntityType<E> type)
Returns aEntityNotificationProcessingHandlerfor the given type
-
user
UserNotificationsHandlerAccessor user(BasicUser user)
It returns an accessor used to get a handler to allow notify the specified user.
-
-