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

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

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

This will be used to register a listener to the event system.

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

This will be used to register a listener to the event system.

B

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

This Object will be used to get information from a JCR node instead of open a direct access to javax.jcr.Node object.

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

When an action triggered such as file created/updated then it will be broadcast to the dedicated listener to dispatch the event.

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

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

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

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

Created by The eXo Platform SAS Author : eXoPlatform bangnv@exoplatform.com Nov 9, 2012

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

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

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

Process the dedicated work when the create event has been triggered.

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

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

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

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

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

D

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

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

E

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

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

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

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

This used to process all the dedicated work which be delegated from EventManager To adapt with event manager system then all listeners should be implemented this interface.

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

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

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

Created by The eXo Platform SAS Author : Nguyen Viet Bang bangnv@exoplatform.com Nov 27, 2012

F

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

File object instance.

G

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

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

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

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

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

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

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

Return the value of the created date on this Object.

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

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

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

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

Return the binary data of File instance

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

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

Return the contributor of File instance.

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

Return the creator of File instance.

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

Return the last updated date of File instance.

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

Return the description of File instance.

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

Return the publisher of File instance.

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

Return the subject of File instance.

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

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

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

Return the encoding type of File instance.

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

Return a list of Listener which registered to the event system based on its object type.

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

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

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

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

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

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

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

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

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

Return the last modified date of File instance.

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

Return the value of the last modified date on this Object.

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

Return the name of last person who edited this Object.

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

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

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

Return the MIMETYPE of File instance.

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

Return a list of node type name which added to this Object as the mix-in.

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

Return the name of Object.

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

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

Return the name of who created this Object.

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

* Returns the absolute path to this item.

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

Return the primary type of current Object For example: nt:file, exo:webContent,...

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

Return the rate value for this Object

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

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

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

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

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

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

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

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

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

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

Return a list of tags name which added to this Object

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

Return the title value on this Object.

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

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

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

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

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

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

Return the UUID value of this Object.

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

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

Return the workspace name where stored current object.

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

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

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

I

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

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

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

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

Created by The eXo Platform SAS Author : Tung Vu Minh tungvm@exoplatform.com Nov 21, 2012

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Process the dedicated work when the remove event has been triggered.

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

return the SettingValue to which the specified composite key is associated or null if the database don't contains the value for the composited key

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

remove all the value associated with the specified context and specified scope in the database.

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

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

This will be used to unregister a listener out of the event system.

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

This will be used to unregister a listener out of 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

S

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

This function used to store all the information to the database.

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

Created by The eXo Platform SAS Author : eXoPlatform bangnv@exoplatform.com Nov 8, 2012

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

This search method aggregates search results from all connectors

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

The connectors must implement this search method, with the following parameters and return a collection of SearchResult

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

Search context contains context information needed for SearchService and its connectors Created by The eXo Platform SAS Author : Tung Vu Minh tungvm@exoplatform.com Feb 22, 2013

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

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

SearchEntry - Class in org.exoplatform.commons.api.indexing.data

Created by The eXo Platform SAS Author : Tung Vu Minh tungvm@exoplatform.com Nov 21, 2012

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

SearchEntry(String, String, String, Map<String, Object>) - Constructor for class org.exoplatform.commons.api.indexing.data.SearchEntry

SearchEntryId - Class in org.exoplatform.commons.api.indexing.data

Created by The eXo Platform SAS Author : Tung Vu Minh tungvm@exoplatform.com Nov 21, 2012

SearchEntryId(String, String, String) - Constructor for class org.exoplatform.commons.api.indexing.data.SearchEntryId

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 Created by The eXo Platform SAS Author : Tung Vu Minh tungvm@exoplatform.com Nov 21, 2012

SearchResult(String, String, String, String, String, long, long) - Constructor for class org.exoplatform.commons.api.search.data.SearchResult

SearchService - Class in org.exoplatform.commons.api.search

Created by The eXo Platform SAS Author : Tung Vu Minh tungvm@exoplatform.com Nov 21, 2012

SearchService() - Constructor for class org.exoplatform.commons.api.search.SearchService

SearchServiceConnector - Class in org.exoplatform.commons.api.search

This abstract class is extended by the SearchService connectors which provide search result for a specific content type Created by The eXo Platform SAS Author : Tung Vu Minh tungvm@exoplatform.com Nov 21, 2012

SearchServiceConnector(InitParams) - Constructor for class org.exoplatform.commons.api.search.SearchServiceConnector

set(Context, Scope, String, SettingValue<?>) - Method in interface org.exoplatform.commons.api.settings.SettingService

set the specified value with the key which is composed by context, scope, key.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

setSettingValue(SettingValue<?>) - Method in class org.exoplatform.commons.api.settings.data.SettingData

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

Created by The eXo Platform SAS Author : Nguyen Viet Bang bangnv@exoplatform.com Nov 27, 2012

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

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

Created by The eXo Platform SAS Author : Nguyen Viet Bang bangnv@exoplatform.com Nov 27, 2012

SettingData(EventType, SettingContext) - Constructor for class org.exoplatform.commons.api.settings.data.SettingData

SettingData(EventType, SettingContext, SettingValue<?>) - Constructor for class org.exoplatform.commons.api.settings.data.SettingData

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

Created by The eXo Platform SAS Author : eXoPlatform bangnv@exoplatform.com Nov 22, 2012

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

SettingListener - Class in org.exoplatform.commons.api.settings

Created by The eXo Platform SAS Author : Nguyen Viet Bang bangnv@exoplatform.com Nov 27, 2012

SettingListener() - Constructor for class org.exoplatform.commons.api.settings.SettingListener

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

Created by The eXo Platform SAS Author : Nguyen Viet Bang bangnv@exoplatform.com Nov 26, 2012

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

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

SettingValue<T> - Class in org.exoplatform.commons.api.settings

SettingValue(T) - Constructor for class org.exoplatform.commons.api.settings.SettingValue

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

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

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

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

SimpleEntry - Class in org.exoplatform.commons.api.indexing.data

Created by The eXo Platform SAS Author : Tung Vu Minh tungvm@exoplatform.com Nov 21, 2012

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

Created by The eXo Platform SAS Author : Tung Vu Minh tungvm@exoplatform.com Nov 21, 2012

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

T

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

Created by The eXo Platform SAS Author : eXoPlatform bangnv@exoplatform.com Nov 22, 2012

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

Process the dedicated work when the update event has been triggered.

update(SearchEntryId, Map<String, Object>) - Method in class org.exoplatform.commons.api.indexing.IndexingService

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