org.cyclos.impl.users

Interface UserServiceLocal

All Superinterfaces:

CRUDService<UserDTO,UserData,java.lang.Long>, org.cyclos.impl.CRUDServiceLocal<User,UserDTO,UserData,java.lang.Long>, Service, UserService

public interface UserServiceLocal
extends UserService, org.cyclos.impl.CRUDServiceLocal<User,UserDTO,UserData,java.lang.Long>

Local interface for UserService

Author:

luis

Method Summary

Methods

Modifier and Type	Method and Description
void	activateUserIfNeeded(User user) It activates the user's accounts, create a password (if needed) and send the activation email only if the user's group is an active one.
boolean	canEditUserCustomFields(User user) Returns true if the logged user can edit at least one user profile custom fields
boolean	canEditUserEmail(User user) Returns true if the logged user can edit the user email
boolean	canEditUserFullName(User user) Returns true if the logged user can edit the user profile full name
boolean	canEditUserLoginName(User user) Returns true if the logged user can modify the user's login name
boolean	canViewAddresses(User user) Returns if the given user can view addresses
boolean	canViewPhones(User user) Returns if the given user can view phones
void	clearValidationKey(User user) Removes all user data related to a validation key
int	countTotalUsers() Returns the total number of users (not admins) which are not removed
void	fill(AbstractUserSearchData data, boolean searchOverBrokeredUsers) Fills-in the common fields of an AbstractUserSearchData
GroupVisibility	getGroupVisibility(boolean brokered) Returns the GroupVisibility for the current user, optionally over brokered users
java.util.Date	getLastLogin() Returns the last login date of the logged user, or null if never logged in before, or not logged-in
User	getUserForValidationKey(ValidationKeyType type, java.lang.String validationKey) Returns the user in the current network with the given validation key
org.cyclos.impl.utils.validation.Validator	getValidator(Group group, UserDTO userDTO, UserRegistration registration) Returns a user validator
UserRegistrationResult	importUser(UserRegistrationDTO dto) Imports an user
boolean	isContact(User user) Returns whether the given user is a contact of the logged user
com.mysema.commons.lang.CloseableIterator<User>	iterateByGroups(java.util.Collection<? extends Group> groups) Iterates all users on the given groups
com.mysema.commons.lang.CloseableIterator<java.lang.Long>	iterateIds(UserQuery query) Iterates users according to the specified query parameters
org.cyclos.impl.users.LocateUserResult	locate(Network network, UserLocatorVO locator, java.util.Set<org.cyclos.impl.users.LocateUserOption> options) Locates an user on the given network, using a RawEntityManagerHandler, using custom options.
org.cyclos.impl.users.LocateUserResult	locate(Network network, UserLocatorVO locator, java.util.Set<org.cyclos.impl.users.LocateUserOption> options, java.util.Collection<PrincipalType> principalTypes) Locates an user on the given network, using a RawEntityManagerHandler, using custom options.
org.cyclos.impl.users.LocateUserResult	locateRelated(UserLocatorVO locator) Locates an user on the current network, using a RawEntityManagerHandler, enforcing the active user to be related to the located user.
User	locateUser(Network network, UserLocatorVO locator) Locates an user on the given network, using a RawEntityManagerHandler.
User	locateUser(Network network, UserLocatorVO locator, java.util.Set<org.cyclos.impl.users.LocateUserOption> options) Locates an user on the given network, using a RawEntityManagerHandler, using custom options.
User	locateUser(Network network, UserLocatorVO locator, java.util.Set<org.cyclos.impl.users.LocateUserOption> options, java.util.Collection<PrincipalType> possiblePrincipalTypes) Locates an user on the given network, using a RawEntityManagerHandler, using custom options.
User	locateUser(UserLocatorVO locator) Locates an user in the current network enforcing the active user to be related to the located user.
User	locateUser(UserLocatorVO locator, java.util.Set<org.cyclos.impl.users.LocateUserOption> options) Locates an user using the EntityManagerHandler, that means - the user must be in the same network as the current user, and needs to be accessible by him.
User	registerByPopulator(UserRegistrationDTO params) Registers an user via a populator, like setup or network with data
org.cyclos.impl.users.RegisterUserBySmsResult	registerBySms(org.cyclos.impl.users.RegisterUserBySmsParams params) Registers an user via SMS
boolean	requiresEmailValidation(UserRegistration registration, ConfigurationAccessor configuration) Returns true if the configuration requires email validation for the given user registration.
void	setValidationKey(User user, ValidationKeyType type) Generates a new validation key for an user operation which needs an e-mail confirmation (like pending user registration, pending e-mail change or forgot password)

