de.alpharogroup.user.management.rest.api

Interface UserManagementResource

All Known Implementing Classes:

UserManagementRestResource

@Path(value="/usermanagement/")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public interface UserManagementResource

The interface UserManagementResource provides methods for authenticate users of a given application.

Method Summary

Modifier and Type	Method and Description
de.alpharogroup.user.domain.User	addUserContact(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,de.alpharogroup.user.domain.User> saveModel) Adds the given contact User object to the contacts of the given User object.
de.alpharogroup.user.management.domain.UserData	deleteAddress(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.address.book.domain.Address,de.alpharogroup.user.management.domain.UserData> deleteModel) Deletes the given Address object from the given UserData object.
de.alpharogroup.user.management.domain.UserData	deleteBlacklisted(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,Integer> deleteModel) Deletes the given black listed User object from the given user data id.
void	deleteResource(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.resource.system.application.model.ResourcesModel,Integer> deleteModel) Deletes the Resource object from the given resource model object with the given user data id.
boolean	existsUserWithEmail(de.alpharogroup.user.management.domain.Contactmethod emailContact) Checks if a user exists with the given email.
boolean	existsUserWithEmail(String email) Checks if a user exists with the given email.
de.alpharogroup.auth.enums.InsertUserState	existsUserWithEmailOrUsername(de.alpharogroup.collections.pairs.KeyValuePair<String,String> searchModel) Checks if a user exists with the given email or user name.
boolean	existsUserWithEmailOrUsername(String emailOrUsername) Checks if a user exists with the given email or user name.
boolean	existsUserWithUsername(String username) Checks if a user exists with the given user name.
List<de.alpharogroup.address.book.domain.Address>	findAddessesFromUser(de.alpharogroup.user.domain.User user) Find all Address from the given User.
de.alpharogroup.address.book.domain.Address	findAddressFromUser(de.alpharogroup.user.domain.User user) Find the main Address from the given User.
List<de.alpharogroup.user.management.domain.Contactmethod>	findAllEmailContactmethodsFromUser(de.alpharogroup.user.domain.User user) Find all email contacts from the given User.
List<de.alpharogroup.user.management.domain.Contactmethod>	findAllFaxContactmethodsFromUser(de.alpharogroup.user.domain.User user) Find all fax contacts from the given User.
List<de.alpharogroup.user.management.domain.Contactmethod>	findAllInternetContactmethodsFromUser(de.alpharogroup.user.domain.User user) Find all internet contacts from the given User.
List<de.alpharogroup.user.management.domain.Contactmethod>	findAllMobileContactmethodsFromUser(de.alpharogroup.user.domain.User user) Find all mobile contacts from user.
List<de.alpharogroup.user.management.domain.Contactmethod>	findAllTelefonContactmethodsFromUser(de.alpharogroup.user.domain.User user) Find all telefon contacts from the given User.
de.alpharogroup.user.management.domain.Contactmethod	findEmailContactFromUser(de.alpharogroup.user.domain.User user) Find email contact from the given User.
de.alpharogroup.user.management.domain.Contactmethod	findFaxContactFromUser(de.alpharogroup.user.domain.User user) Find fax contact from the given User.
de.alpharogroup.user.management.domain.Contactmethod	findInternetContactFromUser(de.alpharogroup.user.domain.User user) Find internet contact from the given User.
de.alpharogroup.user.management.domain.Contactmethod	findMobileContactFromUser(de.alpharogroup.user.domain.User user) Find mobile contact from the given User.
List<de.alpharogroup.user.domain.Role>	findRolesFromUser(de.alpharogroup.user.domain.User user) Find roles from the given User.
de.alpharogroup.user.management.domain.Contactmethod	findTelefonContactFromUser(de.alpharogroup.user.domain.User user) Find telefon contact from the given User.
de.alpharogroup.user.domain.User	findUserWithEmail(String email) Find the User object with the given email.
de.alpharogroup.user.domain.User	findUserWithEmailOrUsername(String emailOrUsername) Find User object from the given email or user name.
de.alpharogroup.user.domain.User	findUserWithUsername(String username) Find User object from the given user name.
boolean	isInRole(de.alpharogroup.collections.pairs.KeyValuePair<String,List<de.alpharogroup.user.domain.Role>> roleSearchModel) Checks if a Role object exist in the given list with the given role name.
boolean	isUserInRole(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,String> userSearchModel) Checks if the given User object is in the given role from the given role name.
de.alpharogroup.resource.system.domain.Resource	persistResource(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.resource.system.application.model.ResourcesModel,Integer> saveModel) Persist the given resource model object with the given user id.
void	saveAddressesFromUser(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,Collection<de.alpharogroup.address.book.domain.Address>> userSaveModel) Persist the given collection of Address objects from the given User object.
void	saveAddressFromUser(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,de.alpharogroup.address.book.domain.Address> userSaveModel) Persist the given Address object from the given User object.
Serializable	saveNewUser(de.alpharogroup.user.domain.User user) Persist the given User object.
Serializable	saveUserOnlyWithEmail(de.alpharogroup.user.domain.User user) Persist the given User object without checking the user name.
de.alpharogroup.user.management.domain.Contactmethod	saveUserWithContactmethod(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,de.alpharogroup.user.management.domain.Contactmethod> userSaveModel) Persist the given Contactmethod object to the given User object contacts.
List<de.alpharogroup.user.management.domain.Contactmethod>	saveUserWithContactmethods(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,List<de.alpharogroup.user.management.domain.Contactmethod>> userSaveModel) Persist the given list of Contactmethod objects to the given User object contacts.
void	saveUserWithRoles(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,Collection<de.alpharogroup.user.domain.Role>> userSaveModel) Persist the given User object with the given collection of Role objects.
de.alpharogroup.user.management.domain.Contactmethod	setEmail(de.alpharogroup.collections.pairs.KeyValuePair<String,de.alpharogroup.user.domain.User> userSaveModel) Update email from the given User object if the email has changed and return the new contactMethod object or the contactMethod that is persist in database.
boolean	setUsername(de.alpharogroup.collections.pairs.KeyValuePair<String,de.alpharogroup.user.domain.User> userSaveModel) Sets a new user name to the the given User object.
de.alpharogroup.user.management.sign.up.SignUpUserResult	signUpUser(de.alpharogroup.collections.pairs.Triple<de.alpharogroup.auth.models.UsernameSignUpModel,Set<de.alpharogroup.user.domain.Role>,de.alpharogroup.user.management.sign.up.UserModel> saveModel) Sign up process for insert a new user in the database.
de.alpharogroup.user.management.domain.Contactmethod	updateContactmethod(de.alpharogroup.collections.pairs.Triple<String,de.alpharogroup.user.management.enums.ContactmethodType,de.alpharogroup.user.management.domain.Contactmethod> updateModel) Update an existing Contactmethod object.
boolean	updateUsername(de.alpharogroup.collections.pairs.KeyValuePair<String,de.alpharogroup.user.domain.User> updateModel) Update user name from the given User object if the user name has changed.
boolean	userIsInRole(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,de.alpharogroup.user.domain.Role> searchModel) Checks if the given User object is in the given Role object.
de.alpharogroup.auth.models.ValidationErrors	validate(de.alpharogroup.auth.models.UsernameSignUpModel model) Validate the given UsernameSignUpModel object.

Method Detail

addUserContact

@POST
 @Path(value="/add/user/contact")
de.alpharogroup.user.domain.User addUserContact(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,de.alpharogroup.user.domain.User> saveModel)

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

Parameters:

saveModel - the KeyValuePair object that encapsulate the user and the contact

Returns:

the User object with the new contacts.

deleteAddress

@POST
 @Path(value="/delete/address")
de.alpharogroup.user.management.domain.UserData deleteAddress(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.address.book.domain.Address,de.alpharogroup.user.management.domain.UserData> deleteModel)

Deletes the given Address object from the given UserData object.

Parameters:

deleteModel - the KeyValuePair object that encapsulate the Address object and the UserData object

Returns:

the UserData object.

deleteBlacklisted

@POST
 @Path(value="/delete/blacklisted")
de.alpharogroup.user.management.domain.UserData deleteBlacklisted(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,Integer> deleteModel)

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

Parameters:

deleteModel - the KeyValuePair object that encapsulate the black listed user and the user data id

Returns:

the UserData object.

deleteResource

@POST
 @Path(value="/delete/resource")
void deleteResource(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.resource.system.application.model.ResourcesModel,Integer> deleteModel)

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

Parameters:

deleteModel - the KeyValuePair object that encapsulate the resource and the user data id

existsUserWithEmail

@POST
 @Path(value="/exists/user/by/email")
boolean existsUserWithEmail(de.alpharogroup.user.management.domain.Contactmethod emailContact)

