Package org.ametys.core.user.directory
Interface ModifiableUserDirectory
- All Superinterfaces:
Model
,ModelItemAccessor
,ModelItemContainer
,UserDirectory
- All Known Implementing Classes:
JdbcUserDirectory
Abstraction for getting users list and verify the presence of a particular
user and finally modifying this list.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a new user to the list.getView()
Retrieve the view of the Modelvoid
Remove an user from the list.void
Modify informations about an user of the list.Validate user information.Methods inherited from interface org.ametys.runtime.model.Model
getFamilyId, getId
Methods inherited from interface org.ametys.runtime.model.ModelItemAccessor
getChild, getModelItem, getModelItems, hasModelItem
Methods inherited from interface org.ametys.core.user.directory.UserDirectory
checkCredentials, getId, getLabel, getParameterValues, getPopulationId, getUser, getUserByEmail, getUserDirectoryModelId, getUsers, getUsers, init, isCaseSensitive, setPopulationId
-
Method Details
-
add
Add a new user to the list.- Parameters:
userInformation
- Informations about the user, see implementation. Cannot be null.- Throws:
InvalidModificationException
- if the login exists yet or if at least one of the parameter is invalid.
-
update
Modify informations about an user of the list.- Parameters:
userInformation
- New informations about the user, see implementation. Cannot be null.- Throws:
InvalidModificationException
- if the login does not match in the list or if at least one of the parameter is invalid.
-
remove
Remove an user from the list.- Parameters:
login
- The user's login. Cannot be null.- Throws:
InvalidModificationException
- if the user cannot be removed
-
validate
Validate user information.- Parameters:
userInformation
- Informations about the user, see implementation. Cannot be null.- Returns:
- validation errors.
-
getView
Retrieve the view of the Model- Returns:
- The View
-