Package org.cyclos.impl.banking

Interface AccountHandler

All Known Implementing Classes:

AccountHandlerImpl

public interface AccountHandler

Handler for accounts

Method Summary

Modifier and Type	Method	Description
String	getAccountNumber(IAccount account)	Returns the masked account number for the given account, if applicable.
InternalAccountOwner	getAccountOwner()	Returns the account owner of the logged user. If there is a logged admin, returns SystemAccountOwner.
boolean	isSystemAccountOwner(AccountOwner owner)
LocateAccountOwnerResult	locate(AccountOwner accountOwner)	Locates a non-removed account owner
LocateAccountOwnerResult	locate(AccountOwner accountOwner, boolean allowRemoved)	Locates an account owner, using no specific principal types - the same ones used to locate users will be attempted
LocateAccountOwnerResult	locate(AccountOwner accountOwner, boolean allowById, boolean allowContact, boolean allowOperators, boolean allowRemoved, Collection<PrincipalType> principalTypes, PrincipalType defaultPrincipalType, boolean forReceive)	Locate and normalize the specified account owner using the specified principal types (if null then try with all allowed principal types). This method MUST be invoked before work with any instances of AccountOwner. If the account owner parameter represents a user it will be located.
LocateAccountOwnerResult	locateOrCurrent(AccountOwner accountOwner)	Locates a non-removed account owner
LocateAccountOwnerResult	locateOrCurrent(AccountOwner accountOwner, boolean allowRemoved)	Like locate(AccountOwner), except that if the given owner is null, returns the owner of the logged user.
AccountOwner	toAccountOwnerVO(LocateAccountOwnerResult result)	Same as toAccountOwnerVO(LocateAccountOwnerResult, boolean), but never allowing operators.
AccountOwner	toAccountOwnerVO(LocateAccountOwnerResult result, boolean allowOperator)	If the result represents a user there are two options: If the user was located then returns a LocatedUserVO If the user was not located then returns a BasicUserVO (OperatorVO only if allowOperator is true) Otherwise returns a SystemAccountOwner
AccountOwner	toAccountOwnerVO(AccountOwner accountOwner)	Same as toAccountOwnerVO(AccountOwner, boolean), but never allowing operators.
AccountOwner	toAccountOwnerVO(AccountOwner accountOwner, boolean allowOperator)	Like toAccountOwnerVO(InternalAccountOwner, boolean) but supporting ExternalAccountOwner
InternalAccountOwner	toAccountOwnerVO(InternalAccountOwner accountOwner)	Same as toAccountOwnerVO(InternalAccountOwner, boolean), but never allowing operators.
InternalAccountOwner	toAccountOwnerVO(InternalAccountOwner accountOwner, boolean allowOperator)	Return SystemAccountOwner or BasicUserVO.

Method Detail

getAccountNumber

String getAccountNumber(IAccount account)

Returns the masked account number for the given account, if applicable. Otherwise, null.

getAccountOwner

InternalAccountOwner getAccountOwner()

Returns the account owner of the logged user.
If there is a logged admin, returns SystemAccountOwner. If any other user, returns it. Otherwise, returns null.

isSystemAccountOwner

boolean isSystemAccountOwner(AccountOwner owner)

Returns:

true if the owner parameter is the SystemAccountOwner

locate

LocateAccountOwnerResult locate(AccountOwner accountOwner)

Locates a non-removed account owner

See Also:

locate(AccountOwner, boolean)

locate

LocateAccountOwnerResult locate(AccountOwner accountOwner,
                                boolean allowRemoved)

Locates an account owner, using no specific principal types - the same ones used to locate users will be attempted

Parameters:

allowRemoved - whether to allow removed users or not

locate

LocateAccountOwnerResult locate(AccountOwner accountOwner,
                                boolean allowById,
                                boolean allowContact,
                                boolean allowOperators,
                                boolean allowRemoved,
                                Collection<PrincipalType> principalTypes,
                                PrincipalType defaultPrincipalType,
                                boolean forReceive)

Locate and normalize the specified account owner using the specified principal types (if null then try with all allowed principal types).
This method MUST be invoked before work with any instances of AccountOwner.
If the account owner parameter represents a user it will be located. In case of an admin a result with the SystemAccountOwner will be created.

Returns:

a result with a SystemAccountOwner, ExternalAccountOwner or the user representing the specified owner.

locateOrCurrent

LocateAccountOwnerResult locateOrCurrent(AccountOwner accountOwner)

Locates a non-removed account owner

See Also:

locateOrCurrent(AccountOwner, boolean)

locateOrCurrent

LocateAccountOwnerResult locateOrCurrent(AccountOwner accountOwner,
                                         boolean allowRemoved)

Like locate(AccountOwner), except that if the given owner is null, returns the owner of the logged user.

Parameters:

allowRemoved - whether removed users are allowed or not

toAccountOwnerVO

AccountOwner toAccountOwnerVO(AccountOwner accountOwner)

Same as toAccountOwnerVO(AccountOwner, boolean), but never allowing operators.

toAccountOwnerVO

AccountOwner toAccountOwnerVO(AccountOwner accountOwner,
                              boolean allowOperator)

Like toAccountOwnerVO(InternalAccountOwner, boolean) but supporting ExternalAccountOwner

toAccountOwnerVO

InternalAccountOwner toAccountOwnerVO(InternalAccountOwner accountOwner)

Same as toAccountOwnerVO(InternalAccountOwner, boolean), but never allowing operators.

toAccountOwnerVO

InternalAccountOwner toAccountOwnerVO(InternalAccountOwner accountOwner,
                                      boolean allowOperator)

Return SystemAccountOwner or BasicUserVO. For an admin returns a SystemAccountOwner

toAccountOwnerVO

AccountOwner toAccountOwnerVO(LocateAccountOwnerResult result)

Same as toAccountOwnerVO(LocateAccountOwnerResult, boolean), but never allowing operators.

toAccountOwnerVO

AccountOwner toAccountOwnerVO(LocateAccountOwnerResult result,
                              boolean allowOperator)

If the result represents a user there are two options:

• If the user was located then returns a LocatedUserVO
• If the user was not located then returns a BasicUserVO (OperatorVO only if allowOperator is true)

Otherwise returns a SystemAccountOwner