Methods inherited from interface org.cyclos.services.users.UserService

addContact, exportToCSV, getActiveConfiguration, getCurrentUser, getSearchData, getUserRegistrationGroups, getViewProfileData, locate, markEmailAsValidated, printUsers, publicRegister, register, removeContact, resendEmailChangeMail, resendValidationMail, search, updateUserActivity, validateEmailChange, validateRegistration

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, newEntity, remove, removeAll, toDTO, toEntity, validate

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

activateUserIfNeeded

void activateUserIfNeeded(User user)
                          throws FrameworkException

It activates the user's accounts, create a password (if needed) and send the activation email only if the user's group is an active one.

Throws:

FrameworkException

canEditUserCustomFields

boolean canEditUserCustomFields(User user)
                                throws FrameworkException

Returns true if the logged user can edit at least one user profile custom fields

Throws:

FrameworkException

canEditUserEmail

boolean canEditUserEmail(User user)
                         throws FrameworkException

Returns true if the logged user can edit the user email

Throws:

FrameworkException

canEditUserFullName

boolean canEditUserFullName(User user)
                            throws FrameworkException

Returns true if the logged user can edit the user profile full name

Throws:

FrameworkException

canEditUserLoginName

boolean canEditUserLoginName(User user)
                             throws FrameworkException

Returns true if the logged user can modify the user's login name

Throws:

FrameworkException

canViewAddresses

boolean canViewAddresses(User user)
                         throws FrameworkException

Returns if the given user can view addresses

Throws:

FrameworkException

canViewPhones

boolean canViewPhones(User user)
                      throws FrameworkException

Returns if the given user can view phones

Throws:

FrameworkException

clearValidationKey

void clearValidationKey(User user)
                        throws FrameworkException

Removes all user data related to a validation key

Throws:

FrameworkException

countTotalUsers

int countTotalUsers()

Returns the total number of users (not admins) which are not removed

fill

void fill(AbstractUserSearchData data,
        boolean searchOverBrokeredUsers)
          throws FrameworkException

Fills-in the common fields of an AbstractUserSearchData

Throws:

FrameworkException

getGroupVisibility

GroupVisibility getGroupVisibility(boolean brokered)
                                   throws FrameworkException

Returns the GroupVisibility for the current user, optionally over brokered users

Throws:

FrameworkException

getLastLogin

java.util.Date getLastLogin()
                            throws FrameworkException

Returns the last login date of the logged user, or null if never logged in before, or not logged-in

Throws:

FrameworkException

getUserForValidationKey

User getUserForValidationKey(ValidationKeyType type,
                           java.lang.String validationKey)
                             throws FrameworkException

Returns the user in the current network with the given validation key

Throws:

FrameworkException

getValidator

org.cyclos.impl.utils.validation.Validator getValidator(Group group,
                                                      UserDTO userDTO,
                                                      UserRegistration registration)
                                                        throws FrameworkException

Returns a user validator

Throws:

FrameworkException

importUser

UserRegistrationResult importUser(UserRegistrationDTO dto)

Imports an user

isContact

boolean isContact(User user)
                  throws FrameworkException

Returns whether the given user is a contact of the logged user

Throws:

FrameworkException

iterateByGroups

com.mysema.commons.lang.CloseableIterator<User> iterateByGroups(java.util.Collection<? extends Group> groups)
                                                                throws FrameworkException

Iterates all users on the given groups

Throws:

FrameworkException

iterateIds

