Index (eXo Commons - API 4.1.0 API)

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

A

AbstractNotificationChildPlugin - Class in org.exoplatform.commons.api.notification.plugin
AbstractNotificationChildPlugin(InitParams) - Constructor for class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin
AbstractNotificationPlugin - Class in org.exoplatform.commons.api.notification.plugin
AbstractNotificationPlugin(InitParams) - Constructor for class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin
accept(ElementVisitor) - Method in interface org.exoplatform.commons.api.notification.template.Element: Accept the visitor to visit the element
add(SearchEntry) - Method in class org.exoplatform.commons.api.indexing.IndexingService: Adds a search entry.
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.
addKeyMapping(String, String) - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
addMixin(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService: Adds the default settings to a user's node.
addMixin(User[]) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService: Adds the default settings to a list of users.
addNewLine(boolean) - Method in interface org.exoplatform.commons.api.notification.template.Element: Set the value isNewLine for the case digest
addPlugin(AbstractNotificationPlugin) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginContainer: Register plugin in Container
addProvider(String, UserSetting.FREQUENCY) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
addProvider(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig
addProviderData(PluginInfo) - Method in class org.exoplatform.commons.api.notification.model.GroupProvider
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.
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

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.
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.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.plugin.AbstractNotificationPlugin: Makes massage
buildMessage(NotificationContext, Map<NotificationKey, 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.AbstractNotificationPlugin: 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

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() - 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
config(TemplateConfig) - 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 - Enum in org.exoplatform.commons.api.settings.data: Saves some settings linked to a 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.
create(Event<S, D>) - Method in interface org.exoplatform.commons.api.event.EventListener: Processes a dedicated work when the create event is triggered.
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.
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

DATE_INDEXED - Static variable in class org.exoplatform.commons.api.indexing.IndexingService
DEFAULT_LANGUAGE - Static variable in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils
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
delete(SearchEntryId) - Method in class org.exoplatform.commons.api.indexing.IndexingService: Deletes a search entry by its Id.
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.TemplateConfig
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.TemplateConfig
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

E

Element - Interface in org.exoplatform.commons.api.notification.template
ElementVisitor - Interface in org.exoplatform.commons.api.notification.template
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.AbstractNotificationPlugin: End the plug in
end() - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext
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.MessageInfo
equals(Object) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
equals(Object) - Method in class org.exoplatform.commons.api.notification.model.NotificationKey
equals(Object) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
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.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
ExoFeatureService - Interface in org.exoplatform.commons.api.settings

F

File - Interface in org.exoplatform.commons.api.event.data: An abstract representation of file.
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.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

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(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.
getActivePluginIds() - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService: Gets all Ids of active plugins.
getActivePlugins() - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService: Gets information of all active 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.TemplateConfig
getByUser(NotificationContext, UserSetting) - Method in interface org.exoplatform.commons.api.notification.service.storage.NotificationDataStorage: Gets information of all notifications of a user.
getChildPluginKeys(NotificationKey) - 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.
getContextPath() - Method in class org.exoplatform.commons.api.settings.data.SettingContext: Gets path of the SettingContext object.
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.
getDailyProviders() - 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.
getDate() - Method in class org.exoplatform.commons.api.search.data.SearchResult: Get date of result
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.
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
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
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.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.NotificationKey
getId() - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin: Gets Notification Plug in key
getId() - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig
getId() - Method in enum org.exoplatform.commons.api.settings.data.Context: Gets a context Id.
getId() - Method in enum 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
getInstantlyProviders() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
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.settings.data.SettingKey: Gets a key value of the SettingKey object.
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.TemplateConfig
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.
getLastModifier() - Method in interface org.exoplatform.commons.api.event.data.BaseObject: Gets name of the user who did the last modification on the BaseObject.
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
getLoadCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics
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.
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
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
getNotificationKey() - Method in interface org.exoplatform.commons.api.notification.command.NotificationCommand: Gets a notification key associated with the notification command.
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.plugin.AbstractNotificationPlugin
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
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(NotificationKey) - 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.
getPluginConfigs() - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin
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
getPluginNames() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics: Get the names of all entities
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
getPollCount() - Method in interface org.exoplatform.commons.api.notification.stat.QueueStatistics
getPortalName() - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils
getPrimaryType() - Method in interface org.exoplatform.commons.api.event.data.BaseObject: Gets the primary type of the BaseObject.
getProviderDatas() - Method in class org.exoplatform.commons.api.notification.model.GroupProvider
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
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.
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.
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
getTemplateConfig() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
getTemplateConfig() - 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.
getTemplateContext() - Method in interface org.exoplatform.commons.api.notification.template.ElementVisitor: Gets the template context
getTemplateEngine() - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin: Get TemplateEngine of plugin
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.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
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
getUserSettingByPlugin(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService: Gets all Ids of users registering for notifications by a given plugin.
getUserSettingWithDeactivate() - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService: Gets all settings of users who deactivated is FALSE
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
getWeeklyProviders() - 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.
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.MessageInfo
hashCode() - Method in class org.exoplatform.commons.api.notification.model.NotificationKey
hashCode() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
hashCode() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
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.

I

id - Variable in class org.exoplatform.commons.api.indexing.data.SearchEntry
id(String) - Method in enum org.exoplatform.commons.api.settings.data.Context: Creates a context with a specified Id.
id(String) - Method in enum 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
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() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
isActive() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
isActive(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService: Checks if a plugin is active or inactive.
isActiveFeature(String) - Method in interface org.exoplatform.commons.api.settings.ExoFeatureService: Check the status of a feature
isActiveWithoutInstantly(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
isAsync() - Method in class org.exoplatform.commons.api.notification.service.NotificationCompletionService
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
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
isInInstantly(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
isInWeekly(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
isNewLine() - Method in interface org.exoplatform.commons.api.notification.template.Element: Get the value of isNewLine
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
isValid(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin: Check, for each plugin, if we will send notification

K

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

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

M

makeCommand(NotificationKey) - 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.plugin.AbstractNotificationChildPlugin
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.plugin.AbstractNotificationChildPlugin
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.AbstractNotificationPlugin: Makes MessageInfo from given information what keep inside NotificationContext
MessageInfo - Class in org.exoplatform.commons.api.notification.model
MessageInfo() - Constructor for class org.exoplatform.commons.api.notification.model.MessageInfo

N

name - Variable in class org.exoplatform.commons.api.indexing.data.SearchEntryId
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
NotificationDataStorage - Interface in org.exoplatform.commons.api.notification.service.storage
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
NotificationKey - Class in org.exoplatform.commons.api.notification.model
NotificationKey(AbstractNotificationPlugin) - Constructor for class org.exoplatform.commons.api.notification.model.NotificationKey
NotificationKey(String) - Constructor for class org.exoplatform.commons.api.notification.model.NotificationKey
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

onEvent(Event<SettingService, SettingData>) - Method in class org.exoplatform.commons.api.settings.SettingListener: Calls back a function when the setting service dispatches an event.
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.
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.command - package org.exoplatform.commons.api.notification.command
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.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.
out() - Method in interface org.exoplatform.commons.api.notification.template.ElementVisitor: Gets the content of template after generates.

P

path(String) - Method in class org.exoplatform.commons.api.search.data.SearchContext: Puts Path value into QualifiedName map
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
PluginInfo - Class in org.exoplatform.commons.api.notification.model
PluginInfo() - Constructor for class org.exoplatform.commons.api.notification.model.PluginInfo
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
pollQueue(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector: Callback indicating execution of poll queue
PREFIX_ID - Static variable in class org.exoplatform.commons.api.notification.model.NotificationInfo
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.
processDigest(NotificationContext, Writer) - Method in interface org.exoplatform.commons.api.notification.command.NotificationCommand: Builds a digest message which is sent daily or weekly.
processMessage(NotificationContext) - Method in interface org.exoplatform.commons.api.notification.command.NotificationCommand: Builds information of a message from the notification context.
processNotification(NotificationContext) - Method in interface org.exoplatform.commons.api.notification.command.NotificationCommand: Builds information of a notification from the notification context.
provider(String) - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext
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

registerGroupConfig(GroupProviderPlugin) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService: Registers the plugin configuration of a group.
registerPluginConfig(PluginConfig) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService: Registers configuration of a plugin.
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(NotificationKey) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginContainer: Removes plugin in Container
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.
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() - Method in interface org.exoplatform.commons.api.notification.service.storage.NotificationDataStorage: 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
renderLink() - Method in class org.exoplatform.commons.api.search.data.SearchContext: Render link base on router and Map
repositoryName - Variable in class org.exoplatform.commons.api.settings.data.SettingContext: Name of the repository in JCR.

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.NotificationDataStorage: Saves information of a notification.
saveActiveFeature(String, boolean) - Method in interface org.exoplatform.commons.api.settings.ExoFeatureService: Switch feature featureName on or off
savePlugin(String, boolean) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService: Saves a plugin.
Scope - Enum in org.exoplatform.commons.api.settings.data: Saves some settings linked to a 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
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() - Method in interface org.exoplatform.commons.api.notification.service.QueueMessage: Peek the message from queue and send
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.
setActive(boolean) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
setActive(boolean) - 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.TemplateConfig
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
setDailyProviders(List<String>) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
setDate(long) - Method in class org.exoplatform.commons.api.search.data.SearchResult: Set data for result
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.
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
setInstantlyProviders(List<String>) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
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.TemplateConfig
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
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
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(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
setPluginId(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
setProviderDatas(List<PluginInfo>) - Method in class org.exoplatform.commons.api.notification.model.GroupProvider
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
setRelevancy(long) - Method in class org.exoplatform.commons.api.search.data.SearchResult: Set relevancy
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
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.plugin.AbstractNotificationPlugin: Set TemplateEngine for plugin
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.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
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
setUserId(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
setWeeklyProviders(List<String>) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
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
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
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(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin: Start the plug in
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
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.TemplateConfig

T

template(String) - Method in interface org.exoplatform.commons.api.notification.template.Element: Assigns the template to the element
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
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
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.MessageInfo
toString() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
toString() - Method in class org.exoplatform.commons.api.notification.model.NotificationKey
toString() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
toString() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
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

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.
updateEntity(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector: Callback about a entity being updated
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.Context: 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.
valueOf(String) - Static method in enum org.exoplatform.commons.api.settings.data.Scope: 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.Context: 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.
values() - Static method in enum org.exoplatform.commons.api.settings.data.Scope: 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
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.

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