Package com.priint.pubserver.plannerapi.interfaces

Interface UsersLocal

public interface UsersLocal

Local interface for the Users service from the Planner API

Method Summary

Modifier and Type	Method	Description
List<User>	addUsers(List<User> users)	Adds a new users
boolean	deleteUserByID(String login)	Deletes the user from the system at the specified login
List<UserAccessRight>	getUserAccessRights(String login, String rightId)	Returns the access rights (with permissions) assigned to the user
User	getUserByID(String login)	Returns the user at the specified login
List<CheckedoutDocument>	getUserCheckedoutDocuments(String login)	Returns the checked-out documents by the user
List<Dataset>	getUserDatasets(String login)	Returns the datasets assigned to the user
List<UserRole>	getUserRoles(String login)	Returns the roles with user assigned at the specified login
List<User>	getUsers(UsersFilter filter)	Returns users at the specified criteria.
List<Session>	getUserSessions(String login)	Returns the sessions assigned to the user
User	setUser(User user)	Modifies existing user
List<Dataset>	setUserDatasets(String login, List<Dataset> datasets)	Modifies the datasets assigned to the user
List<User>	setUsers(List<User> users)	Modifies existing users
List<UserRole>	setUserToRoles(String login, List<UserRole> roles)	Modifies role assignment to the specified user

Method Details

getUserByID

User getUserByID(String login)
          throws ServiceException,
ResourceNotFoundException

Returns the user at the specified login

Parameters:

login - login of the user

Returns:

User

Throws:

ServiceException

ResourceNotFoundException

deleteUserByID

boolean deleteUserByID(String login)
                throws ServiceException

Deletes the user from the system at the specified login

Parameters:

login - login of the user

Returns:

boolean true if done successfully

Throws:

ServiceException

setUser

User setUser(User user)
      throws ServiceException

Modifies existing user

Parameters:

user - object with user data to modify

Returns:

User object after modification

Throws:

ServiceException

See Also:

• User

getUsers

List<User> getUsers(UsersFilter filter)
             throws ServiceException

Returns users at the specified criteria.

Parameters:

filter - filter object

Returns:

List of Users

Throws:

ServiceException

addUsers

List<User> addUsers(List<User> users)
             throws ServiceException

Adds a new users

Parameters:

users - List of Users to create

Returns:

List of Users

Throws:

ServiceException

See Also:

• User

setUsers

List<User> setUsers(List<User> users)
             throws ServiceException

Modifies existing users

Parameters:

users - List of Users to modify

Returns:

List of users after modification

Throws:

ServiceException

See Also:

• User

getUserRoles

List<UserRole> getUserRoles(String login)
                     throws ServiceException

Returns the roles with user assigned at the specified login

Parameters:

login - login of the user

Returns:

List of Roles

Throws:

ServiceException

See Also:

• UserRole

setUserToRoles

List<UserRole> setUserToRoles(String login,
 List<UserRole> roles)
                       throws ServiceException

Modifies role assignment to the specified user

If we want remove user from the role, we should set delete flag of the role to "1"

Parameters:

login - login of the user

roles - List of UserRole to modify

Returns:

List of Roles after modification

Throws:

ServiceException

See Also:

• UserRole

getUserSessions

List<Session> getUserSessions(String login)
                       throws ServiceException

Returns the sessions assigned to the user

Parameters:

login - login of the user

Returns:

List of Session

Throws:

ServiceException

See Also:

• Session

getUserCheckedoutDocuments

List<CheckedoutDocument> getUserCheckedoutDocuments(String login)
                                             throws ServiceException

Returns the checked-out documents by the user

Parameters:

login - login of the user

Returns:

List of CheckoutDocument

Throws:

ServiceException

See Also:

• CheckedoutDocument

getUserDatasets

List<Dataset> getUserDatasets(String login)
                       throws ServiceException

Returns the datasets assigned to the user

Parameters:

login - login of the user

Returns:

List of Dataset

Throws:

ServiceException

See Also:

• Dataset

setUserDatasets

List<Dataset> setUserDatasets(String login,
 List<Dataset> datasets)
                       throws ServiceException

Modifies the datasets assigned to the user

If we want remove dataset assignment from the user, we should set delete flag of the Dataset to "1"

Parameters:

login - login of the user

Returns:

List of Dataset

Throws:

ServiceException

See Also:

• Dataset

getUserAccessRights

List<UserAccessRight> getUserAccessRights(String login,
 String rightId)
                                   throws ServiceException

Returns the access rights (with permissions) assigned to the user

Parameters:

login - login of the user

rightId - - optional, if not empty we can get specified right of the user

Returns:

List of UserAccessRight

Throws:

ServiceException

See Also:

• UserAccessRight