de.alpharogroup.user.management.service.api

Interface UsersManagementService

All Superinterfaces:

Serializable, de.alpharogroup.auth.usermanagement.UserExistenceService

All Known Implementing Classes:

UsersManagementBusinessService

public interface UsersManagementService
extends de.alpharogroup.auth.usermanagement.UserExistenceService

The interface UsersManagementService.

Author:

Asterios Raptis

Method Summary

Modifier and Type	Method and Description
de.alpharogroup.user.management.entities.Users	addUserContact(de.alpharogroup.user.management.entities.Users user, de.alpharogroup.user.management.entities.Users contact) Adds the given contact Users object to the contacts of the given Users object.
de.alpharogroup.user.management.entities.UserDatas	deleteAddress(de.alpharogroup.address.book.entities.Addresses address, de.alpharogroup.user.management.entities.UserDatas ud) Deletes the given Addresses object from the given UserDatas object.
de.alpharogroup.user.management.entities.UserDatas	deleteBlacklisted(de.alpharogroup.user.management.entities.Users blacklisted, Integer userDataId) Deletes the given black listed Users object from the given user data id.
void	deleteResource(de.alpharogroup.resource.system.application.model.ResourcesModel resource, Integer userDataId) Deletes the Resources object from the given resource model object with the given user data id.
boolean	existsUserWithEmail(de.alpharogroup.user.management.entities.Contactmethods emailContact) Checks if a user exists with the given email.
List<de.alpharogroup.address.book.entities.Addresses>	findAddessesFromUser(de.alpharogroup.user.management.entities.Users user) Find all Addresses from the given Users.
de.alpharogroup.address.book.entities.Addresses	findAddressFromUser(de.alpharogroup.user.management.entities.Users user) Find the main Addresses from the given Users.
List<de.alpharogroup.user.management.entities.Contactmethods>	findAllEmailContactmethodsFromUser(de.alpharogroup.user.management.entities.Users user) Find all email contacts from the given Users.
List<de.alpharogroup.user.management.entities.Contactmethods>	findAllFaxContactmethodsFromUser(de.alpharogroup.user.management.entities.Users user) Find all fax contacts from the given Users.
List<de.alpharogroup.user.management.entities.Contactmethods>	findAllInternetContactmethodsFromUser(de.alpharogroup.user.management.entities.Users user) Find all internet contacts from the given Users.
List<de.alpharogroup.user.management.entities.Contactmethods>	findAllMobileContactmethodsFromUser(de.alpharogroup.user.management.entities.Users user) Find all mobile contacts from user.
List<de.alpharogroup.user.management.entities.Contactmethods>	findAllTelefonContactmethodsFromUser(de.alpharogroup.user.management.entities.Users user) Find all telefon contacts from the given Users.
de.alpharogroup.user.management.entities.Contactmethods	findEmailContactFromUser(de.alpharogroup.user.management.entities.Users user) Find email contact from the given Users.
de.alpharogroup.user.management.entities.Contactmethods	findFaxContactFromUser(de.alpharogroup.user.management.entities.Users user) Find fax contact from the given Users.
de.alpharogroup.user.management.entities.Contactmethods	findInternetContactFromUser(de.alpharogroup.user.management.entities.Users user) Find internet contact from the given Users.
de.alpharogroup.user.management.entities.Contactmethods	findMobileContactFromUser(de.alpharogroup.user.management.entities.Users user) Find mobile contact from the given Users.
List<de.alpharogroup.user.management.entities.Roles>	findRolesFromUser(de.alpharogroup.user.management.entities.Users user) Find roles from the given Users.
de.alpharogroup.user.management.entities.Contactmethods	findTelefonContactFromUser(de.alpharogroup.user.management.entities.Users user) Find telefon contact from the given Users.
de.alpharogroup.user.management.entities.Users	findUserWithEmail(String email) Find the Users object with the given email.
de.alpharogroup.user.management.entities.Users	findUserWithEmailOrUsername(String emailOrUsername) Find Users object from the given email or user name.
de.alpharogroup.user.management.entities.Users	findUserWithUsername(String username) Find Users object from the given user name.
boolean	isInRole(String rolename, List<de.alpharogroup.user.management.entities.Roles> roles) Checks if a Roles object exist in the given list with the given role name.
boolean	isUserInRole(de.alpharogroup.user.management.entities.Users user, String rolename) Checks if the given Users object is in the given role from the given role name.
de.alpharogroup.resource.system.entities.Resources	persistResource(de.alpharogroup.resource.system.application.model.ResourcesModel resourceModel, Integer userId) Persist the given resource model object with the given user id.
void	saveAddressesFromUser(de.alpharogroup.user.management.entities.Users user, Collection<de.alpharogroup.address.book.entities.Addresses> addresses) Persist the given collection of Addresses objects from the given Users object.
void	saveAddressFromUser(de.alpharogroup.user.management.entities.Users user, de.alpharogroup.address.book.entities.Addresses address) Persist the given Addresses object from the given Users object.
Serializable	saveNewUser(de.alpharogroup.user.management.entities.Users user) Persist the given Users object.
Serializable	saveUserOnlyWithEmail(de.alpharogroup.user.management.entities.Users user) Persist the given Users object without checking the user name.
de.alpharogroup.user.management.entities.Contactmethods	saveUserWithContactmethod(de.alpharogroup.user.management.entities.Users user, de.alpharogroup.user.management.entities.Contactmethods contact) Persist the given Contactmethods object to the given Users object contacts.
List<de.alpharogroup.user.management.entities.Contactmethods>	saveUserWithContactmethods(de.alpharogroup.user.management.entities.Users user, List<de.alpharogroup.user.management.entities.Contactmethods> contacts) Persist the given list of Contactmethods objects to the given Users object contacts.
void	saveUserWithRoles(de.alpharogroup.user.management.entities.Users user, Collection<de.alpharogroup.user.management.entities.Roles> roles) Persist the given Users object with the given collection of Roles objects.
de.alpharogroup.user.management.entities.Contactmethods	setEmail(String email, de.alpharogroup.user.management.entities.Users user) Update email from the given Users object if the email has changed and return the new contactMethod object or the contactMethod that is persist in database.
boolean	setUsername(String username, de.alpharogroup.user.management.entities.Users user) Sets a new user name to the the given Users object.
SignUpUserResult	signUpUser(de.alpharogroup.auth.models.UsernameSignUpModel model, Set<de.alpharogroup.user.management.entities.Roles> roles, UserModel userModel) Sign up process for insert a new user in the database.
de.alpharogroup.user.management.entities.Contactmethods	updateContactmethod(String contactmethodValue, de.alpharogroup.user.management.enums.ContactmethodType contactmethodType, de.alpharogroup.user.management.entities.Contactmethods contactmethod) Update an existing Contactmethods object.
boolean	updateUsername(String username, de.alpharogroup.user.management.entities.Users user) Update user name from the given Users object if the user name has changed.
boolean	userIsInRole(de.alpharogroup.user.management.entities.Users user, de.alpharogroup.user.management.entities.Roles role) Checks if the given Users object is in the given Roles object.
de.alpharogroup.auth.models.ValidationErrors	validate(de.alpharogroup.auth.models.UsernameSignUpModel model) Validate the given UsernameSignUpModel object.

Methods inherited from interface de.alpharogroup.auth.usermanagement.UserExistenceService

existsUserWithEmail, existsUserWithEmailOrUsername, existsUserWithEmailOrUsername, existsUserWithUsername

Method Detail

isInRole

boolean isInRole(String rolename,
                 List<de.alpharogroup.user.management.entities.Roles> roles)

Checks if a Roles object exist in the given list with the given role name.

Parameters:

rolename - the role name

roles - the roles

Returns:

true, if the Roles object exist in the list otherwise false.

existsUserWithEmail

boolean existsUserWithEmail(de.alpharogroup.user.management.entities.Contactmethods emailContact)

Checks if a user exists with the given email.

Parameters:

emailContact - the email contact

Returns:

true, if successful

findAddessesFromUser

List<de.alpharogroup.address.book.entities.Addresses> findAddessesFromUser(de.alpharogroup.user.management.entities.Users user)

Find all Addresses from the given Users.

Parameters:

user - the user

Returns:

the list of found Addresses from the given Users.

findAddressFromUser

de.alpharogroup.address.book.entities.Addresses findAddressFromUser(de.alpharogroup.user.management.entities.Users user)

Find the main Addresses from the given Users.

Parameters:

user - the user

Returns:

the main Addresses from the given Users.

findAllEmailContactmethodsFromUser

