org.exoplatform.services.cms.queries

Interface QueryService

All Known Implementing Classes:

QueryServiceImpl

public interface QueryService

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_NAME

Method Summary

Modifier and Type	Method and Description
void	addQuery(String queryName, String statement, String language, String userName) Add new query by giving the following params : queryName, statement, language, userName
void	addSharedQuery(String queryName, String statement, String language, String[] permissions, boolean cachedResult) Add new shared query by giving the following params: queryName, statement, language, permissions, cachedResult
void	addSharedQuery(String queryName, String statement, String language, String[] permissions, boolean cachedResult, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Add new shared query by giving the following params: queryName, statement, language, permissions, cachedResult, provider
javax.jcr.query.QueryResult	execute(String queryPath, String workspace, org.exoplatform.services.jcr.ext.common.SessionProvider provider, String userId) Execute query by giving the following params : queryPath, workspace, provider, userId
Set<String>	getAllConfiguredQueries() gets all configured queries
List<javax.jcr.query.Query>	getQueries(String userName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Get queries by giving the following params : userName, repository, provider
javax.jcr.query.Query	getQuery(String queryPath, String workspace, org.exoplatform.services.jcr.ext.common.SessionProvider provider, String userId) Returns Query object by giving the following params : queryPath, workspace, provider, userId
javax.jcr.query.Query	getQueryByPath(String queryPath, String userName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Get query with path by giving the following params : queryPath, userName, provider
String	getRelativePath() Get the relative path
List<javax.jcr.Node>	getSharedQueries(org.exoplatform.services.jcr.ext.common.SessionProvider provider) Get shared queries by giving the following params : provider
List<javax.jcr.Node>	getSharedQueries(String userId, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Get shared queries by giving the following params : userId, provider
List<javax.jcr.Node>	getSharedQueries(String queryType, String userId, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Get shared queries by giving the following params : queryType, userId, provider
javax.jcr.Node	getSharedQuery(String queryName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Get shared queries by giving the following params : queryName, provider
void	init() Init all query plugin in the current repository
void	removeQuery(String queryPath, String userName) Remove query by giving the following params : queryPath, userName
void	removeSharedQuery(String queryName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Remove share query by giving the following params : queryName

Field Detail

CACHE_NAME

static final String CACHE_NAME

See Also:

Constant Field Values

Method Detail

getRelativePath

String getRelativePath()

Get the relative path

Returns:

getQueries

List<javax.jcr.query.Query> getQueries(String userName,
                                       org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                throws Exception

Get queries by giving the following params : userName, repository, provider

Parameters:

userName - String Can be null

provider - SessionProvider

Returns:

queries

Throws:

Exception

See Also:

Query, SessionProvider

execute

javax.jcr.query.QueryResult execute(String queryPath,
                                    String workspace,
                                    org.exoplatform.services.jcr.ext.common.SessionProvider provider,
                                    String userId)
                             throws Exception

Execute query by giving the following params : queryPath, workspace, provider, userId

Parameters:

queryPath - String The path of query

workspace - String The name of workspace

provider - SessionProvider

userId - String The id of current user

Returns:

queries QueryResult

Throws:

Exception

See Also:

QueryResult, SessionProvider

addQuery

void addQuery(String queryName,
              String statement,
              String language,
              String userName)
       throws Exception

Add new query by giving the following params : queryName, statement, language, userName

Parameters:

queryName - String The name of query

statement - String The statement query

language - String The language is requested

userName - String Can be null

Throws:

Exception

removeQuery

void removeQuery(String queryPath,
                 String userName)
          throws Exception

Remove query by giving the following params : queryPath, userName

Parameters:

queryPath - String The path of query

userName - String Can be null

Throws:

Exception

addSharedQuery

void addSharedQuery(String queryName,
                    String statement,
                    String language,
                    String[] permissions,
                    boolean cachedResult)
             throws Exception

Add new shared query by giving the following params: queryName, statement, language, permissions, cachedResult

Parameters:

queryName - String The name of query

statement - String The statement query

language - String The language is requested

permissions - String[]

cachedResult - boolean Choosen for caching results

Throws:

Exception

addSharedQuery

void addSharedQuery(String queryName,
                    String statement,
                    String language,
                    String[] permissions,
                    boolean cachedResult,
                    org.exoplatform.services.jcr.ext.common.SessionProvider provider)
             throws Exception

Add new shared query by giving the following params: queryName, statement, language, permissions, cachedResult, provider

Parameters:

queryName - String The name of query

statement - String The statement query

language - String The language is requested

permissions - String[]

cachedResult - boolean Choosen for caching results

provider - Session provider

Throws:

Exception

getSharedQuery

javax.jcr.Node getSharedQuery(String queryName,
                              org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                       throws Exception

Get shared queries by giving the following params : queryName, provider

Parameters:

queryName - the name of query

provider - SessionProvider

Returns:

sharedQueries

Throws:

Exception

See Also:

Node, SessionProvider

removeSharedQuery

void removeSharedQuery(String queryName,
                       org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                throws Exception

Remove share query by giving the following params : queryName

Parameters:

queryName - String The name of query

provider - SessionProvider

Throws:

Exception

getSharedQueries

List<javax.jcr.Node> getSharedQueries(org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                               throws Exception

Get shared queries by giving the following params : provider

Parameters:

provider - SessionProvider

Returns:

sharedQueries

Throws:

Exception

See Also:

Node, SessionProvider

getQueryByPath

javax.jcr.query.Query getQueryByPath(String queryPath,
                                     String userName,
                                     org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                              throws Exception

Get query with path by giving the following params : queryPath, userName, provider

Parameters:

queryPath - String The path of query

userName - String The name of current user

provider - SessionProvider

Returns:

query Query

Throws:

Exception

See Also:

Node, Query, SessionProvider

getSharedQueries

List<javax.jcr.Node> getSharedQueries(String userId,
                                      org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                               throws Exception

Get shared queries by giving the following params : userId, provider

Parameters:

userId - String The id of current user

provider - SessionProvider

Returns:

sharedQueries

Throws:

Exception

See Also:

Node, SessionProvider

getSharedQueries

List<javax.jcr.Node> getSharedQueries(String queryType,
                                      String userId,
                                      org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                               throws Exception

Get shared queries by giving the following params : queryType, userId, provider

Parameters:

queryType - String The type of query

userId - String The id of current user

provider - SessionProvider

Returns:

sharedQueries

Throws:

Exception

See Also:

Node, SessionProvider

init

void init()
   throws Exception

Init all query plugin in the current repository

Throws:

Exception

See Also:

QueryPlugin

getQuery

javax.jcr.query.Query getQuery(String queryPath,
                               String workspace,
                               org.exoplatform.services.jcr.ext.common.SessionProvider provider,
                               String userId)
                        throws Exception

Returns Query object by giving the following params : queryPath, workspace, provider, userId

Parameters:

queryPath - String The path of query

workspace - String The name of workspace

provider - SessionProvider

userId - String The id of current user

Returns:

queries QueryResult

Throws:

Exception

See Also:

QueryResult, SessionProvider

getAllConfiguredQueries

Set<String> getAllConfiguredQueries()

gets all configured queries

Returns: