A B C D E F G H I K L M N O P Q R S T U V W _

A

AbstractChannel - Class in org.exoplatform.commons.api.notification.channel

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 12, 2014

AbstractChannel(AbstractNotificationLifecycle) - Constructor for class org.exoplatform.commons.api.notification.channel.AbstractChannel

AbstractChannel() - Constructor for class org.exoplatform.commons.api.notification.channel.AbstractChannel

Using the default life-cycle

AbstractConfigurator - Class in org.exoplatform.commons.api.websocket

AbstractConfigurator() - Constructor for class org.exoplatform.commons.api.websocket.AbstractConfigurator

AbstractEndpoint - Class in org.exoplatform.commons.api.websocket

AbstractEndpoint() - Constructor for class org.exoplatform.commons.api.websocket.AbstractEndpoint

AbstractNotificationChildPlugin - Class in org.exoplatform.commons.api.notification.plugin

AbstractNotificationChildPlugin(InitParams) - Constructor for class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin

AbstractNotificationLifecycle - Class in org.exoplatform.commons.api.notification.lifecycle

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 12, 2014

AbstractNotificationLifecycle() - Constructor for class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle

AbstractNotificationPlugin - Class in org.exoplatform.commons.api.notification.plugin

AbstractNotificationPlugin(InitParams) - Constructor for class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin

AbstractTemplateBuilder - Class in org.exoplatform.commons.api.notification.channel.template

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 13, 2014

AbstractTemplateBuilder() - Constructor for class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder

accept(ElementVisitor) - Method in interface org.exoplatform.commons.api.notification.template.Element

Accept the visitor to visit the element

ActionContext - Class in org.exoplatform.commons.api.ui

ActionContext(String, String) - Constructor for class org.exoplatform.commons.api.ui.ActionContext

add(SearchEntry) - Method in class org.exoplatform.commons.api.indexing.IndexingService

Adds a search entry.

addChannelPlugin(String, String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

Add the pluginId by channel

addChildPlugin(AbstractNotificationChildPlugin) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginContainer

Register child plugin in Container

addConnector(SearchServiceConnector) - Method in class org.exoplatform.commons.api.search.SearchService

Adds a connector which is implemented by the Search API.

addEventListener(Listener<S, D>) - Method in interface org.exoplatform.commons.api.event.EventManager

Registers a listener into the event system.

addEventListener(String, Listener<S, D>) - Method in interface org.exoplatform.commons.api.event.EventManager

Registers a listener for a given event group in the event system.

addFilterDefinitions(FilterDefinitionPlugin) - Method in class org.exoplatform.commons.api.websocket.ExtensibleWSFilter

addKeyMapping(String, String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

addKeyMapping(String, String) - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

addNewLine(boolean) - Method in interface org.exoplatform.commons.api.notification.template.Element

Set the value isNewLine for the case digest

addPlugin(String, UserSetting.FREQUENCY) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

addPlugin(BaseNotificationPlugin) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginContainer

Register plugin in Container

addPlugin(BaseUIPlugin) - Method in interface org.exoplatform.commons.api.ui.PlugableUIService

addPlugin(BaseUIPlugin) - Method in class org.exoplatform.commons.api.ui.PlugableUIServiceImpl

addPluginInfo(PluginInfo) - Method in class org.exoplatform.commons.api.notification.model.GroupProvider

addProvider(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig

addTask(Callable) - Method in class org.exoplatform.commons.api.notification.service.NotificationCompletionService

append(ArgumentLiteral<T>, Object) - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Append the argument literal.

APPLICATION - Static variable in class org.exoplatform.commons.api.settings.data.Scope

Settings of an application, like Forum, Content, or Social.

ArgumentLiteral<T> - Class in org.exoplatform.commons.api.notification.model

ArgumentLiteral(Class<T>, String) - Constructor for class org.exoplatform.commons.api.notification.model.ArgumentLiteral

ArgumentLiteral(Class<T>) - Constructor for class org.exoplatform.commons.api.notification.model.ArgumentLiteral

B

BaseContext - Class in org.exoplatform.commons.api.ui

BaseContext(String) - Constructor for class org.exoplatform.commons.api.ui.BaseContext

BaseNotificationLifecycle - Class in org.exoplatform.commons.api.notification.lifecycle

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 12, 2014

BaseNotificationLifecycle() - Constructor for class org.exoplatform.commons.api.notification.lifecycle.BaseNotificationLifecycle

BaseNotificationPlugin - Class in org.exoplatform.commons.api.notification.plugin

BaseNotificationPlugin(InitParams) - Constructor for class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin

BaseObject - Interface in org.exoplatform.commons.api.event.data

Gets information from a JCR node instead of opening a direct access to the javax.jcr.Node object.

BaseUIPlugin - Class in org.exoplatform.commons.api.ui

BaseUIPlugin() - Constructor for class org.exoplatform.commons.api.ui.BaseUIPlugin

body(String) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

BRANDING_PORTAL_NAME - Static variable in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils

broadcastEvent(Event<S, D>) - Method in interface org.exoplatform.commons.api.event.EventManager

Broadcasts an event to a dedicated listener when an action (such as create or update) is triggered.

buildContextPath(Context) - Static method in class org.exoplatform.commons.api.settings.data.Tools

Builds a path of a specified context in the database.

buildDigest(NotificationContext, Writer) - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder

Makes digest message

buildDigest(NotificationContext, Writer) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin

Makes digest message

buildFullPath(Context, Scope, String) - Static method in class org.exoplatform.commons.api.settings.data.Tools

Builds a path of a specified setting property stored in the database.

buildMessage(NotificationContext) - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder

Makes massage

buildMessage(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin

Makes massage

buildMessage(NotificationContext, Map<PluginKey, List<NotificationInfo>>, UserSetting) - Method in interface org.exoplatform.commons.api.notification.service.template.DigestorService

Builds information of a message from a list of notification messages.

buildNotification(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin

Makes notification

buildScopePath(Context, Scope) - Static method in class org.exoplatform.commons.api.settings.data.Tools

Builds a path of a specified scope in the database.

C

CHANNEL_ID_KEY - Static variable in class org.exoplatform.commons.api.notification.channel.template.TemplateProvider

ChannelConfig - Annotation Type in org.exoplatform.commons.api.notification.annotation

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 12, 2014

ChannelKey - Class in org.exoplatform.commons.api.notification.model

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 14, 2014

ChannelKey(AbstractChannel) - Constructor for class org.exoplatform.commons.api.notification.model.ChannelKey

ChannelKey(String) - Constructor for class org.exoplatform.commons.api.notification.model.ChannelKey

channelKey(ChannelKey) - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext

ChannelManager - Interface in org.exoplatform.commons.api.notification.channel

clear() - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Clear all of filter optional

clear() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Reset all statistics

clone() - Method in class org.exoplatform.commons.api.notification.model.ArgumentLiteral

clone() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

clone(boolean) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

clone() - Method in class org.exoplatform.commons.api.notification.model.UserSetting

clone() - Method in interface org.exoplatform.commons.api.notification.NotificationContext

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

collection - Variable in class org.exoplatform.commons.api.indexing.data.SearchEntryId

compare(Object, Object) - Method in class org.exoplatform.commons.api.notification.model.OrderComparatorASC

config(PluginConfig) - Method in interface org.exoplatform.commons.api.notification.template.Element

Sets the template configure for the element

content - Variable in class org.exoplatform.commons.api.indexing.data.SearchEntry

Context - Class in org.exoplatform.commons.api.settings.data

Saves some settings linked to a Context.

Context(String, String) - Constructor for class org.exoplatform.commons.api.settings.data.Context

context - Variable in class org.exoplatform.commons.api.settings.data.SettingContext

Context of the setting object.

ContextPath - Variable in class org.exoplatform.commons.api.settings.data.SettingContext

Path of the context in JCR.

count() - Method in interface org.exoplatform.commons.api.persistence.GenericDAO

Get the number of entities with the specified type and id from the datasource.

countContextsByType(String) - Method in interface org.exoplatform.commons.api.settings.SettingService

Returns the total count of contexts by type

create(Event<S, D>) - Method in interface org.exoplatform.commons.api.event.EventListener

Processes a dedicated work when the create event is triggered.

create(E) - Method in interface org.exoplatform.commons.api.persistence.GenericDAO

Insert a new entity.

create() - Method in enum org.exoplatform.commons.api.search.data.SearchContext.RouterParams

Create qualified name

create(String) - Static method in class org.exoplatform.commons.api.settings.SettingValue

Creates a setting value object of the String type.

create(Long) - Static method in class org.exoplatform.commons.api.settings.SettingValue

Creates a setting value object of the Long type.

create(Double) - Static method in class org.exoplatform.commons.api.settings.SettingValue

Creates a setting value object of the Double type.

create(Boolean) - Static method in class org.exoplatform.commons.api.settings.SettingValue

Creates a setting value object of the Boolean type.

createAll(List<E>) - Method in interface org.exoplatform.commons.api.persistence.GenericDAO

Insert a list of new entities in the persistence context.

createDigestCount(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector

Callback about a digest message being created.

createMessageInfoCount(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector

Callback about a message info being created.

createNotificationInfoCount(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector

Callback about a notification info being created.

D

DataInitializer - Interface in org.exoplatform.commons.api.persistence

Interface for data initialization

DATE_INDEXED - Static variable in class org.exoplatform.commons.api.indexing.IndexingService

DEFAULT_SRC_RESOURCE_BUNDLE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

DEFAULT_SRC_RESOURCE_BUNDLE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

DEFAULT_SRC_RESOURCE_TEMPLATE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

defaultGroupIds - Static variable in class org.exoplatform.commons.api.notification.model.GroupProvider

DefaultLifecycle - Class in org.exoplatform.commons.api.notification.lifecycle

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Jan 19, 2015

DefaultLifecycle() - Constructor for class org.exoplatform.commons.api.notification.lifecycle.DefaultLifecycle

delete(SearchEntryId) - Method in class org.exoplatform.commons.api.indexing.IndexingService

Deletes a search entry by its Id.

delete(E) - Method in interface org.exoplatform.commons.api.persistence.GenericDAO

Delete the specified entity from the persistence context.

deleteAll(List<E>) - Method in interface org.exoplatform.commons.api.persistence.GenericDAO

Remove all of the specified entities from the persistence context.

deleteAll() - Method in interface org.exoplatform.commons.api.persistence.GenericDAO

Remove all of the entities from the persistence context.

deleteEntity(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector

Callback about a entity being deleted

digest(NotificationContext) - Method in interface org.exoplatform.commons.api.notification.service.storage.NotificationService

Collects information of a digest message and sends it daily or weekly.

DIGEST_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

DIGEST_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

DIGEST_MORE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

DIGEST_MORE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

DIGEST_ONE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

DIGEST_ONE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

DIGEST_THREE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

DIGEST_THREE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

DigestorService - Interface in org.exoplatform.commons.api.notification.service.template

digestType(int) - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext

dispatch(NotificationContext, String) - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel

Process the notification information for the specified user.

dispatch(NotificationInfo) - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel

Process the notification info

doClose(Session, CloseReason) - Method in class org.exoplatform.commons.api.websocket.AbstractEndpoint

doError(Session, Throwable) - Method in class org.exoplatform.commons.api.websocket.AbstractEndpoint

doMessage(Session, String) - Method in class org.exoplatform.commons.api.websocket.AbstractEndpoint

doMessage(Session, String, boolean) - Method in class org.exoplatform.commons.api.websocket.AbstractEndpoint

doModifyHandshake(ServerEndpointConfig, HandshakeRequest, HandshakeResponse) - Method in class org.exoplatform.commons.api.websocket.AbstractConfigurator

doOpen(Session, EndpointConfig) - Method in class org.exoplatform.commons.api.websocket.AbstractEndpoint

doView(RenderRequest, RenderResponse) - Method in class org.exoplatform.commons.api.portlet.GenericDispatchedViewPortlet

E

Element - Interface in org.exoplatform.commons.api.notification.template

ElementVisitor - Interface in org.exoplatform.commons.api.notification.template

EMAIL_CHANNEL - Static variable in class org.exoplatform.commons.api.notification.model.UserSetting

enable(boolean) - Method in interface org.exoplatform.commons.api.notification.service.QueueMessage

Enable/Disable sending mail message

end() - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel

end() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

Finishes to assign states to current MessageInfo instance

end() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

end() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

end(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin

End the plug in

end() - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext

ENTITIES_IDX_PATH - Static variable in class org.exoplatform.commons.api.persistence.ExoEntityProcessor

Path to the generated entities.idx file

EntityStatistics - Interface in org.exoplatform.commons.api.notification.stat

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Oct 10, 2013

equals(Object) - Method in class org.exoplatform.commons.api.notification.model.ArgumentLiteral

equals(Object) - Method in class org.exoplatform.commons.api.notification.model.ChannelKey

equals(Object) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

equals(Object) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

equals(Object) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

equals(Object) - Method in class org.exoplatform.commons.api.notification.model.PluginKey

equals(Object) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

equals(Object) - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig

equals(Object) - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

equals(Object) - Method in class org.exoplatform.commons.api.settings.data.Context

equals(Object) - Method in class org.exoplatform.commons.api.settings.data.Scope

equals(Object) - Method in class org.exoplatform.commons.api.settings.data.SettingContext

Compares a specified object with the SettingContext for equality.

equals(Object) - Method in class org.exoplatform.commons.api.settings.data.SettingKey

Compares a specified object with the SettingKey for equality.

equals(Object) - Method in class org.exoplatform.commons.api.settings.data.SettingScope

Compares a specified object with the SettingScope for equality.

EventListener<S,D> - Interface in org.exoplatform.commons.api.event

Processes all the dedicated works which are delegated from EventManager.

EventManager<S,D> - Interface in org.exoplatform.commons.api.event

Is the central point of the event system where listeners are registered (and/or unregistered) and events are fired.

EventType - Enum in org.exoplatform.commons.api.settings.data

All possible value types of an event.

execute(NotificationContext) - Method in interface org.exoplatform.commons.api.notification.command.NotificationExecutor

executed(long, long) - Method in interface org.exoplatform.commons.api.notification.stat.QueryStatistics

ExoEntity - Annotation Type in org.exoplatform.commons.api.persistence

Describe a class as a JPA entity managed by eXo Platform

ExoEntityProcessor - Class in org.exoplatform.commons.api.persistence

At compile time, every time a Maven module that uses @ExoEntity is compiled, the ExoEntityProcessor is invoked.

ExoEntityProcessor() - Constructor for class org.exoplatform.commons.api.persistence.ExoEntityProcessor

ExoFeatureService - Interface in org.exoplatform.commons.api.settings

ExoTransactional - Annotation Type in org.exoplatform.commons.api.persistence

Describe a method as transactional.

ExtensibleFilterChain(List<WSFilterDefinition>, AbstractEndpoint) - Constructor for class org.exoplatform.commons.api.websocket.ExtensibleWSFilter.ExtensibleFilterChain

ExtensibleWSFilter - Class in org.exoplatform.commons.api.websocket

ExtensibleWSFilter() - Constructor for class org.exoplatform.commons.api.websocket.ExtensibleWSFilter

ExtensibleWSFilter.ExtensibleFilterChain - Class in org.exoplatform.commons.api.websocket

F

File - Interface in org.exoplatform.commons.api.event.data

An abstract representation of file.

FilterDefinitionPlugin - Class in org.exoplatform.commons.api.websocket

FilterDefinitionPlugin(InitParams) - Constructor for class org.exoplatform.commons.api.websocket.FilterDefinitionPlugin

find(ID) - Method in interface org.exoplatform.commons.api.persistence.GenericDAO

Return an entity which is associated with specified id.

findAll() - Method in interface org.exoplatform.commons.api.persistence.GenericDAO

Get a list of all object of the specified type from the datasource.

footer(String) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

FOOTER_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

FOOTER_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

FOR_ALL_USER - Static variable in class org.exoplatform.commons.api.notification.model.NotificationInfo

from(String) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

from(String) - Method in interface org.exoplatform.commons.api.notification.template.TemplateTransformer

The template what needs to transform to Value

G

GenericDAO<E,ID extends Serializable> - Interface in org.exoplatform.commons.api.persistence

GenericDispatchedViewPortlet - Class in org.exoplatform.commons.api.portlet

This is a generic and simple Portlet class that dispatches the view to a JSP/HTML file.

GenericDispatchedViewPortlet() - Constructor for class org.exoplatform.commons.api.portlet.GenericDispatchedViewPortlet

get(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService

Gets the notification settings of a user by his remote Id.

get(WebNotificationFilter, int, int) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage

Gets the notification list by the given filter.

get(String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage

Gets the notification by the Id

get(WebNotificationFilter, int, int) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService

Gets the notification list by the given filter.

get(Context, Scope, String) - Method in interface org.exoplatform.commons.api.settings.SettingService

Gets values associated with a specified composite key (context, scope, key) in the database.

getActionUrl() - Method in class org.exoplatform.commons.api.ui.RenderContext

getActivePluginIds(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService

Gets all Ids of active plugins by channel.

getActivePlugins(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService

Gets information of all active plugins by channel.

getAllChannelActive() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

getAllChannelPlugins() - Method in class org.exoplatform.commons.api.notification.model.UserSetting

getAllPlugins() - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService

Gets information of all plugins.

getArrayOwnerParameter() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

getBody() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

getBrandingPortalName() - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils

Get branding Portal Name

getBundlePath() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

getBundlePath() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

getBundlePath() - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

getByUser(NotificationContext, UserSetting) - Method in interface org.exoplatform.commons.api.notification.service.storage.MailNotificationStorage

Gets information of all notifications of a user.

getChannel(ChannelKey) - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager

Gets the channel by the specified key

getChannel() - Method in class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle

Gets the channel

getChannelActives() - Method in class org.exoplatform.commons.api.notification.model.UserSetting

getChannelKey() - Method in class org.exoplatform.commons.api.notification.channel.template.TemplateProvider

Gets channelId

getChannelKey() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

Gets the channel key of the notification

getChannelKey() - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext

getChannelManager() - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Gets the channel manager what contains all channel on Notification

getChannels() - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager

Gets list of the channels

getChildPluginKeys(PluginKey) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginContainer

Gets all children plugin keys in plugin

getCollection() - Method in class org.exoplatform.commons.api.indexing.data.SearchEntryId

Get collection

getConnectors() - Method in class org.exoplatform.commons.api.search.SearchService

Gets all current connectors.

getContent() - Method in class org.exoplatform.commons.api.indexing.data.SearchEntry

Get content

getContext() - Method in class org.exoplatform.commons.api.settings.data.SettingContext

Gets a context object associated with the SettingContext object.

getContextNamesByType(String, int, int) - Method in interface org.exoplatform.commons.api.settings.SettingService

Returns context names by type

getContextPath() - Method in class org.exoplatform.commons.api.settings.data.SettingContext

Gets path of the SettingContext object.

getContextsByTypeAndScopeAndSettingName(String, String, String, String, int, int) - Method in interface org.exoplatform.commons.api.settings.SettingService

Gets a list of names of contexts of a chosen type that have a setting associated to a dedicated scope

getCreatedDate() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Gets the created date of the BaseObject.

getCreateDigestCount() - Method in interface org.exoplatform.commons.api.notification.stat.PluginStatistics

getCreatedTime() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

Gets time to create MessageInfo and use it as node name

getCreateMessageInfoCount() - Method in interface org.exoplatform.commons.api.notification.stat.PluginStatistics

getCreateNotificationInfoCount() - Method in interface org.exoplatform.commons.api.notification.stat.PluginStatistics

getCreationAuthor() - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Get creation author

getCreationDate() - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Get creation date

getCurrentRepositoryName() - Static method in class org.exoplatform.commons.api.settings.data.SettingContext

Gets the current repository name.

getDailyPlugins() - Method in class org.exoplatform.commons.api.notification.model.UserSetting

getData() - Method in interface org.exoplatform.commons.api.event.data.File

Gets the binary data of the File instance.

getData() - Method in class org.exoplatform.commons.api.ui.Response

getDate() - Method in class org.exoplatform.commons.api.search.data.SearchResult

Get date of result

getDateCreated() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

getDCContributor() - Method in interface org.exoplatform.commons.api.event.data.File

Gets the contributor of the File instance.

getDCCreator() - Method in interface org.exoplatform.commons.api.event.data.File

Gets the creator of the File instance.

getDCDate() - Method in interface org.exoplatform.commons.api.event.data.File

Gets the last updated date of the File instance.

getDCDescription() - Method in interface org.exoplatform.commons.api.event.data.File

Gets the description of the File instance.

getDCPublisher() - Method in interface org.exoplatform.commons.api.event.data.File

Gets the publisher of the File instance.

getDCSubject() - Method in interface org.exoplatform.commons.api.event.data.File

Gets the subject of the File instance.

getDefaultActivePlugins() - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginContainer

getDefaultConfig() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

getDefaultConfig() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

getDefaultInstance() - Static method in class org.exoplatform.commons.api.notification.model.UserSetting

getDeleteCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics

getDetail() - Method in class org.exoplatform.commons.api.search.data.SearchResult

Get detail of result

getDigestCreatedCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Get global number of entity insert

getDigestDefaultSettingForAllUser(int, int) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService

Gets all settings of users registering for default daily notifications.

getDigestSettingForAllUser(NotificationContext, int, int) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService

Gets the list of user settings which has at least the plug-in to be configured by weekly or daily.

getDigestSize() - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext

getDisplayName() - Method in class org.exoplatform.commons.api.search.SearchServiceConnector

Gets a display name.

getEmailFrom() - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils

getEmptyContextsByTypeAndScopeAndSettingName(String, String, String, String, int, int) - Method in interface org.exoplatform.commons.api.settings.SettingService

Gets a list of names of contexts of a chosen type that doesn't have settings associated to a dedicated scope

getEncoding() - Method in interface org.exoplatform.commons.api.event.data.File

Gets the encoding type of the File instance.

getEntityDeleteCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Get global number of entity deletes

getEntityInsertCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Get global number of entity insert

getEntityLoadCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Get global number of entity load

getEntityStatistics(String) - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Gets EntityStatistics by nodeType

getEventListeners(String) - Method in interface org.exoplatform.commons.api.event.EventManager

Gets a list of listeners which are registered into the event system based on a given event group.

getEventType() - Method in class org.exoplatform.commons.api.settings.data.SettingData

Gets an event type associated with the setting data.

getException() - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Gets the exception if have any when the done processing

getException(Class<T>) - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Gets the exception if have any when the done processing

getException() - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext

getExcerpt() - Method in class org.exoplatform.commons.api.indexing.data.SimpleEntry

Get excerpt

getExcerpt() - Method in class org.exoplatform.commons.api.search.data.SearchResult

Get excerpt of result

getExecutionAvgTime() - Method in interface org.exoplatform.commons.api.notification.stat.QueryStatistics

getExecutionCount() - Method in interface org.exoplatform.commons.api.notification.stat.QueryStatistics

getExecutionMaxTime() - Method in interface org.exoplatform.commons.api.notification.stat.QueryStatistics

getExecutionMinTime() - Method in interface org.exoplatform.commons.api.notification.stat.QueryStatistics

getExecutionRowCount() - Method in interface org.exoplatform.commons.api.notification.stat.QueryStatistics

getFilter() - Method in class org.exoplatform.commons.api.websocket.WSFilterDefinition

getFilterDefinitions() - Method in class org.exoplatform.commons.api.websocket.FilterDefinitionPlugin

getFirstName(String) - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils

getFooter() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

getFrequecy(String) - Static method in enum org.exoplatform.commons.api.notification.model.UserSetting.FREQUENCY

getFrom() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

getFrom() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

getFrom(String) - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils

getFullName(String) - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils

getGroupConfig() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

getGroupId() - Method in class org.exoplatform.commons.api.notification.model.GroupProvider

getGroupId() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

getGroupPlugins() - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService

Gets a list of groups containing plugins.

getGroupProviders() - Method in class org.exoplatform.commons.api.notification.plugin.GroupProviderPlugin

getId() - Method in class org.exoplatform.commons.api.indexing.data.SearchEntry

Get entry id

getId() - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel

Gets ChannelId

getId() - Method in class org.exoplatform.commons.api.notification.model.ChannelKey

getId() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

Gets the uuid of messageInfo node

getId() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

getId() - Method in class org.exoplatform.commons.api.notification.model.PluginKey

getId() - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin

Gets Notification Plug in key

getId() - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig

getId() - Method in class org.exoplatform.commons.api.settings.data.Context

Gets a context Id.

getId() - Method in class org.exoplatform.commons.api.settings.data.Scope

getImageUrl() - Method in class org.exoplatform.commons.api.search.data.SearchResult

Get image url of avatar

getInsertCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics

getInstance() - Static method in class org.exoplatform.commons.api.notification.model.UserSetting

getKey() - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel

Gets Channel Key

getKey() - Method in class org.exoplatform.commons.api.notification.model.ArgumentLiteral

getKey() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

getKey() - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin

Creates the key for NotificationPlugin

getKey() - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin

Creates the key for NotificationPlugin

getKey() - Method in class org.exoplatform.commons.api.settings.data.SettingKey

Gets a key value of the SettingKey object.

getKeyMapping() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

getKeyMapping() - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

getKeyValue(String, String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

getKeyValue(String, String) - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

getLanguage(NotificationInfo) - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder

getLanguage(NotificationInfo) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin

getLanguage(NotificationInfo) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin

getLanguage(String) - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils

getLanguage() - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext

getLanguage() - Method in interface org.exoplatform.commons.api.notification.template.Element

Gets the language what belongs to the template

getLastModified() - Method in interface org.exoplatform.commons.api.event.data.File

Gets the last modified date of the File instance.

getLastModifiedDate() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Gets the last modified date of the BaseObject.

getLastModifiedDate() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

Get the last modified date

getLastModifier() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Gets name of the user who did the last modification on the BaseObject.

getLastReadDate() - Method in class org.exoplatform.commons.api.notification.model.UserSetting

Get the last read date

getLastUpdateAuthor() - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Get last update author

getLastUpdateDate() - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Get last update date

getLastUpdateTime() - Method in class org.exoplatform.commons.api.notification.model.UserSetting

getLifecycle() - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel

Gets the lifecycle what assigned to the channel

getLifecycle(ChannelKey) - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager

Gets the lifecycle by the ChannelKey

getLimitDay() - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter

getLoadCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics

getMaxItemsInPopover() - Static method in class org.exoplatform.commons.api.notification.NotificationMessageUtils

Gets the number of notifications that are displayed in the popover list.
The first time this method is called, it will retrieve it from the configuration, via the property exo.notification.maxitems, or default to 8 if the property is not set.
If the property is set to an incorrect value (negative number, 0, not a number), the default value is used too.

getMessageCreatedCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Get global number of entity deletes

getMimeType() - Method in interface org.exoplatform.commons.api.event.data.File

Gets the MIMETYPE of the File instance.

getMimeType() - Method in class org.exoplatform.commons.api.ui.Response

getMixinTypes() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Gets a list of node type names which are added to the BaseObject as mixin.

getName() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Gets name of an object.

getName() - Method in class org.exoplatform.commons.api.indexing.data.SearchEntryId

Get name

getName() - Method in class org.exoplatform.commons.api.settings.data.Context

getName() - Method in class org.exoplatform.commons.api.settings.data.Scope

getName() - Method in class org.exoplatform.commons.api.ui.ActionContext

getNotificationCreatedCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Get global number of entity load

getNotificationExecutor() - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Gets the NotificationExceutor service

getNotificationInfo() - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Gets notification information

getNotificationInfos() - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Gets notification message list

getNotificationInfos(WebNotificationFilter, int, int) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService

Gets the NotificationInfo list by the given filter.

getNotificationKey() - Method in interface org.exoplatform.commons.api.notification.command.NotificationCommand

Gets a notification key associated with the notification command.

getNotificationToStore(NotificationInfo) - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder

getNumberOnBadge() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

Gets the badge number of the user

getNumberOnBadge(String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage

Gets the number on the badge by the specified user

getNumberOnBadge(String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService

Gets the number on the badge by the specified user

getOrder() - Method in class org.exoplatform.commons.api.notification.model.GroupProvider

getOrder() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

getOrder() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

getOrder() - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig

getOrder() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

getOrganizationService() - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder

getOrganizationService() - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin

getOrganizationService() - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin

getOrganizationService() - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils

getOwner() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Gets name of the user who created the BaseObject.

getOwnerParameter() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

getParameter() - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter

getParams() - Method in class org.exoplatform.commons.api.ui.BaseContext

getParamValue(QualifiedName) - Method in class org.exoplatform.commons.api.search.data.SearchContext

getParentPluginIds() - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin

Gets the parents's id

getPath() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Gets the absolute path of the BaseObject.

getPlugin() - Method in interface org.exoplatform.commons.api.notification.command.NotificationCommand

Gets a plugin associated with the notification command.

getPlugin(PluginKey) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginContainer

Gets plugin by NotificationKey

getPluginConfig(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService

Gets configuration of a plugin from its Id.

getPluginConfig() - Method in interface org.exoplatform.commons.api.notification.template.Element

Gets template configure for the element uses it in the case when we need to get the groovy template.

getPluginConfigs() - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin

getPluginContainer() - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Gets the plugin container what contains all plugins on Notification

getPluginId() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

getPluginId() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

getPluginId() - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext

getPluginInfos() - Method in class org.exoplatform.commons.api.notification.model.GroupProvider

getPluginKey() - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter

getPluginNames() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Get the names of all entities

getPlugins(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

getPlugins(String) - Method in interface org.exoplatform.commons.api.ui.PlugableUIService

getPlugins(String) - Method in class org.exoplatform.commons.api.ui.PlugableUIServiceImpl

getPluginSettingService() - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Gets the PluginSettingService service

getPluginStatistics(String) - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Gets PluginStatistics by Id

getPluginType() - Method in class org.exoplatform.commons.api.ui.BaseContext

getPollCount() - Method in interface org.exoplatform.commons.api.notification.stat.QueueStatistics

getPortalName() - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils

getPreviewUrl() - Method in class org.exoplatform.commons.api.search.data.SearchResult

Get preview url of result

getPrimaryType() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Gets the primary type of the BaseObject.

getProviderId() - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

getProviders() - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig

getPutCount() - Method in interface org.exoplatform.commons.api.notification.stat.QueueStatistics

getQueries() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Get all executed query strings

getQueryExecutionCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Get global number of executed queries

getQueryExecutionMaxTime() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Get the time in milliseconds of the slowest query.

getQueryExecutionMaxTimeQueryString() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Get the query string for the slowest query.

getQueryStatistics(String) - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Gets QueryStatistics by queryString

getQueuePollCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Get global number of poll queue

getQueuePutCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Get global number of put queue

getQueueStatistics(String) - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Gets QueueStatistics by Id

getRating() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Gets the rating value for the BaseObject.

getRelevancy() - Method in class org.exoplatform.commons.api.search.data.SearchResult

Get relevancy of result

getRepositoryName() - Method in class org.exoplatform.commons.api.settings.data.SettingContext

Gets a repository name associated with the SettingContext object.

getResourceBundleKey() - Method in class org.exoplatform.commons.api.notification.model.GroupProvider

getResourceBundleKey() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

getResourceBundleKey() - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig

getResourceBundleKey() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

getRouter() - Method in class org.exoplatform.commons.api.search.data.SearchContext

Get router

getRsBundle() - Method in class org.exoplatform.commons.api.ui.RenderContext

getScope() - Method in class org.exoplatform.commons.api.settings.data.SettingScope

Gets a scope value of the SettingScope object.

getScopePath() - Method in class org.exoplatform.commons.api.settings.data.SettingScope

Gets a path to the SettingScope object.

getSearchType() - Method in class org.exoplatform.commons.api.search.SearchServiceConnector

Gets a search type.

getSenderName() - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils

getSendToDaily() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

getSendToUserIds() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

getSendToWeekly() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

getSettingContext() - Method in class org.exoplatform.commons.api.settings.data.SettingData

Gets a setting context associated with the setting data.

getSettingsByContext(Context) - Method in interface org.exoplatform.commons.api.settings.SettingService

Get settings related to a scope and a context

getSettingsByContextAndScope(String, String, String, String) - Method in interface org.exoplatform.commons.api.settings.SettingService

Get a list of settings that belongs to the context and scope

getSettingService() - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils

getSettingValue() - Method in class org.exoplatform.commons.api.settings.data.SettingData

Gets a setting value of setting property associated with the setting data.

getSiteName() - Method in class org.exoplatform.commons.api.search.data.SearchContext

Get site name, e.g.

getSiteType() - Method in class org.exoplatform.commons.api.search.data.SearchContext

Get site type

getStartTime() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Gets the start time of statistics process

getSubject() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

getTags() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Gets a list of tag names which are added to the BaseObject.

getTemplate() - Method in interface org.exoplatform.commons.api.notification.template.Element

Gets the template of specified element

getTemplateBuilder(PluginKey) - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel

Gets the template builder by the specified PluginKey

getTemplateBuilder() - Method in class org.exoplatform.commons.api.notification.channel.template.TemplateProvider

Gets all of the template builder what assigned the channel

getTemplateBuilderInChannel(PluginKey) - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel

getTemplateConfig() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

getTemplateContext() - Method in interface org.exoplatform.commons.api.notification.template.ElementVisitor

Gets the template context

getTemplateEngine() - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder

Get TemplateEngine of plugin

getTemplateEngine() - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin

Get TemplateEngine of plugin

getTemplateEngine() - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin

Get TemplateEngine of plugin

getTemplateFilePath(PluginKey) - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel

Gets the template by the specified pluginId

getTemplateFilePathConfigs() - Method in class org.exoplatform.commons.api.notification.channel.template.TemplateProvider

Gets all of the template files

getTemplatePath() - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin

getTemplatePath() - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

getTitle() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Gets title of the BaseObject.

getTitle() - Method in class org.exoplatform.commons.api.indexing.data.SimpleEntry

Get title

getTitle() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

Gets the title of the notification

getTitle() - Method in class org.exoplatform.commons.api.search.data.SearchResult

Get title of result

getTo() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

getTo() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

getTo(String) - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils

getType() - Method in class org.exoplatform.commons.api.indexing.data.SearchEntryId

Get type

getType() - Method in class org.exoplatform.commons.api.notification.model.ArgumentLiteral

getType() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

getType() - Method in class org.exoplatform.commons.api.ui.BaseUIPlugin

getUnreadNotification(String, String, String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage

Gets the notification by the given conditions

getUpdateCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics

getUrl() - Method in class org.exoplatform.commons.api.indexing.data.SimpleEntry

Get URL

getUrl() - Method in class org.exoplatform.commons.api.search.data.SearchResult

Get url of result

getUserId() - Method in class org.exoplatform.commons.api.notification.model.UserSetting

getUserId() - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter

getUUID() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Gets the UUID value of the BaseObject.

getValue() - Method in class org.exoplatform.commons.api.settings.SettingValue

Gets the value of the setting object.

getValueOwnerParameter(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

getWeeklyPlugins() - Method in class org.exoplatform.commons.api.notification.model.UserSetting

getWorkspace() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Gets the workspace name where the BaseObject is stored.

getWriter() - Method in interface org.exoplatform.commons.api.notification.template.ElementVisitor

Gets the writer.

GLOBAL - Static variable in class org.exoplatform.commons.api.settings.data.Context

GLOBAL: Settings should impact all users in the underlying scope.

GLOBAL - Static variable in class org.exoplatform.commons.api.settings.data.Scope

Settings of the whole eXo Platform (all sites and portals).

GroupConfig - Class in org.exoplatform.commons.api.notification.plugin.config

GroupConfig() - Constructor for class org.exoplatform.commons.api.notification.plugin.config.GroupConfig

GroupProvider - Class in org.exoplatform.commons.api.notification.model

GroupProvider(String) - Constructor for class org.exoplatform.commons.api.notification.model.GroupProvider

GroupProviderPlugin - Class in org.exoplatform.commons.api.notification.plugin

GroupProviderPlugin(InitParams) - Constructor for class org.exoplatform.commons.api.notification.plugin.GroupProviderPlugin

H

handler(String) - Method in class org.exoplatform.commons.api.search.data.SearchContext

Puts Handler value into QualifiedName map

hashCode() - Method in class org.exoplatform.commons.api.notification.model.ArgumentLiteral

hashCode() - Method in class org.exoplatform.commons.api.notification.model.ChannelKey

hashCode() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

hashCode() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

hashCode() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

hashCode() - Method in class org.exoplatform.commons.api.notification.model.PluginKey

hashCode() - Method in class org.exoplatform.commons.api.notification.model.UserSetting

hashCode() - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig

hashCode() - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

hashCode() - Method in class org.exoplatform.commons.api.settings.data.Context

hashCode() - Method in class org.exoplatform.commons.api.settings.data.Scope

hashCode() - Method in class org.exoplatform.commons.api.settings.data.SettingContext

Returns the hash code value for the SettingContext object.

hashCode() - Method in class org.exoplatform.commons.api.settings.data.SettingKey

Returns the hash code value for the SettingKey object.

hashCode() - Method in class org.exoplatform.commons.api.settings.data.SettingScope

Returns the hash code value for the SettingScope object.

hasTemplateBuilder(PluginKey) - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel

Has the template builder of the plugin and the channel

hidePopover(String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage

Updates the notification's popover status to be FALSE value However it's still showing on View All page.

hidePopover(String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService

Updates the notification's popover list status to be FALSE value However it's still showing on View All page.

HTTP_HEADERS - Static variable in class org.exoplatform.commons.api.websocket.AbstractConfigurator

I

id - Variable in class org.exoplatform.commons.api.indexing.data.SearchEntry

id(String) - Method in class org.exoplatform.commons.api.settings.data.Context

Creates a context with a specified Id.

id(String) - Method in class org.exoplatform.commons.api.settings.data.Scope

incrementCreateDigestCount() - Method in interface org.exoplatform.commons.api.notification.stat.PluginStatistics

incrementCreateMessageCount() - Method in interface org.exoplatform.commons.api.notification.stat.PluginStatistics

incrementCreateNotificationCount() - Method in interface org.exoplatform.commons.api.notification.stat.PluginStatistics

incrementDeleteCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics

incrementInsertCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics

incrementLoadCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics

incrementPollCount() - Method in interface org.exoplatform.commons.api.notification.stat.QueueStatistics

incrementPutCount() - Method in interface org.exoplatform.commons.api.notification.stat.QueueStatistics

incrementUpdateCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics

IndexingService - Class in org.exoplatform.commons.api.indexing

Provides the indexing API that a connector implements to index its data.

IndexingService() - Constructor for class org.exoplatform.commons.api.indexing.IndexingService

init(PortletConfig) - Method in class org.exoplatform.commons.api.portlet.GenericDispatchedViewPortlet

initData() - Method in interface org.exoplatform.commons.api.persistence.DataInitializer

initData(String) - Method in interface org.exoplatform.commons.api.persistence.DataInitializer

initDefaultSettings(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService

Adds the default settings to a user's node.

initDefaultSettings(User[]) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService

Adds the default settings to a list of users.

insertEntity(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector

Callback about a entity being inserted

instance() - Static method in class org.exoplatform.commons.api.notification.model.NotificationInfo

isActive(String, String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

Checks the user's setting for the channel and the plugin if it's active, it's instantly including the email channel.

isActive(String, String) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService

Checks if a plugin is active or inactive.

isActive(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService

Deprecated.

user isActive(String channelId, String pluginId);

isActiveFeature(String) - Method in interface org.exoplatform.commons.api.settings.ExoFeatureService

Check the status of a feature

isAsync() - Method in class org.exoplatform.commons.api.notification.service.NotificationCompletionService

isChannelActive(String) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

isChannelActive(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

isChildPlugin() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

isChildPlugin(boolean) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

isEnable() - Method in class org.exoplatform.commons.api.search.SearchServiceConnector

is enable by default

isEnabled() - Method in class org.exoplatform.commons.api.notification.model.UserSetting

isFailed() - Method in interface org.exoplatform.commons.api.notification.NotificationContext

The signal lets you know the processing is successfully or not

isInDaily(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

isInWeekly(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

isMoveTop() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

Gets the the move top value

isNewLine() - Method in interface org.exoplatform.commons.api.notification.template.Element

Get the value of isNewLine

isOldPlugin() - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin

Determines the plugin is old or new mechanism The target adapts the old plugin from PLF 4.1 to work well new mechanism

isOnPopOver() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

isOnPopover() - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter

isOrder() - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter

isRead() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

isRead() - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter

isResetOnBadge() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

isSendAll() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

isStatisticsEnabled() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Are statistics logged

isUpdate() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

isValid(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin

Check, for each plugin, if we will send notification

isWritingProcess() - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Determines the writing processing or NOT

K

key(AbstractChannel) - Static method in class org.exoplatform.commons.api.notification.model.ChannelKey

key(String) - Static method in class org.exoplatform.commons.api.notification.model.ChannelKey

key(PluginKey) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

key(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

key(BaseNotificationPlugin) - Static method in class org.exoplatform.commons.api.notification.model.PluginKey

key(String) - Static method in class org.exoplatform.commons.api.notification.model.PluginKey

L

lang(String) - Method in class org.exoplatform.commons.api.search.data.SearchContext

Puts Lang value into QualifiedName map

language(String) - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext

language(String) - Method in interface org.exoplatform.commons.api.notification.template.Element

Assigns the language to

LAST_UPDATE - Static variable in class org.exoplatform.commons.api.indexing.IndexingService

loadEntity(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector

Callback about a entity being loaded

LOG - Static variable in class org.exoplatform.commons.api.notification.NotificationMessageUtils

M

MailNotificationStorage - Interface in org.exoplatform.commons.api.notification.service.storage

makeCommand(PluginKey) - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Makes the NotificationCommand by the NotificationKey

makeContent(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin

makeDigest(NotificationContext, Writer) - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder

Makes the Digest message from given NotificationMessage what keep inside NotificationContext

makeDigest(NotificationContext, Writer) - Method in class org.exoplatform.commons.api.notification.channel.template.PluginTemplateBuilderAdapter

makeDigest(NotificationContext, Writer) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin

Makes the Digest message from given NotificationMessage what keep inside NotificationContext

makeEmailNotification() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

makeMessage(NotificationContext) - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder

Makes the MessageInfor from given NotificationMessage what keep inside NotificationContext

makeMessage(NotificationContext) - Method in class org.exoplatform.commons.api.notification.channel.template.PluginTemplateBuilderAdapter

makeMessage(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin

Makes the MessageInfor from given NotificationMessage what keep inside NotificationContext

makeNotification() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

makeNotification(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin

makeNotification(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin

Makes MessageInfo from given information what keep inside NotificationContext

markAllRead(String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage

Marks all notifications what belong to the user to be read.

markAllRead(String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService

Marks all notifications what belong to the user to be read.

markRead(String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage

Marks the notification to be read by the userId

markRead(String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService

Marks the notification to be read by the userId

match(String) - Method in class org.exoplatform.commons.api.websocket.WSFilterDefinition

MESSAGE_ADDED_IN_QUEUE - Static variable in interface org.exoplatform.commons.api.notification.service.QueueMessage

MESSAGE_DELETED_FROM_QUEUE - Static variable in interface org.exoplatform.commons.api.notification.service.QueueMessage

MESSAGE_SENT_FROM_QUEUE - Static variable in interface org.exoplatform.commons.api.notification.service.QueueMessage

MessageInfo - Class in org.exoplatform.commons.api.notification.model

MessageInfo() - Constructor for class org.exoplatform.commons.api.notification.model.MessageInfo

modifyHandshake(ServerEndpointConfig, HandshakeRequest, HandshakeResponse) - Method in class org.exoplatform.commons.api.websocket.AbstractConfigurator

N

name - Variable in class org.exoplatform.commons.api.indexing.data.SearchEntryId

newChannelInstance(ChannelKey, String, String) - Static method in class org.exoplatform.commons.api.notification.service.template.TemplateContext

NOT_HIGHLIGHT_COMMENT_PORPERTY - Static variable in class org.exoplatform.commons.api.notification.NotificationMessageUtils

NOTIFICATION_SENDER_EMAIL - Static variable in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils

NOTIFICATION_SENDER_NAME - Static variable in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils

NotificationCommand - Interface in org.exoplatform.commons.api.notification.command

NotificationCompletionService - Class in org.exoplatform.commons.api.notification.service

NotificationCompletionService(InitParams) - Constructor for class org.exoplatform.commons.api.notification.service.NotificationCompletionService

NotificationContext - Interface in org.exoplatform.commons.api.notification

NotificationExecutor - Interface in org.exoplatform.commons.api.notification.command

NotificationInfo - Class in org.exoplatform.commons.api.notification.model

NotificationInfo() - Constructor for class org.exoplatform.commons.api.notification.model.NotificationInfo

NotificationMessageUtils - Class in org.exoplatform.commons.api.notification

Created by The eXo Platform SAS Author : eXoPlatform exo@exoplatform.com Dec 30, 2014

NotificationMessageUtils() - Constructor for class org.exoplatform.commons.api.notification.NotificationMessageUtils

NotificationPluginUtils - Class in org.exoplatform.commons.api.notification.plugin

NotificationPluginUtils() - Constructor for class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils

NotificationService - Interface in org.exoplatform.commons.api.notification.service.storage

O

onClose(Session, CloseReason) - Method in class org.exoplatform.commons.api.websocket.AbstractEndpoint

onClose(Session, CloseReason) - Method in class org.exoplatform.commons.api.websocket.ExtensibleWSFilter.ExtensibleFilterChain

onClose(Session, CloseReason, AbstractEndpoint) - Method in class org.exoplatform.commons.api.websocket.ExtensibleWSFilter

onClose(Session, CloseReason, ExtensibleWSFilter.ExtensibleFilterChain) - Method in interface org.exoplatform.commons.api.websocket.WSFilter

onError(Session, Throwable) - Method in class org.exoplatform.commons.api.websocket.AbstractEndpoint

onError(Session, Throwable) - Method in class org.exoplatform.commons.api.websocket.ExtensibleWSFilter.ExtensibleFilterChain

onError(Session, Throwable, AbstractEndpoint) - Method in class org.exoplatform.commons.api.websocket.ExtensibleWSFilter

onError(Session, Throwable, ExtensibleWSFilter.ExtensibleFilterChain) - Method in interface org.exoplatform.commons.api.websocket.WSFilter

onEvent(Event<SettingService, SettingData>) - Method in class org.exoplatform.commons.api.settings.SettingListener

Calls back a function when the setting service dispatches an event.

onMessage(String) - Method in class org.exoplatform.commons.api.websocket.AbstractEndpoint

onMessage(String, boolean) - Method in class org.exoplatform.commons.api.websocket.AbstractEndpoint

onMessage(Session, String, boolean) - Method in class org.exoplatform.commons.api.websocket.ExtensibleWSFilter.ExtensibleFilterChain

onMessage(Session, String) - Method in class org.exoplatform.commons.api.websocket.ExtensibleWSFilter.ExtensibleFilterChain

onMessage(String, AbstractEndpoint) - Method in class org.exoplatform.commons.api.websocket.ExtensibleWSFilter

onMessage(String, boolean, AbstractEndpoint) - Method in class org.exoplatform.commons.api.websocket.ExtensibleWSFilter

onMessage(Session, Object, ExtensibleWSFilter.ExtensibleFilterChain) - Method in interface org.exoplatform.commons.api.websocket.WSFilter

onMessage(Session, Object, boolean, ExtensibleWSFilter.ExtensibleFilterChain) - Method in interface org.exoplatform.commons.api.websocket.WSFilter

onOpen(Session, EndpointConfig) - Method in class org.exoplatform.commons.api.websocket.AbstractEndpoint

onOpen(Session, EndpointConfig) - Method in class org.exoplatform.commons.api.websocket.ExtensibleWSFilter.ExtensibleFilterChain

onOpen(Session, EndpointConfig, AbstractEndpoint) - Method in class org.exoplatform.commons.api.websocket.ExtensibleWSFilter

onOpen(Session, EndpointConfig, ExtensibleWSFilter.ExtensibleFilterChain) - Method in interface org.exoplatform.commons.api.websocket.WSFilter

onRemoveContext(Event<SettingService, SettingData>) - Method in class org.exoplatform.commons.api.settings.SettingListener

Calls back a function when all setting properties in a context are removed.

onRemoveKey(Event<SettingService, SettingData>) - Method in class org.exoplatform.commons.api.settings.SettingListener

Calls back a function when a setting property is removed with a specified composite key (context, scope, key).

onRemoveScope(Event<SettingService, SettingData>) - Method in class org.exoplatform.commons.api.settings.SettingListener

Calls back a function when all setting properties in a scope are removed.

onSet(Event<SettingService, SettingData>) - Method in class org.exoplatform.commons.api.settings.SettingListener

Calls back a function when a new setting property is saved.

OrderComparatorASC - Class in org.exoplatform.commons.api.notification.model

OrderComparatorASC() - Constructor for class org.exoplatform.commons.api.notification.model.OrderComparatorASC

org.exoplatform.commons.api.event - package org.exoplatform.commons.api.event

Provides the API for the event manager system.

org.exoplatform.commons.api.event.data - package org.exoplatform.commons.api.event.data

Provides the API for data type in the event manager system.

org.exoplatform.commons.api.indexing - package org.exoplatform.commons.api.indexing

Provides the API that connectors might implement for indexing business.

org.exoplatform.commons.api.indexing.data - package org.exoplatform.commons.api.indexing.data

Provides the classes that defines pattern structures of data entry.

org.exoplatform.commons.api.notification - package org.exoplatform.commons.api.notification

org.exoplatform.commons.api.notification.annotation - package org.exoplatform.commons.api.notification.annotation

org.exoplatform.commons.api.notification.channel - package org.exoplatform.commons.api.notification.channel

org.exoplatform.commons.api.notification.channel.template - package org.exoplatform.commons.api.notification.channel.template

org.exoplatform.commons.api.notification.command - package org.exoplatform.commons.api.notification.command

org.exoplatform.commons.api.notification.lifecycle - package org.exoplatform.commons.api.notification.lifecycle

org.exoplatform.commons.api.notification.model - package org.exoplatform.commons.api.notification.model

org.exoplatform.commons.api.notification.plugin - package org.exoplatform.commons.api.notification.plugin

org.exoplatform.commons.api.notification.plugin.config - package org.exoplatform.commons.api.notification.plugin.config

org.exoplatform.commons.api.notification.service - package org.exoplatform.commons.api.notification.service

org.exoplatform.commons.api.notification.service.setting - package org.exoplatform.commons.api.notification.service.setting

org.exoplatform.commons.api.notification.service.storage - package org.exoplatform.commons.api.notification.service.storage

org.exoplatform.commons.api.notification.service.template - package org.exoplatform.commons.api.notification.service.template

org.exoplatform.commons.api.notification.stat - package org.exoplatform.commons.api.notification.stat

org.exoplatform.commons.api.notification.template - package org.exoplatform.commons.api.notification.template

org.exoplatform.commons.api.persistence - package org.exoplatform.commons.api.persistence

org.exoplatform.commons.api.portlet - package org.exoplatform.commons.api.portlet

org.exoplatform.commons.api.search - package org.exoplatform.commons.api.search

Provides the API that drivers and connectors might implement for searching business.

org.exoplatform.commons.api.search.data - package org.exoplatform.commons.api.search.data

Provides the classes to create search context and search result.

org.exoplatform.commons.api.settings - package org.exoplatform.commons.api.settings

Provides the API for the Setting service.

org.exoplatform.commons.api.settings.data - package org.exoplatform.commons.api.settings.data

Provides enum types and classes for key specifications in the Setting service.

org.exoplatform.commons.api.ui - package org.exoplatform.commons.api.ui

org.exoplatform.commons.api.websocket - package org.exoplatform.commons.api.websocket

out() - Method in interface org.exoplatform.commons.api.notification.template.ElementVisitor

Gets the content of template after generates.

P

PAGE - Static variable in class org.exoplatform.commons.api.settings.data.Scope

Settings of pages.

path(String) - Method in class org.exoplatform.commons.api.search.data.SearchContext

Puts Path value into QualifiedName map

PlugableUIService - Interface in org.exoplatform.commons.api.ui

PlugableUIServiceImpl - Class in org.exoplatform.commons.api.ui

PlugableUIServiceImpl() - Constructor for class org.exoplatform.commons.api.ui.PlugableUIServiceImpl

PluginConfig - Class in org.exoplatform.commons.api.notification.plugin.config

PluginConfig() - Constructor for class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

PluginContainer - Interface in org.exoplatform.commons.api.notification.service.setting

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Aug 18, 2013

pluginId(String) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

pluginId(String) - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext

PluginInfo - Class in org.exoplatform.commons.api.notification.model

PluginInfo() - Constructor for class org.exoplatform.commons.api.notification.model.PluginInfo

PluginKey - Class in org.exoplatform.commons.api.notification.model

PluginKey(BaseNotificationPlugin) - Constructor for class org.exoplatform.commons.api.notification.model.PluginKey

PluginKey(String) - Constructor for class org.exoplatform.commons.api.notification.model.PluginKey

PluginSettingService - Interface in org.exoplatform.commons.api.notification.service.setting

PluginStatistics - Interface in org.exoplatform.commons.api.notification.stat

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Oct 10, 2013

PluginTemplateBuilderAdapter - Class in org.exoplatform.commons.api.notification.channel.template

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 23, 2014

PluginTemplateBuilderAdapter() - Constructor for class org.exoplatform.commons.api.notification.channel.template.PluginTemplateBuilderAdapter

pollQueue(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector

Callback indicating execution of poll queue

POPUP_OVER - Static variable in interface org.exoplatform.commons.api.notification.service.WebNotificationService

Define the argument parameter for popup over context

PORTAL - Static variable in class org.exoplatform.commons.api.settings.data.Scope

Settings of the entire portal (and all its sites).

PREFIX_ID - Static variable in class org.exoplatform.commons.api.notification.model.NotificationInfo

process(NotificationContext, String...) - Method in class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle

Process the notification for multi-users

process(NotificationContext, String) - Method in class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle

Process the notification for the user

process(NotificationContext, String) - Method in class org.exoplatform.commons.api.notification.lifecycle.BaseNotificationLifecycle

process(NotificationContext, String...) - Method in class org.exoplatform.commons.api.notification.lifecycle.BaseNotificationLifecycle

process(NotificationContext, String) - Method in class org.exoplatform.commons.api.notification.lifecycle.DefaultLifecycle

process(NotificationContext, String...) - Method in class org.exoplatform.commons.api.notification.lifecycle.DefaultLifecycle

process(NotificationInfo) - Method in interface org.exoplatform.commons.api.notification.service.storage.NotificationService

Processes information when a notification message is created.

process(Collection<NotificationInfo>) - Method in interface org.exoplatform.commons.api.notification.service.storage.NotificationService

Processes information when a list of notification messages are created.

process(Set<? extends TypeElement>, RoundEnvironment) - Method in class org.exoplatform.commons.api.persistence.ExoEntityProcessor

processAction(ActionContext) - Method in class org.exoplatform.commons.api.ui.BaseUIPlugin

processAction(ActionContext) - Method in interface org.exoplatform.commons.api.ui.PlugableUIService

processAction(ActionContext) - Method in class org.exoplatform.commons.api.ui.PlugableUIServiceImpl

processNotification(NotificationContext) - Method in interface org.exoplatform.commons.api.notification.command.NotificationCommand

Builds information of a notification from the notification context.

put(MessageInfo) - Method in interface org.exoplatform.commons.api.notification.service.QueueMessage

Puts the message into the queue

putQueue(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector

Callback indicating execution of put queue

Q

queryExecuted(String, long, long) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector

Callback indicating execution of a query statement

QueryStatistics - Interface in org.exoplatform.commons.api.notification.stat

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Oct 10, 2013

QueueMessage - Interface in org.exoplatform.commons.api.notification.service

QueueStatistics - Interface in org.exoplatform.commons.api.notification.stat

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Oct 11, 2013

R

READ_PORPERTY - Static variable in class org.exoplatform.commons.api.notification.NotificationMessageUtils

register(AbstractChannel) - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager

Register new channel

registerGroupConfig(GroupProviderPlugin) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService

Registers the plugin configuration of a group.

registerOverrideTemplateProvider(TemplateProvider) - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager

Register and override the Template provider

registerPluginConfig(PluginConfig) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService

Registers configuration of a plugin.

registerTemplateProvider(TemplateProvider) - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel

Register the template provider to the channel.

registerTemplateProvider(TemplateProvider) - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager

Register the Template provider

remove(Event<S, D>) - Method in interface org.exoplatform.commons.api.event.EventListener

Processes a dedicated work when the remove event is triggered.

remove(ArgumentLiteral<T>) - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Removes the query parameter.

remove(PluginKey) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginContainer

Removes plugin in Container

remove(String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage

Removes the notification by given Id

remove(String, long) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage

Remove the NotificationInfo live after X days

remove(long) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage

Remove the NotificationInfo live after X days

remove(String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService

Removes the notification by the notificationId

remove(Context, Scope, String) - Method in interface org.exoplatform.commons.api.settings.SettingService

Removes a value associated with a specified composite key.

remove(Context, Scope) - Method in interface org.exoplatform.commons.api.settings.SettingService

Removes all values associated with a specified context and scope from the database.

remove(Context) - Method in interface org.exoplatform.commons.api.settings.SettingService

Removes all values associated with a specified context from the database.

removeAll() - Method in interface org.exoplatform.commons.api.notification.service.QueueMessage

Removes all queue elements

removeChannelActive(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

removeChannelPlugin(String, String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

remove the pluginId on channel

removeEventListener(Listener<S, D>) - Method in interface org.exoplatform.commons.api.event.EventManager

Unregisters a listener out of the event system.

removeEventListener(String, Listener<S, D>) - Method in interface org.exoplatform.commons.api.event.EventManager

Unregisters a listener out of a given event group in the event system.

removeMessageAfterSent(NotificationContext) - Method in interface org.exoplatform.commons.api.notification.service.storage.MailNotificationStorage

Removes all messages after they have been sent.

removeOnSendToDaily(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

removeOnSendToWeekly(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

removePlugin(String, UserSetting.FREQUENCY) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

render(RenderContext) - Method in class org.exoplatform.commons.api.ui.BaseUIPlugin

render(RenderContext) - Method in interface org.exoplatform.commons.api.ui.PlugableUIService

render(RenderContext) - Method in class org.exoplatform.commons.api.ui.PlugableUIServiceImpl

RenderContext - Class in org.exoplatform.commons.api.ui

RenderContext(String) - Constructor for class org.exoplatform.commons.api.ui.RenderContext

renderLink() - Method in class org.exoplatform.commons.api.search.data.SearchContext

Render link base on router and Map<QualifiedName, String>

repositoryName - Variable in class org.exoplatform.commons.api.settings.data.SettingContext

Name of the repository in JCR.

resetNumberOnBadge(String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage

Reset the number on badge of the specified user

resetNumberOnBadge(String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService

resolve(String) - Method in class org.exoplatform.commons.api.ui.RenderContext

Response - Class in org.exoplatform.commons.api.ui

Response(byte[], String) - Constructor for class org.exoplatform.commons.api.ui.Response

S

save() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Stores all information to the database.

save(UserSetting) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService

Saves the notification settings of a user.

save(NotificationInfo) - Method in interface org.exoplatform.commons.api.notification.service.storage.MailNotificationStorage

Saves information of a notification.

save(NotificationInfo) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage

Creates the new notification message to the specified user.

save(NotificationInfo) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService

Creates the new notification message to the specified user.

save(Context) - Method in interface org.exoplatform.commons.api.settings.SettingService

Saves a Context on database

saveActive(String, boolean) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService

Deprecated.

user isActive(String channelId, String pluginId);

saveActiveFeature(String, boolean) - Method in interface org.exoplatform.commons.api.settings.ExoFeatureService

Switch feature featureName on or off

saveActivePlugin(String, String, boolean) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService

Saves a plugin.

saveLastReadDate(String, Long) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService

Stores the read time point when user clicks mark all read his/her messages.

Scope - Class in org.exoplatform.commons.api.settings.data

Saves some settings linked to a scope.

Scope(String, String) - Constructor for class org.exoplatform.commons.api.settings.data.Scope

scope - Variable in class org.exoplatform.commons.api.settings.data.SettingScope

scopePath - Variable in class org.exoplatform.commons.api.settings.data.SettingScope

search(SearchContext, String, Collection<String>, Collection<String>, int, int, String, String) - Method in class org.exoplatform.commons.api.search.SearchService

Aggregates search results from all connectors.

search(SearchContext, String, Collection<String>, int, int, String, String) - Method in class org.exoplatform.commons.api.search.SearchServiceConnector

Returns a collection of search results from the connectors.

SearchContext - Class in org.exoplatform.commons.api.search.data

Search Context contains a set of data needed for SearchService and all connectors.

SearchContext(Router, String) - Constructor for class org.exoplatform.commons.api.search.data.SearchContext

Contructor to create a context for search service

SearchContext.RouterParams - Enum in org.exoplatform.commons.api.search.data

SearchEntry - Class in org.exoplatform.commons.api.indexing.data

The class defines data structure of entry that is as input for indexing

SearchEntry() - Constructor for class org.exoplatform.commons.api.indexing.data.SearchEntry

Default constructor

SearchEntry(String, String, String, Map<String, Object>) - Constructor for class org.exoplatform.commons.api.indexing.data.SearchEntry

Constructor creates a entry with specified parameters

SearchEntryId - Class in org.exoplatform.commons.api.indexing.data

The class defines structure of id that specifies a unique entry

SearchEntryId(String, String, String) - Constructor for class org.exoplatform.commons.api.indexing.data.SearchEntryId

Constructor creates entry id

SearchResult - Class in org.exoplatform.commons.api.search.data

Search result returned by SearchService and all of its connectors, for rendering their search results on UI in a unified format.

SearchResult(String, String, String, String, String, long, long) - Constructor for class org.exoplatform.commons.api.search.data.SearchResult

Constructor that helps to create search result by the unique way

SearchResult(String, String, String, String, String, String, long, long) - Constructor for class org.exoplatform.commons.api.search.data.SearchResult

Constructor that helps to create search result by the unique way (keeping the other constructor without previewUrl for backward compatibility reasons)

SearchService - Class in org.exoplatform.commons.api.search

Defines a Search API that a driver can implement, and provides the add/get methods to the connector.

SearchService() - Constructor for class org.exoplatform.commons.api.search.SearchService

SearchServiceConnector - Class in org.exoplatform.commons.api.search

Is extended by all SearchService connectors, and allows to build configuration needed by a list of connectors that is used for the Unified Search.

SearchServiceConnector(InitParams) - Constructor for class org.exoplatform.commons.api.search.SearchServiceConnector

Initializes a search service connector.

send(NotificationContext) - Method in class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle

Sends the message by Mail, UI or any the configured channel

send(NotificationContext) - Method in class org.exoplatform.commons.api.notification.lifecycle.DefaultLifecycle

send() - Method in interface org.exoplatform.commons.api.notification.service.QueueMessage

Peek the message from queue and send

sendMessage(MessageInfo) - Method in interface org.exoplatform.commons.api.notification.service.QueueMessage

Sends mail instantly without passing by queue (use directly the mail service).

set(Context, Scope, String, SettingValue<?>) - Method in interface org.exoplatform.commons.api.settings.SettingService

Sets a value with the key that is composed by context, scope, key.

setActionUrl(String) - Method in class org.exoplatform.commons.api.ui.RenderContext

setAllChannelPlugins(Map<String, List<String>>) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

setBundlePath(String) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

setBundlePath(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

setBundlePath(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

setChannel(AbstractChannel) - Method in class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle

Sets the channel to the lifecycle

setChannelActive(String) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

setChannelActive(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

setChannelActives(List<String>) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

setChannelActives(List<String>) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

setChannelKey(ChannelKey) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

Sets the channel of the notification

setChannelPlugins(String, List<String>) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

setContent(Map<String, Object>) - Method in class org.exoplatform.commons.api.indexing.data.SearchEntry

Set content

setCreatedTime(long) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

setCreationAuthor(String) - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Set creation author

setCreationDate(long) - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Set creation Date

setDailyPlugins(List<String>) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

setData(byte[]) - Method in class org.exoplatform.commons.api.ui.Response

setDate(long) - Method in class org.exoplatform.commons.api.search.data.SearchResult

Set data for result

setDateCreated(Calendar) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setDefaultConfig(List<String>) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

setDefaultConfig(List<String>) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

setDetail(String) - Method in class org.exoplatform.commons.api.search.data.SearchResult

Set detail for result

setDisplayName(String) - Method in class org.exoplatform.commons.api.search.SearchServiceConnector

Sets a display name.

setEnable(boolean) - Method in class org.exoplatform.commons.api.search.SearchServiceConnector

set enable by default

setEnabled(boolean) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

setEventType(EventType) - Method in class org.exoplatform.commons.api.settings.data.SettingData

Sets an event type associated with the setting data.

setException(Throwable) - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Sets the exception if have any when the done processing

setException(Throwable) - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext

Holds the exception if have any on transform processing.

setExcerpt(String) - Method in class org.exoplatform.commons.api.indexing.data.SimpleEntry

Set excerpt

setExcerpt(String) - Method in class org.exoplatform.commons.api.search.data.SearchResult

Set excerpt for result

setFrom(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setGroupConfig(GroupConfig) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

setGroupId(String) - Method in class org.exoplatform.commons.api.notification.model.GroupProvider

setGroupId(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

setId(SearchEntryId) - Method in class org.exoplatform.commons.api.indexing.data.SearchEntry

Set entry id

setId(String) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

Sets the uuid of messageInfo node

setId(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setId(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig

setImageUrl(String) - Method in class org.exoplatform.commons.api.search.data.SearchResult

Set image url for avatar

setKey(String) - Method in class org.exoplatform.commons.api.settings.data.SettingKey

Sets a key value of the SettingKey object.

setKeyMapping(Map<String, String>) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

setKeyMapping(Map<String, String>) - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

setLastModifiedDate(Calendar) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setLastModifiedDate(long) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setLastReadDate(long) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

Set last read date

setLastUpdateAuthor(String) - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Set last update author

setLastUpdateDate(long) - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Set last update date

setLastUpdateTime(Calendar) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

setLimitDay(int) - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter

setMimeType(String) - Method in class org.exoplatform.commons.api.ui.Response

setMoveTop(boolean) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

Sets the the move top value

setName(String) - Method in class org.exoplatform.commons.api.ui.ActionContext

setNotificationInfo(NotificationInfo) - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Sets notification infomation

setNotificationInfos(List<NotificationInfo>) - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Sets notification information list

setNumberOnBadge(int) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

Sets the badge number of the user

setOldPlugin(boolean) - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin

Sets the flag value TRUE/FALSE The target adapts the old plugin on PLF 4.1 to work well new mechanism

setOnPopOver(boolean) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setOnPopover(boolean) - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter

setOrder(int) - Method in class org.exoplatform.commons.api.notification.model.GroupProvider

setOrder(int) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setOrder(int) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

setOrder(boolean) - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter

setOrder(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig

setOrder(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

setOwnerParameter(Map<String, String>) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setOwnerParameter(Value[]) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setParameter(String, String) - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter

setParams(Map<String, List<String>>) - Method in class org.exoplatform.commons.api.ui.BaseContext

setPluginId(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

setPluginInfos(List<PluginInfo>) - Method in class org.exoplatform.commons.api.notification.model.GroupProvider

setPluginKey(PluginKey) - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter

setPreviewUrl(String) - Method in class org.exoplatform.commons.api.search.data.SearchResult

Set preview url for result

setProviderId(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

setProviders(List<String>) - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig

setRead(boolean) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setRead(boolean) - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter

setRelevancy(long) - Method in class org.exoplatform.commons.api.search.data.SearchResult

Set relevancy

setResetOnBadge(boolean) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setResourceBundleKey(String) - Method in class org.exoplatform.commons.api.notification.model.GroupProvider

setResourceBundleKey(String) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

setResourceBundleKey(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig

setResourceBundleKey(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

setRouter(Router) - Method in class org.exoplatform.commons.api.search.data.SearchContext

Set router

setRsBundle(ResourceBundle) - Method in class org.exoplatform.commons.api.ui.RenderContext

setSearchType(String) - Method in class org.exoplatform.commons.api.search.SearchServiceConnector

Sets a search type.

setSendAll(boolean) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setSendToDaily(String[]) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setSendToDaily(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setSendToWeekly(String[]) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setSendToWeekly(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setSettingContext(SettingContext) - Method in class org.exoplatform.commons.api.settings.data.SettingData

Sets a setting context associated with the setting data.

setSettingValue(SettingValue<?>) - Method in class org.exoplatform.commons.api.settings.data.SettingData

Sets a setting value of setting property (SettingKey) associated with the setting data.

setStatisticsEnabled(boolean) - Method in interface org.exoplatform.commons.api.notification.stat.Statistics

Sets is running on statistic mode.

setTemplateConfig(TemplateConfig) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

setTemplateEngine(Template) - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder

Set TemplateEngine for plugin

setTemplateEngine(Template) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin

Set TemplateEngine for plugin

setTemplateEngine(Template) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin

Set TemplateEngine for plugin

setTemplatePath(String) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin

setTemplatePath(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

SettingContext - Class in org.exoplatform.commons.api.settings.data

Associates setting properties with a specified context (GLOBAL/USER).

SettingContext(Context) - Constructor for class org.exoplatform.commons.api.settings.data.SettingContext

Creates a SettingContext object with a specified context type.

SettingData - Class in org.exoplatform.commons.api.settings.data

Supports the setting event management that contains all information of event.

SettingData(EventType, SettingContext) - Constructor for class org.exoplatform.commons.api.settings.data.SettingData

Creates the setting data with the specified event type and context.

SettingData(EventType, SettingContext, SettingValue<?>) - Constructor for class org.exoplatform.commons.api.settings.data.SettingData

Creates the setting data with the specified event type and setting properties.

SettingKey - Class in org.exoplatform.commons.api.settings.data

Associates setting properties with a specified key.

SettingKey(Context, Scope, String) - Constructor for class org.exoplatform.commons.api.settings.data.SettingKey

Creates a SettingKey with a composite value [context, scope, key].

SettingListener - Class in org.exoplatform.commons.api.settings

This class is registered with the SettingsService and is invoked when an event with the same name is broadcasted.

SettingListener() - Constructor for class org.exoplatform.commons.api.settings.SettingListener

SettingScope - Class in org.exoplatform.commons.api.settings.data

Associates setting properties with a specified scope (for example, GLOBAL/PORTAL/APPLICATION).

SettingScope(Context, Scope) - Constructor for class org.exoplatform.commons.api.settings.data.SettingScope

Creates a setting scope object with a composite key [context, scope].

SettingService - Interface in org.exoplatform.commons.api.settings

Stores and removes a value associated with a key in JCR.

SettingValue<T> - Class in org.exoplatform.commons.api.settings

All possible value types are stored in JCR.

SettingValue(T) - Constructor for class org.exoplatform.commons.api.settings.SettingValue

Creates a setting value object with a specified value type.

setTitle(String) - Method in class org.exoplatform.commons.api.indexing.data.SimpleEntry

Set title

setTitle(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

Sets the title of the notification

setTitle(String) - Method in class org.exoplatform.commons.api.search.data.SearchResult

Set title for result

setTo(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setType(String) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

setUpdate(boolean) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

setUrl(String) - Method in class org.exoplatform.commons.api.indexing.data.SimpleEntry

Set URL

setUrl(String) - Method in class org.exoplatform.commons.api.search.data.SearchResult

Set url for result

setUserEnabled(String, boolean) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService

Enables user settings

setUserId(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

setWeeklyPlugins(List<String>) - Method in class org.exoplatform.commons.api.notification.model.UserSetting

setWritingProcess(boolean) - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Sets the writing status to the context

SHOW_POPOVER_PROPERTY - Static variable in class org.exoplatform.commons.api.notification.NotificationMessageUtils

SimpleEntry - Class in org.exoplatform.commons.api.indexing.data

The class defines a simple entry

SimpleEntry() - Constructor for class org.exoplatform.commons.api.indexing.data.SimpleEntry

SITE - Static variable in class org.exoplatform.commons.api.settings.data.Scope

Settings of sites.

siteName(String) - Method in class org.exoplatform.commons.api.search.data.SearchContext

Puts SiteType value into QualifiedName map

siteType(String) - Method in class org.exoplatform.commons.api.search.data.SearchContext

Puts SiteType value into QualifiedName map

sizeChannels() - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager

Gets size of channels has been registered

SPACE - Static variable in class org.exoplatform.commons.api.settings.data.Scope

Settings of spaces.

StandardEntry - Class in org.exoplatform.commons.api.indexing.data

The class defines standard entry

StandardEntry() - Constructor for class org.exoplatform.commons.api.indexing.data.StandardEntry

start() - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel

Initialize something when starts to work the channel

start(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin

Start the plug in

start() - Method in class org.exoplatform.commons.api.notification.service.NotificationCompletionService

Statistics - Interface in org.exoplatform.commons.api.notification.stat

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Oct 10, 2013

StatisticsCollector - Interface in org.exoplatform.commons.api.notification.stat

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Oct 10, 2013

stop() - Method in class org.exoplatform.commons.api.notification.service.NotificationCompletionService

store(NotificationInfo) - Method in class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle

Storage the notification into the db

subject(String) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

SUBJECT_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig

SUBJECT_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

T

template(String) - Method in interface org.exoplatform.commons.api.notification.template.Element

Assigns the template to the element

templateBuilders - Variable in class org.exoplatform.commons.api.notification.channel.template.TemplateProvider

TemplateConfig - Annotation Type in org.exoplatform.commons.api.notification.annotation

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 12, 2014

TemplateConfig - Class in org.exoplatform.commons.api.notification.plugin.config

TemplateConfig() - Constructor for class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

TemplateConfig(String) - Constructor for class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig

TemplateConfigs - Annotation Type in org.exoplatform.commons.api.notification.annotation

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 12, 2014

TemplateContext - Class in org.exoplatform.commons.api.notification.service.template

TemplateContext() - Constructor for class org.exoplatform.commons.api.notification.service.template.TemplateContext

TemplateContext(String, String) - Constructor for class org.exoplatform.commons.api.notification.service.template.TemplateContext

templateFilePaths - Variable in class org.exoplatform.commons.api.notification.channel.template.TemplateProvider

TemplateProvider - Class in org.exoplatform.commons.api.notification.channel.template

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 12, 2014

TemplateProvider(InitParams) - Constructor for class org.exoplatform.commons.api.notification.channel.template.TemplateProvider

TemplateTransformer - Interface in org.exoplatform.commons.api.notification.template

Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Aug 1, 2013

to(String) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

to(List<String>) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

to(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

toJSON() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

Tools - Class in org.exoplatform.commons.api.settings.data

This class is useful to build the object path saved in JCR.

Tools() - Constructor for class org.exoplatform.commons.api.settings.data.Tools

toString() - Method in class org.exoplatform.commons.api.indexing.data.SearchEntry

toString() - Method in class org.exoplatform.commons.api.indexing.data.SearchEntryId

toString() - Method in class org.exoplatform.commons.api.notification.model.ChannelKey

toString() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo

toString() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

toString() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo

toString() - Method in class org.exoplatform.commons.api.notification.model.PluginKey

toString() - Method in class org.exoplatform.commons.api.notification.model.UserSetting

toString() - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter

toString() - Method in class org.exoplatform.commons.api.search.data.SearchResult

transform(TemplateContext) - Method in interface org.exoplatform.commons.api.notification.template.TemplateTransformer

The execution transform from template to value base on the TemplateContext.

type - Variable in class org.exoplatform.commons.api.indexing.data.SearchEntryId

U

unregister(AbstractChannel) - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager

Unregister the specified channel

update(Event<S, D>) - Method in interface org.exoplatform.commons.api.event.EventListener

Processes a dedicated work when the update event is triggered.

update(SearchEntryId, Map<String, Object>) - Method in class org.exoplatform.commons.api.indexing.IndexingService

Updates a search entry.

update(NotificationInfo) - Method in class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle

Update an existing notification

update(NotificationInfo, boolean) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage

Update an existing notification message.

update(E) - Method in interface org.exoplatform.commons.api.persistence.GenericDAO

Update the entity in the persistence context.

updateAll(List<E>) - Method in interface org.exoplatform.commons.api.persistence.GenericDAO

Update the entity in the persistence context.

updateEntity(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector

Callback about a entity being updated

USER - Static variable in class org.exoplatform.commons.api.settings.data.Context

USER: Each user should be able to save his own settings.

UserSetting - Class in org.exoplatform.commons.api.notification.model

User setting notification

UserSetting() - Constructor for class org.exoplatform.commons.api.notification.model.UserSetting

UserSetting.FREQUENCY - Enum in org.exoplatform.commons.api.notification.model

UserSettingService - Interface in org.exoplatform.commons.api.notification.service.setting

V

value(ArgumentLiteral<T>) - Method in interface org.exoplatform.commons.api.notification.NotificationContext

Gets FilterOption which was existing.

valueOf(String) - Static method in enum org.exoplatform.commons.api.notification.model.UserSetting.FREQUENCY

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.exoplatform.commons.api.search.data.SearchContext.RouterParams

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.exoplatform.commons.api.settings.data.EventType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.exoplatform.commons.api.notification.model.UserSetting.FREQUENCY

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.exoplatform.commons.api.search.data.SearchContext.RouterParams

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.exoplatform.commons.api.settings.data.EventType

Returns an array containing the constants of this enum type, in the order they are declared.

visit(Element) - Method in interface org.exoplatform.commons.api.notification.template.ElementVisitor

To visit the element and generate

W

waitCompletionFinished() - Method in class org.exoplatform.commons.api.notification.service.NotificationCompletionService

WebNotificationFilter - Class in org.exoplatform.commons.api.notification.model

WebNotificationFilter(String) - Constructor for class org.exoplatform.commons.api.notification.model.WebNotificationFilter

WebNotificationFilter(String, boolean) - Constructor for class org.exoplatform.commons.api.notification.model.WebNotificationFilter

WebNotificationService - Interface in org.exoplatform.commons.api.notification.service

WebNotificationStorage - Interface in org.exoplatform.commons.api.notification.service.storage

WINDOWS - Static variable in class org.exoplatform.commons.api.settings.data.Scope

Settings of portlets or gadgets.

with(NotificationCommand) - Method in interface org.exoplatform.commons.api.notification.command.NotificationExecutor

with(List<NotificationCommand>) - Method in interface org.exoplatform.commons.api.notification.command.NotificationExecutor

with(String, String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo

with(TemplateContext) - Method in interface org.exoplatform.commons.api.notification.template.ElementVisitor

Attaches the Template Context for Template generate.

WSFilter - Interface in org.exoplatform.commons.api.websocket

WSFilterDefinition - Class in org.exoplatform.commons.api.websocket

WSFilterDefinition() - Constructor for class org.exoplatform.commons.api.websocket.WSFilterDefinition

WSFilterDefinition(WSFilter, List<String>) - Constructor for class org.exoplatform.commons.api.websocket.WSFilterDefinition

_

_session - Variable in class org.exoplatform.commons.api.websocket.AbstractEndpoint

A B C D E F G H I K L M N O P Q R S T U V W _