com.saperion.ngc.model.users

Interface UserManagementService

All Superinterfaces:

Service

All Known Implementing Classes:

UserManagementClassicConnectorService

public interface UserManagementService
extends Service

Service that provides methods that provide access to the user-management API.

Method Summary

Modifier and Type	Method and Description
com.saperion.jcs.modules.users.api.User	findUserById(int id) Finds a user by ID.
com.saperion.jcs.modules.users.api.User	findUserByName(String name) Finds a user by name.

Methods inherited from interface com.saperion.ngc.model.Service

isActive

Method Detail

findUserByName

com.saperion.jcs.modules.users.api.User findUserByName(String name)
                                                throws AuthenticationException,
                                                       UserSearchFailedException

Finds a user by name.

Parameters:

name - name to search for

Returns:

found user or null if not found

Throws:

AuthenticationException - not logged in or insufficient rights

UserSearchFailedException - error when searching for user

findUserById

com.saperion.jcs.modules.users.api.User findUserById(int id)
                                              throws AuthenticationException,
                                                     UserSearchFailedException

Finds a user by ID.

Parameters:

id - ID to search for

Returns:

found user or null if not found

Throws:

AuthenticationException - not logged in or insufficient rights

UserSearchFailedException - error when searching for user