org.ametys.plugins.queriesdirectory

Class QueryDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.queriesdirectory.QueryDAO

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class QueryDAO
extends AbstractLogEnabled
implements Serviceable, Component

DAO for manipulating queries

Field Summary

Fields

Modifier and Type	Field and Description
private AmetysObjectResolver	_resolver The Ametys object resolver
private RightManager	_rightManager
private UserHelper	_userHelper
protected CurrentUserProvider	_userProvider The current user provider
static String	ROLE The Avalon role

Constructor Summary

Constructors

Constructor and Description
QueryDAO()

Method Summary

Modifier and Type	Method and Description
private Map<String,Object>	_assignRights(String queryId, String profileId, String type, List<Map<String,String>> users, List<Map<String,String>> groups)
protected boolean	_hasRight(Query query) Test if the current user has the right required to access the query
Map<String,Object>	addGrantedGroups(String queryId, String profileId, List<Map<String,String>> groups) Assign rigths to the given groups on the given query
Map<String,Object>	addGrantedUsers(String queryId, String profileId, List<Map<String,String>> users) Assign rights to the given users on the given query
Map<String,Object>	changeVisibility(String queryId, String visibilityStr) Changes the visibility of a Query
String	createQuery(String title, String desc, String type, String content) Creates a new Query
Map<String,Object>	deleteQuery(List<String> ids) Deletes Query(ies)
Map<String,Object>	getQueriesProperties(List<String> queryIds) Get queries' properties
Map<String,Object>	getQueryProperties(Query query) Get the query properties
boolean	isAdministrator() Determines if the current user is administrator of queries
Map<String,Object>	removeAssignment(String queryId, String profileId, List<Map<String,String>> users, List<Map<String,String>> groups) Remove rights to the given users on the given query
Map<String,Object>	saveQuery(String id, String type, String content) Saves a Query
void	service(ServiceManager serviceManager)
Map<String,Object>	updateQuery(String id, String title, String desc) Edits a Query

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROLE

public static final String ROLE

The Avalon role

_userProvider

protected CurrentUserProvider _userProvider

The current user provider

_resolver

private AmetysObjectResolver _resolver

The Ametys object resolver

_userHelper

private UserHelper _userHelper

_rightManager

private RightManager _rightManager

Constructor Detail

QueryDAO

public QueryDAO()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getQueriesProperties

public Map<String,Object> getQueriesProperties(List<String> queryIds)

Get queries' properties

Parameters:

queryIds - The ids of queries to retrieve

Returns:

The queries' properties

getQueryProperties

public Map<String,Object> getQueryProperties(Query query)

Get the query properties

Parameters:

query - The query

Returns:

The query properties

createQuery

public String createQuery(String title,
                          String desc,
                          String type,
                          String content)

Creates a new Query

Parameters:

title - The title of the query

desc - The description of the query

type - The type of the query

content - The content of the query

Returns:

The id of created query

updateQuery

public Map<String,Object> updateQuery(String id,
                                      String title,
                                      String desc)

Edits a Query

Parameters:

id - The id of the query

title - The title of the query

desc - The description of the query

Returns:

A result map

saveQuery

public Map<String,Object> saveQuery(String id,
                                    String type,
                                    String content)

Saves a Query

Parameters:

id - The id of the query

type - The type of the query

content - The content of the query

Returns:

A result map

deleteQuery

public Map<String,Object> deleteQuery(List<String> ids)

Deletes Query(ies)

Parameters:

ids - The ids of the queries to delete

Returns:

A result map

changeVisibility

public Map<String,Object> changeVisibility(String queryId,
                                           String visibilityStr)

Changes the visibility of a Query

Parameters:

queryId - The id of the query

visibilityStr - The new visibility

Returns:

A result map

addGrantedUsers

public Map<String,Object> addGrantedUsers(String queryId,
                                          String profileId,
                                          List<Map<String,String>> users)

Assign rights to the given users on the given query

Parameters:

queryId - The query id

profileId - The profile id

users - The users to grant

Returns:

A result map

addGrantedGroups

public Map<String,Object> addGrantedGroups(String queryId,
                                           String profileId,
                                           List<Map<String,String>> groups)

Assign rigths to the given groups on the given query

Parameters:

queryId - The query id

profileId - The profile id

groups - The groups to grant

Returns:

A result map

_assignRights

private Map<String,Object> _assignRights(String queryId,
                                         String profileId,
                                         String type,
                                         List<Map<String,String>> users,
                                         List<Map<String,String>> groups)

removeAssignment

public Map<String,Object> removeAssignment(String queryId,
                                           String profileId,
                                           List<Map<String,String>> users,
                                           List<Map<String,String>> groups)

Remove rights to the given users on the given query

Parameters:

queryId - The query id

profileId - The profile id

users - The users to remove

groups - The groups to remove

Returns:

A result map

isAdministrator

public boolean isAdministrator()

Determines if the current user is administrator of queries

Returns:

true if current user is administrator

_hasRight

protected boolean _hasRight(Query query)

Test if the current user has the right required to access the query

Parameters:

query - The query

Returns:

true if the user has the right needed, false otherwise.