org.cyclos.impl.access

Interface PrincipalTypeServiceLocal

All Superinterfaces:

CRUDService<PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>, org.cyclos.impl.CRUDServiceLocal<PrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>, PrincipalTypeService, Service

public interface PrincipalTypeServiceLocal
extends PrincipalTypeService, org.cyclos.impl.CRUDServiceLocal<PrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>

Local interface for PrincipalTypeService

Author:

luis

Method Summary

Methods

Modifier and Type	Method and Description
CustomFieldPrincipalType	getCustomField(UserCustomField field) Returns the principal type for the given custom field
BuiltInPrincipalType	getEmail() Returns the e-mail principal type
BuiltInPrincipalType	getMobilePhone() Returns the mobilePhone principal type
BuiltInPrincipalType	getUsername() Returns the username principal type
java.util.List<AccessClientPrincipalType>	listAccessClients() Returns a list with all access clients
java.util.List<TokenPrincipalType>	listActivatableTokenPrincipalTypes(User user, boolean asUserManager) Returns a list with the Token principal types of type TokenType.NFC_TAG available for activation (aka personalization) for the specified user.
java.util.List<PrincipalType>	listAll() Returns all principal types
java.util.List<PrincipalType>	listByNature(PrincipalTypeNature nature) List the principal types filtering by principal type nature
java.util.List<TokenPrincipalType>	listByType(TokenType type) List the token principal types filtering by token type
java.util.List<PrincipalType>	listForConfiguration(ConfigurationAccessor configuration) Returns the principal types which can be related to channels of the given configuration
java.util.List<PrincipalType>	listForLogin(ChannelConfiguration channelConfiguration) Returns the principal types which can be used for login in the given channel configuration
java.util.List<PrincipalType>	listForTransferTypes() Returns the principal types which can be used to filter transfer types
java.util.List<AccessClientPrincipalType>	listVisibleAccessClients(User user) Returns the access client types the logged user can see over the given user
java.util.List<TokenPrincipalType>	listVisibleTokenPrincipalTypes(User user, boolean forUserManagement) Returns the list of token principal types visible to the given user If the user is null it returns the ones visible to the logged user.
PrincipalType	load(java.lang.String internalName) Loads a principal type by internal name
void	sort(java.util.List<PrincipalType> principalTypes) Sorts the given list of principal types according to the search order

Methods inherited from interface org.cyclos.services.access.PrincipalTypeService

list

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

getCustomField

CustomFieldPrincipalType getCustomField(UserCustomField field)
                                        throws FrameworkException

Returns the principal type for the given custom field

Throws:

FrameworkException

getEmail

BuiltInPrincipalType getEmail()
                              throws FrameworkException

Returns the e-mail principal type

Throws:

FrameworkException

getMobilePhone

BuiltInPrincipalType getMobilePhone()
                                    throws FrameworkException

Returns the mobilePhone principal type

Throws:

FrameworkException

getUsername

BuiltInPrincipalType getUsername()
                                 throws FrameworkException

Returns the username principal type

Throws:

FrameworkException

listAccessClients

java.util.List<AccessClientPrincipalType> listAccessClients()
                                                            throws FrameworkException

Returns a list with all access clients

Throws:

FrameworkException

listActivatableTokenPrincipalTypes

java.util.List<TokenPrincipalType> listActivatableTokenPrincipalTypes(User user,
                                                                    boolean asUserManager)
                                                                      throws FrameworkException

Returns a list with the Token principal types of type TokenType.NFC_TAG available for activation (aka personalization) for the specified user.

Parameters:

user - It it null then return all available for personalization for the logged user. Otherwise the result is restricted only for those enabled for the user.

asUserManager - if true then the list of token principal types allowed to personalize are returned (See UserManagementProduct.getUserTokenTypes()). Otherwise the available principal types for activation (as user) are returned (See MemberProduct.getActivateUserTokenTypes()).

Throws:

FrameworkException

listAll

java.util.List<PrincipalType> listAll()
                                      throws FrameworkException

Returns all principal types

Throws:

FrameworkException

listByNature

java.util.List<PrincipalType> listByNature(PrincipalTypeNature nature)

List the principal types filtering by principal type nature

listByType

java.util.List<TokenPrincipalType> listByType(TokenType type)

List the token principal types filtering by token type

listForConfiguration

java.util.List<PrincipalType> listForConfiguration(ConfigurationAccessor configuration)
                                                   throws FrameworkException

Returns the principal types which can be related to channels of the given configuration

Throws:

FrameworkException

listForLogin

java.util.List<PrincipalType> listForLogin(ChannelConfiguration channelConfiguration)
                                           throws FrameworkException

Returns the principal types which can be used for login in the given channel configuration

Throws:

FrameworkException

listForTransferTypes

java.util.List<PrincipalType> listForTransferTypes()
                                                   throws FrameworkException

Returns the principal types which can be used to filter transfer types

Throws:

FrameworkException

listVisibleAccessClients

java.util.List<AccessClientPrincipalType> listVisibleAccessClients(User user)
                                                                   throws FrameworkException

Returns the access client types the logged user can see over the given user

Throws:

FrameworkException

listVisibleTokenPrincipalTypes

java.util.List<TokenPrincipalType> listVisibleTokenPrincipalTypes(User user,
                                                                boolean forUserManagement)

Returns the list of token principal types visible to the given user If the user is null it returns the ones visible to the logged user. The forUserManagement flag indicates if the visible types are the ones that are configured for user management.

load

PrincipalType load(java.lang.String internalName)
                   throws FrameworkException

Loads a principal type by internal name

Throws:

FrameworkException

sort

void sort(java.util.List<PrincipalType> principalTypes)
          throws FrameworkException

Sorts the given list of principal types according to the search order

Throws:

FrameworkException