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

A

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

Adds a search entry.

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.

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.

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.

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.

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

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

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.

D

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

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

Deletes a search entry by its Id.

E

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.

F

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

An abstract representation of file.

G

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.

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.

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.

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.

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

Get detail of result

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

Gets a display name.

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

Gets the encoding type of the File instance.

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.

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

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

Get entry id

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

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

Gets a key value of the SettingKey object.

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

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

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

Gets name of the user who created the BaseObject.

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

Gets the absolute path of the BaseObject.

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

Gets the primary type of the BaseObject.

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.

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.

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

Gets a setting context associated with the setting data.

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.

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

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

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

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

Get type

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

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.

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

Gets the workspace name where the BaseObject is stored.

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.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

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

L

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

Puts Lang value into QualifiedName map

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

N

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

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.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.

P

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

Puts Path value into QualifiedName map

R

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

Processes a dedicated work when the remove event is triggered.

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.

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.

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.

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.

setContent(Map<String, Object>) - Method in class org.exoplatform.commons.api.indexing.data.SearchEntry

Set content

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

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

Set data for result

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.

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

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

Set entry id

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.

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

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

Set relevancy

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.

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.

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

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

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

T

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.search.data.SearchResult

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.

V

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.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.

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