org.exoplatform.commons.api.notification.command

Interface NotificationCommand

public interface NotificationCommand

Method Summary

Methods

Modifier and Type	Method and Description
NotificationKey	getNotificationKey() Gets a notification key associated with the notification command.
AbstractNotificationPlugin	getPlugin() Gets a plugin associated with the notification command.
void	processDigest(NotificationContext ctx, Writer writer) Builds a digest message which is sent daily or weekly.
MessageInfo	processMessage(NotificationContext ctx) Builds information of a message from the notification context.
NotificationInfo	processNotification(NotificationContext ctx) Builds information of a notification from the notification context.

Method Detail

getPlugin

AbstractNotificationPlugin getPlugin()

Gets a plugin associated with the notification command.

Returns:

The notification plugin.

getNotificationKey

NotificationKey getNotificationKey()

Gets a notification key associated with the notification command.

Returns:

The notification key.

processMessage

MessageInfo processMessage(NotificationContext ctx)

Builds information of a message from the notification context.

Parameters:

ctx - The notification context.

Returns:

The message information.

processNotification

NotificationInfo processNotification(NotificationContext ctx)

Builds information of a notification from the notification context.

Parameters:

ctx - The notification context.

Returns:

The notification information.

processDigest

void processDigest(NotificationContext ctx,
                 Writer writer)

Builds a digest message which is sent daily or weekly.

Parameters:

ctx - The notification context.

writer - Stores the digest message.