org.cyclos.services.users

Interface UserService

All Superinterfaces:

CRUDService<UserDTO,UserData,UserDataParams>, CRUDWithConfirmationPasswordService<UserDTO,UserData,UserDataParams>, Service

All Known Subinterfaces:

UserServiceLocal

All Known Implementing Classes:

UserServiceSecurity

public interface UserService
extends CRUDWithConfirmationPasswordService<UserDTO,UserData,UserDataParams>

Service interface for user operations

Author:

luis

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SELF Identifier to locate the authenticated user

Method Summary

Modifier and Type	Method and Description
boolean	addContact(UserLocatorVO owner, UserLocatorVO contact) Adds the given contact to the given user (or logged user if null)'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
PublicRegistrationData	getPublicRegistrationData(InitialGroupVO group) Returns data for registering an user from the public registration
java.util.List<InitialGroupVO>	getPublicRegistrationGroups() Return the list of groups guests user can register
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.
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 owner, UserLocatorVO contact) Removes the given contact to the given user (or logged user if null)'s contact list, returning whether the list has changed
Page<UserWithFieldsVO>	search(UserQuery query) Search users according to the specified query parameters.
void	updateUserActivity(UserActivityType type) Updates user information status according to the given activity

Methods inherited from interface org.cyclos.services.CRUDWithConfirmationPasswordService

getConfirmationPasswordInputForRemove, removeAllWithConfirmationPassword, removeWithConfirmationPassword, saveWithConfirmationPassword

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Field Detail

SELF

static final java.lang.String SELF

Identifier to locate the authenticated user

See Also:

Constant Field Values

Method Detail

addContact

boolean addContact(UserLocatorVO owner,
                   UserLocatorVO contact)
            throws FrameworkException

Adds the given contact to the given user (or logged user if null)'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

getPublicRegistrationData

PublicRegistrationData getPublicRegistrationData(InitialGroupVO group)
                                          throws FrameworkException

Returns data for registering an user from the public registration

Throws:

FrameworkException

getPublicRegistrationGroups

java.util.List<InitialGroupVO> getPublicRegistrationGroups()
                                                    throws FrameworkException

Return the list of groups guests user can register

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

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 owner,
                      UserLocatorVO contact)
               throws FrameworkException

Removes the given contact to the given user (or logged user if null)'s contact list, returning whether the list has changed

Throws:

FrameworkException

search

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

Search users according to the specified query parameters. The returned objects will either contain the BasicUserVO.DISPLAY and BasicUserVO.SHORT_DISPLAY properties filled in or specific profile fields, depending on the products (permissions) of the viewing user. If there are profile fields marked to be returned, display and short display are not returned, as in most cases it would mean repeated information.

Throws:

FrameworkException

QueryParseException

updateUserActivity

void updateUserActivity(UserActivityType type)
                 throws FrameworkException

Updates user information status according to the given activity

Throws:

FrameworkException