org.cyclos.services.banking

Interface TransactionAuthorizationService

All Superinterfaces:

Service

public interface TransactionAuthorizationService
extends Service

Service interface for transaction authorizations.
It allow authorize, deny etc a transaction and search for transactions to authorize and already authorized.

Author:

luis, rinke

Method Summary

Modifier and Type	Method and Description
PaymentAuthorizationLevelData	authorize(@NotNull TransactionAuthorizationDTO transferAuthorizationDto) Authorizes a payment pending authorization
void	cancel(@NotNull TransactionAuthorizationDTO transferAuthorizationDto) Cancels a payment pending authorization
void	deny(@NotNull TransactionAuthorizationDTO transferAuthorizationDto) Denies a payment pending authorization
TransactionSearchData	getAuthorizedTransactionsSearchData(InternalAccountOwner owner) Returns data used to search for authorized transactions for the given owner.
TransactionsToAuthorizeSearchData	getTransactionsToAuthorizeSearchData() Returns data for searching transactions the logged user can authorize
Page<TransactionVO>	searchAuthorizedTransactions(@NotNull AuthorizedTransactionQuery query) Searches for authorized transactions of any status, according to the given query
Page<TransactionVO>	searchTransactionsToAuthorize(@NotNull TransactionsToAuthorizeQuery query) Searches transactions which the user has to authorize

Method Detail

authorize

PaymentAuthorizationLevelData authorize(@NotNull
                                        @NotNull TransactionAuthorizationDTO transferAuthorizationDto)
                                 throws TransferException,
                                        FrameworkException,
                                        IllegalActionException

Authorizes a payment pending authorization

Returns:

The next level, if any, or null if authorized

Throws:

IllegalActionException - The payment is not on a state which can be authorized or was already authorized by the logged user, even if it would be possible (through multiple roles) to authorize again

TransferException

FrameworkException

cancel

void cancel(@NotNull
            @NotNull TransactionAuthorizationDTO transferAuthorizationDto)
     throws FrameworkException,
            IllegalActionException

Cancels a payment pending authorization

Throws:

IllegalActionException - The payment is not on a state which can be canceled, or is part of a scheduled payment (instead, the entire scheduled payment should be canceled)

FrameworkException

deny

void deny(@NotNull
          @NotNull TransactionAuthorizationDTO transferAuthorizationDto)
   throws FrameworkException,
          IllegalActionException

Denies a payment pending authorization

Throws:

IllegalActionException - The payment is not on a state which can be denied

FrameworkException

getAuthorizedTransactionsSearchData

TransactionSearchData getAuthorizedTransactionsSearchData(InternalAccountOwner owner)
                                                   throws FrameworkException

Returns data used to search for authorized transactions for the given owner.
If an owner is given it works exactly as TransactionService.getSearchData(InternalAccountOwner).

Parameters:

owner - Only for managers (admin/broker) it could be null, meaning we want to search for transactions of all managed users. For members it must be not null and equals to the logged user.

Throws:

FrameworkException

getTransactionsToAuthorizeSearchData

TransactionsToAuthorizeSearchData getTransactionsToAuthorizeSearchData()
                                                                throws FrameworkException

Returns data for searching transactions the logged user can authorize

Throws:

FrameworkException

searchAuthorizedTransactions

Page<TransactionVO> searchAuthorizedTransactions(@NotNull
                                                 @NotNull AuthorizedTransactionQuery query)
                                          throws FrameworkException

Searches for authorized transactions of any status, according to the given query

Throws:

FrameworkException

searchTransactionsToAuthorize

Page<TransactionVO> searchTransactionsToAuthorize(@NotNull
                                                  @NotNull TransactionsToAuthorizeQuery query)
                                           throws FrameworkException

Searches transactions which the user has to authorize

Throws:

FrameworkException