Package org.cyclos.impl.users

Interface UserLocatorHandler

All Known Implementing Classes:

UserLocatorHandlerImpl

public interface UserLocatorHandler

Contains methods useful to locate users

See Also:

UserService.locate(UserLocatorVO)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	UserLocatorHandler.BasicUserVOFiller	Marks BasicUserVOs to be filled in a batch

Method Summary

Modifier and Type	Method	Description
static String	asString(UserLocatorVO locator)	Returns a String representation of a locator
LocateUserResult	locate(Network network, UserLocatorVO locator)	Locates a user on the given network, using a RawEntityManagerHandler.
LocateUserResult	locate(Network network, UserLocatorVO locator, Set<LocateUserOption> options)	Locates a user on the given network, using a RawEntityManagerHandler, using custom options.
LocateUserResult	locate(Network network, UserLocatorVO locator, Set<LocateUserOption> options, Collection<PrincipalType> principalTypes, PrincipalType defaultPrincipalType)	Locates a user on the given network, using a RawEntityManagerHandler, using custom options.
LocateUserResult	locate(UserLocatorVO locator)	Locates a user on the current network, using a RawEntityManagerHandler.
LocateUserResult	locate(UserLocatorVO locator, Set<LocateUserOption> options)	Locates a user on the current network, using a RawEntityManagerHandler, using custom options.
LocateUserResult	locate(UserLocatorVO locator, Set<LocateUserOption> options, Collection<PrincipalType> principalTypes, PrincipalType defaultPrincipalType)	Locates a user on the given network, using a RawEntityManagerHandler, using custom options.
UserLocatorHandler.BasicUserVOFiller	newVoFiller()	Creates a UserLocatorHandler.BasicUserVOFiller which can be used to fetch data for BasicUserVO's from VO's containing only the id
BasicUser	toBasicUserOrCurrent(BasicUserVO vo)	Converts the given BasicUserVO to a BasicUser, returning the logged basic user if the parameter is null or empty.
User	toUserOrCurrent(BasicUserVO vo)	Converts the given BasicUserVO to a User, returning the logged user if the parameter is null or empty.

Method Detail

asString

static String asString(UserLocatorVO locator)

Returns a String representation of a locator

locate

LocateUserResult locate(Network network,
                        UserLocatorVO locator)

Locates a user on the given network, using a RawEntityManagerHandler. Doesn't enforces the returned user to be related to the current session. It is allowed either id or any of the profile fields marked in the product as show in keywords, plus the visible tokens.

locate

LocateUserResult locate(Network network,
                        UserLocatorVO locator,
                        Set<LocateUserOption> options)

Locates a user on the given network, using a RawEntityManagerHandler, using custom options. Doesn't enforces the returned user to be related to the current session. It is allowed either id or any of the profile fields marked in the product as show in keywords, plus the visible tokens.

locate

LocateUserResult locate(Network network,
                        UserLocatorVO locator,
                        Set<LocateUserOption> options,
                        Collection<PrincipalType> principalTypes,
                        PrincipalType defaultPrincipalType)

Locates a user on the given network, using a RawEntityManagerHandler, using custom options. Doesn't enforces the returned user to be related to the current session.

locate

LocateUserResult locate(UserLocatorVO locator)

Locates a user on the current network, using a RawEntityManagerHandler. Enforces the returned user to be related to the current session. It is allowed either id or any of the profile fields marked in the product as show in keywords, plus the visible tokens.

locate

LocateUserResult locate(UserLocatorVO locator,
                        Set<LocateUserOption> options)

Locates a user on the current network, using a RawEntityManagerHandler, using custom options. Enforces the returned user to be related to the current session. It is allowed either id or any of the profile fields marked in the product as show in keywords, plus the visible tokens.

locate

LocateUserResult locate(UserLocatorVO locator,
                        Set<LocateUserOption> options,
                        Collection<PrincipalType> principalTypes,
                        PrincipalType defaultPrincipalType)

Locates a user on the given network, using a RawEntityManagerHandler, using custom options. Enforces the returned user to be related to the current session.

newVoFiller

UserLocatorHandler.BasicUserVOFiller newVoFiller()

Creates a UserLocatorHandler.BasicUserVOFiller which can be used to fetch data for BasicUserVO's from VO's containing only the id

toBasicUserOrCurrent

BasicUser toBasicUserOrCurrent(BasicUserVO vo)

Converts the given BasicUserVO to a BasicUser, returning the logged basic user if the parameter is null or empty.

Throws:

EntityNotFoundException - If no logged user and the parameter is null

toUserOrCurrent

User toUserOrCurrent(BasicUserVO vo)

Converts the given BasicUserVO to a User, returning the logged user if the parameter is null or empty.

Throws:

EntityNotFoundException - If no logged user and the parameter is null