org.exoplatform.commons.api.notification

Interface NotificationContext

All Superinterfaces:

Cloneable

public interface NotificationContext
extends Cloneable

Method Summary

Methods

Modifier and Type	Method and Description
<T> NotificationContext	append(ArgumentLiteral<T> argument, Object value) Append the argument literal.
void	clear() Clear all of filter optional
NotificationContext	clone() Creates and returns a copy of this object If class extends NotificationContextImpl and implements method clone(), then must use supper.clone();
ChannelManager	getChannelManager() Gets the channel manager what contains all channel on Notification
Exception	getException() Gets the exception if have any when the done processing
<T> T	getException(Class<T> type) Gets the exception if have any when the done processing
NotificationExecutor	getNotificationExecutor() Gets the NotificationExceutor service
NotificationInfo	getNotificationInfo() Gets notification information
List<NotificationInfo>	getNotificationInfos() Gets notification message list
PluginContainer	getPluginContainer() Gets the plugin container what contains all plugins on Notification
PluginSettingService	getPluginSettingService() Gets the PluginSettingService service
boolean	isFailed() The signal lets you know the processing is successfully or not
boolean	isWritingProcess() Determines the writing processing or NOT
NotificationCommand	makeCommand(PluginKey key) Makes the NotificationCommand by the NotificationKey
<T> NotificationContext	remove(ArgumentLiteral<T> filter) Removes the query parameter.
void	setException(Throwable t) Sets the exception if have any when the done processing
NotificationContext	setNotificationInfo(NotificationInfo notification) Sets notification infomation
void	setNotificationInfos(List<NotificationInfo> notifications) Sets notification information list
void	setWritingProcess(boolean writingStatus) Sets the writing status to the context
<T> T	value(ArgumentLiteral<T> argument) Gets FilterOption which was existing.

Method Detail

isWritingProcess

boolean isWritingProcess()

Determines the writing processing or NOT

Returns:

setWritingProcess

void setWritingProcess(boolean writingStatus)

Sets the writing status to the context

Parameters:

writingStatus -

append

<T> NotificationContext append(ArgumentLiteral<T> argument,
                             Object value)

Append the argument literal.

Parameters:

param -

Returns:

remove

<T> NotificationContext remove(ArgumentLiteral<T> filter)

Removes the query parameter.

Parameters:

param -

Returns:

clear

void clear()

Clear all of filter optional

value

<T> T value(ArgumentLiteral<T> argument)

Gets FilterOption which was existing.

Parameters:

param -

Returns:

getNotificationInfo

NotificationInfo getNotificationInfo()

Gets notification information

Returns:

setNotificationInfo

NotificationContext setNotificationInfo(NotificationInfo notification)

Sets notification infomation

Parameters:

notification -

setNotificationInfos

void setNotificationInfos(List<NotificationInfo> notifications)

Sets notification information list

Parameters:

notifications -

getNotificationInfos

List<NotificationInfo> getNotificationInfos()

Gets notification message list

Returns:

getException

Exception getException()

Gets the exception if have any when the done processing

Returns:

getException

<T> T getException(Class<T> type)

Gets the exception if have any when the done processing

Parameters:

type -

Returns:

setException

void setException(Throwable t)

Sets the exception if have any when the done processing

Parameters:

t -

isFailed

boolean isFailed()

The signal lets you know the processing is successfully or not

Returns:

getNotificationExecutor

NotificationExecutor getNotificationExecutor()

Gets the NotificationExceutor service

Returns:

makeCommand

NotificationCommand makeCommand(PluginKey key)

Makes the NotificationCommand by the NotificationKey

Parameters:

key -

Returns:

clone

NotificationContext clone()

Creates and returns a copy of this object If class extends NotificationContextImpl and implements method clone(), then must use supper.clone();

See Also:

Object.clone()

getPluginSettingService

PluginSettingService getPluginSettingService()

Gets the PluginSettingService service

Returns:

getPluginContainer

PluginContainer getPluginContainer()

Gets the plugin container what contains all plugins on Notification

Returns:

getChannelManager

ChannelManager getChannelManager()

Gets the channel manager what contains all channel on Notification

Returns: