org.cyclos.services.users

Interface UserService

All Superinterfaces:

CRUDService<UserDTO,UserData,java.lang.Long>, Service

All Known Subinterfaces:

UserServiceLocal

public interface UserService
extends CRUDService<UserDTO,UserData,java.lang.Long>

Service interface for user operations

Author:

luis

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addContact(UserLocatorVO locator) Adds the located user to the logged user's contact list, returning whether the list has changed
SerializableInputStream	exportToCSV(UserQuery params) Generates a CSV with the query result
ActiveConfigurationData	getActiveConfiguration(UserLocatorVO locator) Returns the ActiveConfigurationData, containing all the actual configuration for the user matching the given locator
UserWithRolesVO	getCurrentUser() Returns the current user logged in
UserSearchData	getSearchData(UserSearchContext context) Gets data used on the search page, according to the given search type
java.util.List<GroupVO>	getUserRegistrationGroups() Return the list of groups the logged user can register new users for
ViewProfileData	getViewProfileData(UserLocatorVO locator) Return a ViewProfileData for the user matching the given locator
UserDetailedVO	locate(UserLocatorVO locator) Locates an user by a customizable key.
void	markEmailAsValidated(UserLocatorVO locator) Marks the email as validated.
SerializableInputStream	printUsers(UserQuery query) Generates the PDF content for an user listing
UserRegistrationResult	publicRegister(PublicRegistrationDTO user) Registers an user from a public registration
UserRegistrationResult	register(UserRegistrationDTO user) Registers an user
boolean	removeContact(UserLocatorVO locator) Removes the given user to the logged user's contact list, returning whether the list has changed
void	resendEmailChangeMail(UserLocatorVO locator) Re-sends the e-mail change e-mail to an user
void	resendValidationMail(UserLocatorVO locator) Re-sends the validation mail to a pending user
Page<UserDetailedVO>	search(UserQuery query) Search users according to the specified query parameters
void	updateUserActivity(UserActivityType type) Updates user information status according to the given activity
java.lang.Long	validateEmailChange(java.lang.String validationKey) Validate an e-mail change for the given validation key, returning the affected user identifier
UserValidationData	validateRegistration(java.lang.String validationKey) Validate user registration which was pending e-mail verification, via a provided key

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

addContact

boolean addContact(UserLocatorVO locator)
                   throws FrameworkException

Adds the located user to the logged user's contact list, returning whether the list has changed

Throws:

FrameworkException

exportToCSV

SerializableInputStream exportToCSV(UserQuery params)

Generates a CSV with the query result

getActiveConfiguration

ActiveConfigurationData getActiveConfiguration(UserLocatorVO locator)
                                               throws FrameworkException

Returns the ActiveConfigurationData, containing all the actual configuration for the user matching the given locator

Throws:

FrameworkException

getCurrentUser

UserWithRolesVO getCurrentUser()
                               throws FrameworkException

Returns the current user logged in

Throws:

FrameworkException

getSearchData

UserSearchData getSearchData(UserSearchContext context)
                             throws FrameworkException

Gets data used on the search page, according to the given search type

Throws:

FrameworkException

getUserRegistrationGroups

java.util.List<GroupVO> getUserRegistrationGroups()
                                                  throws FrameworkException

Return the list of groups the logged user can register new users for

Throws:

FrameworkException

getViewProfileData

ViewProfileData getViewProfileData(UserLocatorVO locator)
                                   throws FrameworkException

Return a ViewProfileData for the user matching the given locator

Throws:

FrameworkException

locate

UserDetailedVO locate(UserLocatorVO locator)
                      throws FrameworkException

Locates an user by a customizable key. Fields are attempted in the following order (only the first non-blank field will be used for the search):

• Id
• Username
• E-mail
• Field value with field's id
• Field value with field's internal name
• Mobile phone

Throws:

ValidationException: - if the locator is invalid (there is no fields non null).

EntityNotFoundException: - if the user was not found or more than one user was found with the specified locator.

FrameworkException

markEmailAsValidated

void markEmailAsValidated(UserLocatorVO locator)
                          throws FrameworkException

Marks the email as validated. If the given user was pending it will become active.

Throws:

FrameworkException

printUsers

SerializableInputStream printUsers(UserQuery query)
                                   throws FrameworkException,
                                          ReportExecutionException,
                                          QueryParseException

Generates the PDF content for an user listing

Throws:

FrameworkException

ReportExecutionException

QueryParseException

publicRegister

UserRegistrationResult publicRegister(PublicRegistrationDTO user)
                                      throws FrameworkException

Registers an user from a public registration

Throws:

FrameworkException

register

UserRegistrationResult register(UserRegistrationDTO user)
                                throws FrameworkException

Registers an user

Throws:

FrameworkException

removeContact

boolean removeContact(UserLocatorVO locator)
                      throws FrameworkException

Removes the given user to the logged user's contact list, returning whether the list has changed

Throws:

FrameworkException

resendEmailChangeMail

void resendEmailChangeMail(UserLocatorVO locator)
                           throws FrameworkException

Re-sends the e-mail change e-mail to an user

Throws:

FrameworkException

resendValidationMail

void resendValidationMail(UserLocatorVO locator)
                          throws FrameworkException

Re-sends the validation mail to a pending user

Throws:

FrameworkException

search

Page<UserDetailedVO> search(UserQuery query)
                            throws FrameworkException,
                                   QueryParseException

Search users according to the specified query parameters

Throws:

FrameworkException

QueryParseException

updateUserActivity

void updateUserActivity(UserActivityType type)
                        throws FrameworkException

Updates user information status according to the given activity

Throws:

FrameworkException

validateEmailChange

java.lang.Long validateEmailChange(java.lang.String validationKey)
                                   throws FrameworkException

Validate an e-mail change for the given validation key, returning the affected user identifier

Throws:

FrameworkException

validateRegistration

UserValidationData validateRegistration(java.lang.String validationKey)
                                        throws FrameworkException

Validate user registration which was pending e-mail verification, via a provided key

Throws:

FrameworkException