org.craftercms.studio.api.v2.dal

Interface UserDAO

public interface UserDAO

Method Summary

Modifier and Type	Method and Description
int	createUser(Map params) Create user
int	deleteUsers(Map params) Delete users
int	enableUsers(Map params) Enable/disable users
List<User>	getAllUsers(Map params) Get all users
List<User>	getAllUsersForSite(Map params) Get all users for given site
int	getAllUsersForSiteTotal(Map params) Get total number of users
int	getAllUsersTotal() Get total number of users
User	getUserByGitName(String gitName) Get user by git name
User	getUserByIdOrUsername(Map params) Get user by id or username
List<Group>	getUserGroups(Map params) Get user groups
List<Long>	getUserIdsForUsernames(Map params) Get ids for users
Integer	isUserMemberOfGroup(Map params) Check if user is member of given group
int	setUserPassword(Map params) Set password for user
int	updateUser(Map params) Update user
Integer	userExists(Map params) Check if user exists

Method Detail

getAllUsersForSite

List<User> getAllUsersForSite(Map params)

Get all users for given site

Parameters:

params - SQL query parameters

Returns:

List of users

getAllUsers

List<User> getAllUsers(Map params)

Get all users

Parameters:

params - SQL query parameters

Returns:

List of users

createUser

int createUser(Map params)

Create user

Parameters:

params - SQL query parameters

Returns:

Number of rows affected in DB

updateUser

int updateUser(Map params)

Update user

Parameters:

params - SQL query parameters

Returns:

Number of rows affected in DB

getUserIdsForUsernames

List<Long> getUserIdsForUsernames(Map params)

Get ids for users

Parameters:

params - SQL query parameters

Returns:

List of user ids

deleteUsers

int deleteUsers(Map params)

Delete users

Parameters:

params - SQL query params

Returns:

Number of rows affected in DB

getUserByIdOrUsername

User getUserByIdOrUsername(Map params)

Get user by id or username

Parameters:

params - SQL query parameters

Returns:

User or null if not found

enableUsers

int enableUsers(Map params)

Enable/disable users

Parameters:

params - SQL query parameters

Returns:

Number of rows affected in DB

getUserGroups

List<Group> getUserGroups(Map params)

Get user groups

Parameters:

params - SQL query parameters

Returns:

List of groups

getAllUsersForSiteTotal

int getAllUsersForSiteTotal(Map params)

Get total number of users

Returns:

total number of users for site

getAllUsersTotal

int getAllUsersTotal()

Get total number of users

Returns:

total number of all users

setUserPassword

int setUserPassword(Map params)

Set password for user

Parameters:

params - SQL query parameters

Returns:

Number of rows affected

userExists

Integer userExists(Map params)

Check if user exists

Parameters:

params -

Returns:

positive number if user exists, otherwise 0

isUserMemberOfGroup

Integer isUserMemberOfGroup(Map params)

Check if user is member of given group

Parameters:

params - SQL query parameters

Returns:

if true result > 0

getUserByGitName

User getUserByGitName(@Param(value="gitName")
                      String gitName)

Get user by git name

Parameters:

gitName - SQL query parameter

Returns:

User or null if not found