Checks if a user exists with the given email.

Parameters:

emailContact - the email contact

Returns:

true, if successful

existsUserWithEmail

@GET
 @Path(value="/exists/user/with/email/{email}")
boolean existsUserWithEmail(@PathParam(value="email")
                                                                                 String email)

Checks if a user exists with the given email.

Parameters:

email - the email

Returns:

true, if successful

existsUserWithEmailOrUsername

@POST
 @Path(value="/exists/user/with/email/or/username")
de.alpharogroup.auth.enums.InsertUserState existsUserWithEmailOrUsername(de.alpharogroup.collections.pairs.KeyValuePair<String,String> searchModel)

Checks if a user exists with the given email or user name.

Parameters:

searchModel - the KeyValuePair object that encapsulate the email and the user name

Returns:

the resulted InsertUserState object.

existsUserWithEmailOrUsername

@GET
 @Path(value="/exists/user/with/emailOrUsername/{emailOrUsername}")
boolean existsUserWithEmailOrUsername(@PathParam(value="emailOrUsername")
                                                                                                               String emailOrUsername)

Checks if a user exists with the given email or user name.

Parameters:

emailOrUsername - the email or user name

Returns:

true, if successful

existsUserWithUsername

@GET
 @Path(value="/exists/user/with/username/{username}")
boolean existsUserWithUsername(@PathParam(value="username")
                                                                                          String username)

Checks if a user exists with the given user name.

Parameters:

username - the user name

Returns:

true, if successful

findAddessesFromUser

@POST
 @Path(value="/find/addresses")
List<de.alpharogroup.address.book.domain.Address> findAddessesFromUser(de.alpharogroup.user.domain.User user)

Find all Address from the given User.

Parameters:

user - the user

Returns:

the list of found Address from the given User.

findAddressFromUser

@POST
 @Path(value="/find/address")
de.alpharogroup.address.book.domain.Address findAddressFromUser(de.alpharogroup.user.domain.User user)

Find the main Address from the given User.

Parameters:

user - the user

Returns:

the main Address from the given User.

findAllEmailContactmethodsFromUser

@POST
 @Path(value="/find/all/emails")
List<de.alpharogroup.user.management.domain.Contactmethod> findAllEmailContactmethodsFromUser(de.alpharogroup.user.domain.User user)

Find all email contacts from the given User.

Parameters:

user - the user

Returns:

the list of found Contactmethod from the given User.

findAllFaxContactmethodsFromUser

@POST
 @Path(value="/find/all/faxes")
List<de.alpharogroup.user.management.domain.Contactmethod> findAllFaxContactmethodsFromUser(de.alpharogroup.user.domain.User user)

Find all fax contacts from the given User.

Parameters:

user - the user

Returns:

the list of found Contactmethod from the given User.

findAllInternetContactmethodsFromUser

@POST
 @Path(value="/find/all/internets")
List<de.alpharogroup.user.management.domain.Contactmethod> findAllInternetContactmethodsFromUser(de.alpharogroup.user.domain.User user)

Find all internet contacts from the given User.

Parameters:

user - the user

Returns:

the list of found Contactmethod from the given User.

findAllMobileContactmethodsFromUser

@POST
 @Path(value="/find/all/mobiles")
List<de.alpharogroup.user.management.domain.Contactmethod> findAllMobileContactmethodsFromUser(de.alpharogroup.user.domain.User user)

Find all mobile contacts from user.

Parameters:

user - the user

Returns:

the list of found Contactmethod from the given User.

findAllTelefonContactmethodsFromUser

@POST
 @Path(value="/find/all/tel")
List<de.alpharogroup.user.management.domain.Contactmethod> findAllTelefonContactmethodsFromUser(de.alpharogroup.user.domain.User user)

Find all telefon contacts from the given User.

Parameters:

user - the user

Returns:

the list of found Contactmethod from the given User.

findEmailContactFromUser

@POST
 @Path(value="/find/email")
de.alpharogroup.user.management.domain.Contactmethod findEmailContactFromUser(de.alpharogroup.user.domain.User user)

Find email contact from the given User.

Parameters:

user - the user

Returns:

the found Contactmethod from the given User.

findFaxContactFromUser

@POST
 @Path(value="/find/fax")
de.alpharogroup.user.management.domain.Contactmethod findFaxContactFromUser(de.alpharogroup.user.domain.User user)

Find fax contact from the given User.

Parameters:

user - the user

Returns:

the found Contactmethod from the given User.

findInternetContactFromUser

@POST
 @Path(value="/find/internet")
de.alpharogroup.user.management.domain.Contactmethod findInternetContactFromUser(de.alpharogroup.user.domain.User user)

Find internet contact from the given User.

Parameters:

user - the user

Returns:

the found Contactmethod from the given User.

findMobileContactFromUser

@POST
 @Path(value="/find/mobile")
de.alpharogroup.user.management.domain.Contactmethod findMobileContactFromUser(de.alpharogroup.user.domain.User user)

Find mobile contact from the given User.

Parameters:

user - the user

Returns:

the found Contactmethod from the given User.

findRolesFromUser

@POST
 @Path(value="/find/roles")
List<de.alpharogroup.user.domain.Role> findRolesFromUser(de.alpharogroup.user.domain.User user)

Find roles from the given User.

Parameters:

user - the user

Returns:

the list of found Role from the given User.

findTelefonContactFromUser

@POST
 @Path(value="/find/tel")
de.alpharogroup.user.management.domain.Contactmethod findTelefonContactFromUser(de.alpharogroup.user.domain.User user)

Find telefon contact from the given User.

Parameters:

user - the user

Returns:

the found Contactmethod from the given User.

findUserWithEmail

@GET
 @Path(value="/find/by/email/{email}")
de.alpharogroup.user.domain.User findUserWithEmail(@PathParam(value="email")
                                                                                               String email)

Find the User object with the given email.

Parameters:

email - the email

Returns:

the found User object

findUserWithEmailOrUsername

@GET
 @Path(value="/find/by/email/or/username/{emailOrUsername}")
de.alpharogroup.user.domain.User findUserWithEmailOrUsername(@PathParam(value="emailOrUsername")
                                                                                                                               String emailOrUsername)

Find User object from the given email or user name.

Parameters:

emailOrUsername - the email or user name

Returns:

the found User object

findUserWithUsername

@GET
 @Path(value="/find/by/username/{username}")
de.alpharogroup.user.domain.User findUserWithUsername(@PathParam(value="username")
                                                                                                        String username)

Find User object from the given user name.

Parameters:

username - the user name

Returns:

the found User object

isInRole

@POST
 @Path(value="/isin/role")
boolean isInRole(de.alpharogroup.collections.pairs.KeyValuePair<String,List<de.alpharogroup.user.domain.Role>> roleSearchModel)

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

Parameters:

roleSearchModel - the KeyValuePair object that encapsulate the role name and roles

Returns:

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

isUserInRole

@POST
 @Path(value="/is/user/in/role")
boolean isUserInRole(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,String> userSearchModel)

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

Parameters:

userSearchModel - the KeyValuePair object that encapsulate the user and the role name

Returns:

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

persistResource

@POST
 @Path(value="/persist/resource")
de.alpharogroup.resource.system.domain.Resource persistResource(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.resource.system.application.model.ResourcesModel,Integer> saveModel)

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

Parameters:

saveModel - the KeyValuePair object that encapsulate the ResourcesModel object and the user id.

Returns:

the persisted Resource object

saveAddressesFromUser

@POST
 @Path(value="/save/addresses")
void saveAddressesFromUser(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,Collection<de.alpharogroup.address.book.domain.Address>> userSaveModel)

Persist the given collection of Address objects from the given User object.

Parameters:

userSaveModel - the KeyValuePair object that encapsulate the user and the addresses

saveAddressFromUser

@POST
 @Path(value="/save/address")
void saveAddressFromUser(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,de.alpharogroup.address.book.domain.Address> userSaveModel)

Persist the given Address object from the given User object.

Parameters:

userSaveModel - the KeyValuePair object that encapsulate the user and the address

saveNewUser

@POST
 @Path(value="/new/user")
Serializable saveNewUser(de.alpharogroup.user.domain.User user)
                                                  throws de.alpharogroup.auth.exceptions.UserAlreadyExistsException

Persist the given User object.

Parameters:

user - The User object to persist.

Returns:

the id of the persisted User object.

Throws:

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

saveUserOnlyWithEmail

@POST
 @Path(value="/new/user/onlywith/email")
Serializable saveUserOnlyWithEmail(de.alpharogroup.user.domain.User user)
                                                                           throws de.alpharogroup.auth.exceptions.UserAlreadyExistsException

Persist the given User object without checking the user name.

Parameters:

user - The User object to persist.

Returns:

the id of the persisted User object.

Throws:

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

saveUserWithContactmethod

@POST
 @Path(value="/save/user/with/contactmethod")
de.alpharogroup.user.management.domain.Contactmethod saveUserWithContactmethod(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,de.alpharogroup.user.management.domain.Contactmethod> userSaveModel)
                                                                                                                            throws BatchUpdateException

Persist the given Contactmethod object to the given User object contacts.

Parameters:

userSaveModel - the KeyValuePair object that encapsulate the user and the contact to save

Returns:

the persisted Contactmethod object.

Throws:

BatchUpdateException - is thrown if a batch update occured

saveUserWithContactmethods

@POST
 @Path(value="/save/user/with/contactmethods")
List<de.alpharogroup.user.management.domain.Contactmethod> saveUserWithContactmethods(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,List<de.alpharogroup.user.management.domain.Contactmethod>> userSaveModel)
                                                                                                                                    throws BatchUpdateException

Persist the given list of Contactmethod objects to the given User object contacts.

Parameters:

userSaveModel - the KeyValuePair object that encapsulate the user and the contacts to save

Returns:

the persisted list of Contactmethod objects.

Throws:

BatchUpdateException - is thrown if a batch update occured

saveUserWithRoles

@POST
 @Path(value="/save/user/with/roles")
void saveUserWithRoles(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,Collection<de.alpharogroup.user.domain.Role>> userSaveModel)

Persist the given User object with the given collection of Role objects.

Parameters:

userSaveModel - the KeyValuePair object that encapsulate the user and the roles to save

setEmail

@POST
 @Path(value="/set/email")
de.alpharogroup.user.management.domain.Contactmethod setEmail(de.alpharogroup.collections.pairs.KeyValuePair<String,de.alpharogroup.user.domain.User> userSaveModel)
                                                                                        throws de.alpharogroup.auth.exceptions.EmailAlreadyExistsException

Update email from the given User 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:

userSaveModel - the KeyValuePair object that encapsulate the email and the user

Returns:

the Contactmethod object

Throws:

de.alpharogroup.auth.exceptions.EmailAlreadyExistsException - is thrown if the email already exists.

setUsername

@POST
 @Path(value="/set/username")
boolean setUsername(de.alpharogroup.collections.pairs.KeyValuePair<String,de.alpharogroup.user.domain.User> userSaveModel)
                                                 throws de.alpharogroup.auth.exceptions.UserAlreadyExistsException

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

Parameters:

userSaveModel - the KeyValuePair object that encapsulate the user name and the user to set

Returns:

true, if successful

Throws:

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

signUpUser

@POST
 @Path(value="/signup/user")
de.alpharogroup.user.management.sign.up.SignUpUserResult signUpUser(de.alpharogroup.collections.pairs.Triple<de.alpharogroup.auth.models.UsernameSignUpModel,Set<de.alpharogroup.user.domain.Role>,de.alpharogroup.user.management.sign.up.UserModel> saveModel)

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

Parameters:

saveModel - the Triple object that encapsulate the UsernameSignUpModel object, the roles and the UserModel object.

Returns:

the SignUpUserResult object with the result of the sign up process

updateContactmethod

@POST
 @Path(value="/update/contactmethod")
de.alpharogroup.user.management.domain.Contactmethod updateContactmethod(de.alpharogroup.collections.pairs.Triple<String,de.alpharogroup.user.management.enums.ContactmethodType,de.alpharogroup.user.management.domain.Contactmethod> updateModel)

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

Parameters:

updateModel - the Triple object that encapsulate the contact method value and type and the contact method to update.

Returns:

the Contactmethod object

updateUsername

@POST
 @Path(value="/update/username")
boolean updateUsername(de.alpharogroup.collections.pairs.KeyValuePair<String,de.alpharogroup.user.domain.User> updateModel)
                                                       throws de.alpharogroup.auth.exceptions.UserAlreadyExistsException

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

Parameters:

updateModel - the KeyValuePair object that encapsulate the user name and 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

@POST
 @Path(value="/user/is/in/role")
boolean userIsInRole(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,de.alpharogroup.user.domain.Role> searchModel)

Checks if the given User object is in the given Role object.

Parameters:

searchModel - the KeyValuePair object that encapsulate the user and the role

Returns:

true, if successful

validate

@POST
 @Path(value="/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.