com.mysema.commons.lang.CloseableIterator<java.lang.Long> iterateIds(UserQuery query)
                                                                     throws FrameworkException,
                                                                            QueryParseException

Iterates users according to the specified query parameters

Throws:

FrameworkException

QueryParseException

locate

org.cyclos.impl.users.LocateUserResult locate(Network network,
                                            UserLocatorVO locator,
                                            java.util.Set<org.cyclos.impl.users.LocateUserOption> options)
                                              throws FrameworkException

Locates an user on the given network, using a RawEntityManagerHandler, using custom options. Doesn't enforces the active user to be related to the located user.

Throws:

FrameworkException

See Also:

UserService.locate(UserLocatorVO)

locate

org.cyclos.impl.users.LocateUserResult locate(Network network,
                                            UserLocatorVO locator,
                                            java.util.Set<org.cyclos.impl.users.LocateUserOption> options,
                                            java.util.Collection<PrincipalType> principalTypes)
                                              throws FrameworkException

Locates an user on the given network, using a RawEntityManagerHandler, using custom options. Doesn't enforces the active user to be related to the located user.

Throws:

FrameworkException

See Also:

UserService.locate(UserLocatorVO)

locateRelated

org.cyclos.impl.users.LocateUserResult locateRelated(UserLocatorVO locator)
                                                     throws FrameworkException

Locates an user on the current network, using a RawEntityManagerHandler, enforcing the active user to be related to the located user.

Throws:

FrameworkException

locateUser

User locateUser(Network network,
              UserLocatorVO locator)
                throws FrameworkException

Locates an user on the given network, using a RawEntityManagerHandler. Doesn't enforces the active user to be related to the located user.

Throws:

FrameworkException

See Also:

UserService.locate(UserLocatorVO)

locateUser

User locateUser(Network network,
              UserLocatorVO locator,
              java.util.Set<org.cyclos.impl.users.LocateUserOption> options)
                throws FrameworkException

Locates an user on the given network, using a RawEntityManagerHandler, using custom options. Doesn't enforces the active user to be related to the located user.

Throws:

FrameworkException

See Also:

UserService.locate(UserLocatorVO)

locateUser

User locateUser(Network network,
              UserLocatorVO locator,
              java.util.Set<org.cyclos.impl.users.LocateUserOption> options,
              java.util.Collection<PrincipalType> possiblePrincipalTypes)
                throws FrameworkException

Locates an user on the given network, using a RawEntityManagerHandler, using custom options. Doesn't enforces the active user to be related to the located user.

Throws:

FrameworkException

See Also:

UserService.locate(UserLocatorVO)

locateUser

User locateUser(UserLocatorVO locator)
                throws FrameworkException

Locates an user in the current network enforcing the active user to be related to the located user.

Throws:

FrameworkException

See Also:

UserService.locate(UserLocatorVO)

locateUser

User locateUser(UserLocatorVO locator,
              java.util.Set<org.cyclos.impl.users.LocateUserOption> options)
                throws FrameworkException

Locates an user using the EntityManagerHandler, that means - the user must be in the same network as the current user, and needs to be accessible by him.

Throws:

FrameworkException

See Also:

UserService.locate(UserLocatorVO)

registerByPopulator

User registerByPopulator(UserRegistrationDTO params)
                         throws FrameworkException

Registers an user via a populator, like setup or network with data

Throws:

FrameworkException

registerBySms

org.cyclos.impl.users.RegisterUserBySmsResult registerBySms(org.cyclos.impl.users.RegisterUserBySmsParams params)
                                                            throws FrameworkException

Registers an user via SMS

Throws:

FrameworkException

requiresEmailValidation

boolean requiresEmailValidation(UserRegistration registration,
                              ConfigurationAccessor configuration)
                                throws FrameworkException

Returns true if the configuration requires email validation for the given user registration.

Throws:

FrameworkException

setValidationKey

void setValidationKey(User user,
                    ValidationKeyType type)
                      throws FrameworkException

Generates a new validation key for an user operation which needs an e-mail confirmation (like pending user registration, pending e-mail change or forgot password)

Throws:

FrameworkException