List<de.alpharogroup.user.management.entities.Contactmethods> findAllEmailContactmethodsFromUser(de.alpharogroup.user.management.entities.Users user)

Find all email contacts from the given Users.

Parameters:

user - the user

Returns:

the list of found Contactmethods from the given Users.

findAllFaxContactmethodsFromUser

List<de.alpharogroup.user.management.entities.Contactmethods> findAllFaxContactmethodsFromUser(de.alpharogroup.user.management.entities.Users user)

Find all fax contacts from the given Users.

Parameters:

user - the user

Returns:

the list of found Contactmethods from the given Users.

findAllInternetContactmethodsFromUser

List<de.alpharogroup.user.management.entities.Contactmethods> findAllInternetContactmethodsFromUser(de.alpharogroup.user.management.entities.Users user)

Find all internet contacts from the given Users.

Parameters:

user - the user

Returns:

the list of found Contactmethods from the given Users.

findAllMobileContactmethodsFromUser

List<de.alpharogroup.user.management.entities.Contactmethods> findAllMobileContactmethodsFromUser(de.alpharogroup.user.management.entities.Users user)

Find all mobile contacts from user.

Parameters:

user - the user

Returns:

the list of found Contactmethods from the given Users.

findAllTelefonContactmethodsFromUser

List<de.alpharogroup.user.management.entities.Contactmethods> findAllTelefonContactmethodsFromUser(de.alpharogroup.user.management.entities.Users user)

Find all telefon contacts from the given Users.

Parameters:

user - the user

Returns:

the list of found Contactmethods from the given Users.

findEmailContactFromUser

de.alpharogroup.user.management.entities.Contactmethods findEmailContactFromUser(de.alpharogroup.user.management.entities.Users user)

Find email contact from the given Users.

Parameters:

user - the user

Returns:

the found Contactmethods from the given Users.

findFaxContactFromUser

de.alpharogroup.user.management.entities.Contactmethods findFaxContactFromUser(de.alpharogroup.user.management.entities.Users user)

Find fax contact from the given Users.

Parameters:

user - the user

Returns:

the found Contactmethods from the given Users.

findInternetContactFromUser

de.alpharogroup.user.management.entities.Contactmethods findInternetContactFromUser(de.alpharogroup.user.management.entities.Users user)

Find internet contact from the given Users.

Parameters:

user - the user

Returns:

the found Contactmethods from the given Users.

findMobileContactFromUser

de.alpharogroup.user.management.entities.Contactmethods findMobileContactFromUser(de.alpharogroup.user.management.entities.Users user)

Find mobile contact from the given Users.

Parameters:

user - the user

Returns:

the found Contactmethods from the given Users.

findRolesFromUser

List<de.alpharogroup.user.management.entities.Roles> findRolesFromUser(de.alpharogroup.user.management.entities.Users user)

Find roles from the given Users.

Parameters:

user - the user

Returns:

the list of found Roles from the given Users.

findTelefonContactFromUser

de.alpharogroup.user.management.entities.Contactmethods findTelefonContactFromUser(de.alpharogroup.user.management.entities.Users user)

Find telefon contact from the given Users.

Parameters:

user - the user

Returns:

the found Contactmethods from the given Users.

findUserWithEmail

de.alpharogroup.user.management.entities.Users findUserWithEmail(String email)

Find the Users object with the given email.

Parameters:

email - the email

Returns:

the found Users object

findUserWithEmailOrUsername

de.alpharogroup.user.management.entities.Users findUserWithEmailOrUsername(String emailOrUsername)

Find Users object from the given email or user name.

Parameters:

emailOrUsername - the email or user name

Returns:

the found Users object

findUserWithUsername

de.alpharogroup.user.management.entities.Users findUserWithUsername(String username)

Find Users object from the given user name.

Parameters:

username - the user name

Returns:

the found Users object

isUserInRole

boolean isUserInRole(de.alpharogroup.user.management.entities.Users user,
                     String rolename)

Checks if the given Users object is in the given role from the given role name.

Parameters:

user - the user

rolename - the role name

Returns:

true, if the given Users object is in role otherwise false.

saveAddressesFromUser

void saveAddressesFromUser(de.alpharogroup.user.management.entities.Users user,
                           Collection<de.alpharogroup.address.book.entities.Addresses> addresses)

Persist the given collection of Addresses objects from the given Users object.

Parameters:

user - the user

addresses - the addresses

saveAddressFromUser

void saveAddressFromUser(de.alpharogroup.user.management.entities.Users user,
                         de.alpharogroup.address.book.entities.Addresses address)

Persist the given Addresses object from the given Users object.

Parameters:

user - the user

address - the address

saveNewUser

Serializable saveNewUser(de.alpharogroup.user.management.entities.Users user)
                  throws de.alpharogroup.auth.exceptions.UserAlreadyExistsException

Persist the given Users object.

Parameters:

user - The Users object to persist.

Returns:

the id of the persisted Users object.

Throws:

de.alpharogroup.auth.exceptions.UserAlreadyExistsException - Thrown if the given Users object already exists in the database.

saveUserOnlyWithEmail

Serializable saveUserOnlyWithEmail(de.alpharogroup.user.management.entities.Users user)
                            throws de.alpharogroup.auth.exceptions.UserAlreadyExistsException

Persist the given Users object without checking the user name.

Parameters:

user - The Users object to persist.

Returns:

the id of the persisted Users object.

Throws:

de.alpharogroup.auth.exceptions.UserAlreadyExistsException - Thrown if the given Users object already exists in the database.

saveUserWithContactmethod

de.alpharogroup.user.management.entities.Contactmethods saveUserWithContactmethod(de.alpharogroup.user.management.entities.Users user,
                                                                                  de.alpharogroup.user.management.entities.Contactmethods contact)
                                                                           throws BatchUpdateException

Persist the given Contactmethods object to the given Users object contacts.

Parameters:

user - the user

contact - the contact

Returns:

the persisted Contactmethods object.

Throws:

BatchUpdateException - the batch update exception

saveUserWithContactmethods

List<de.alpharogroup.user.management.entities.Contactmethods> saveUserWithContactmethods(de.alpharogroup.user.management.entities.Users user,
                                                                                         List<de.alpharogroup.user.management.entities.Contactmethods> contacts)
                                                                                  throws BatchUpdateException

Persist the given list of Contactmethods objects to the given Users object contacts.

Parameters:

user - the user

contacts - the contacts

Returns:

the persisted list of Contactmethods objects.

Throws:

BatchUpdateException - the batch update exception

saveUserWithRoles

void saveUserWithRoles(de.alpharogroup.user.management.entities.Users user,
                       Collection<de.alpharogroup.user.management.entities.Roles> roles)

Persist the given Users object with the given collection of Roles objects.

Parameters:

user - the user

roles - the roles

setEmail

de.alpharogroup.user.management.entities.Contactmethods setEmail(String email,
                                                                 de.alpharogroup.user.management.entities.Users user)
                                                          throws de.alpharogroup.auth.exceptions.EmailAlreadyExistsException

Update email from the given Users object if the email has changed and return the new contactMethod object or the contactMethod that is persist in database. Consider to check if the email already exists before you call this method otherwise an exception is thrown.

Parameters:

email - the email

user - the user

Returns:

the Contactmethods object

Throws:

de.alpharogroup.auth.exceptions.EmailAlreadyExistsException - the email already exists exception

setUsername

boolean setUsername(String username,
                    de.alpharogroup.user.management.entities.Users user)
             throws de.alpharogroup.auth.exceptions.UserAlreadyExistsException

Sets a new user name to the the given Users object.

Parameters:

username - the username

user - the user

Returns:

true, if successful

Throws:

de.alpharogroup.auth.exceptions.UserAlreadyExistsException - is thrown if the user already exists with the given user name.

updateContactmethod

de.alpharogroup.user.management.entities.Contactmethods updateContactmethod(String contactmethodValue,
                                                                            de.alpharogroup.user.management.enums.ContactmethodType contactmethodType,
                                                                            de.alpharogroup.user.management.entities.Contactmethods contactmethod)

Update an existing Contactmethods object. If the contact method has changed the new Contactmethods object will be returned or null if nothing changed.

Parameters:

contactmethodValue - the contact method value

contactmethodType - the contact method type

contactmethod - the contact method

Returns:

the Contactmethods object

updateUsername

boolean updateUsername(String username,
                       de.alpharogroup.user.management.entities.Users user)
                throws de.alpharogroup.auth.exceptions.UserAlreadyExistsException

Update user name from the given Users object if the user name has changed. Returns true if the user name has changed otherwise false.

Parameters:

username - the user name

user - the user

Returns:

Returns true if the user name has changed otherwise false.

Throws:

de.alpharogroup.auth.exceptions.UserAlreadyExistsException - is thrown if the user already exists with the given user name.

userIsInRole

boolean userIsInRole(de.alpharogroup.user.management.entities.Users user,
                     de.alpharogroup.user.management.entities.Roles role)

Checks if the given Users object is in the given Roles object.

Parameters:

user - the user

role - the role

Returns:

true, if successful

validate

de.alpharogroup.auth.models.ValidationErrors validate(de.alpharogroup.auth.models.UsernameSignUpModel model)

Validate the given UsernameSignUpModel object.

Parameters:

model - the UsernameSignUpModel object.

Returns:

A ValidationErrors object if validation fail otherwise null if the validation is successful.

signUpUser

SignUpUserResult signUpUser(de.alpharogroup.auth.models.UsernameSignUpModel model,
                            Set<de.alpharogroup.user.management.entities.Roles> roles,
                            UserModel userModel)

Sign up process for insert a new user in the database.

Parameters:

model - the model

roles - the roles

userModel - the user model

Returns:

the SignUpUserResult object with the result of the sign up process

persistResource

de.alpharogroup.resource.system.entities.Resources persistResource(de.alpharogroup.resource.system.application.model.ResourcesModel resourceModel,
                                                                   Integer userId)

Persist the given resource model object with the given user id.

Parameters:

resourceModel - the resource model

userId - the user id

Returns:

the persisted Resources object

deleteResource

void deleteResource(de.alpharogroup.resource.system.application.model.ResourcesModel resource,
                    Integer userDataId)

Deletes the Resources object from the given resource model object with the given user data id.

Parameters:

resource - the resource

userDataId - the user data id

deleteBlacklisted

de.alpharogroup.user.management.entities.UserDatas deleteBlacklisted(de.alpharogroup.user.management.entities.Users blacklisted,
                                                                     Integer userDataId)

Deletes the given black listed Users object from the given user data id.

Parameters:

blacklisted - the black listed user

userDataId - the user data id

Returns:

the UserDatas object.

deleteAddress

de.alpharogroup.user.management.entities.UserDatas deleteAddress(de.alpharogroup.address.book.entities.Addresses address,
                                                                 de.alpharogroup.user.management.entities.UserDatas ud)

Deletes the given Addresses object from the given UserDatas object.

Parameters:

address - the Addresses object

ud - the UserDatas object

Returns:

the UserDatas object.

addUserContact

de.alpharogroup.user.management.entities.Users addUserContact(de.alpharogroup.user.management.entities.Users user,
                                                              de.alpharogroup.user.management.entities.Users contact)

Adds the given contact Users object to the contacts of the given Users object.

Parameters:

user - the user

contact - the contact to add

Returns:

the Users object with the new contacts.