Package org.exoplatform.commons.api.notification

Interface NotificationContext

All Superinterfaces:
Cloneable
public interface NotificationContext extends Cloneable

  • Method Details

    • 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:
      argument -
      value -
      Returns:

    • remove

      <T> NotificationContext remove(ArgumentLiteral<T> filter)
      Removes the query parameter.
      Parameters:
      filter -
      Returns:

    • clear

      void clear()
      Clear all of filter optional

    • value

      <T> T value(ArgumentLiteral<T> argument)
      Gets FilterOption which was existing.
      Parameters:
      argument -
      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:

    • 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: