org.cyclos.services.banking

Interface VoucherService

All Superinterfaces:

Service

All Known Subinterfaces:

VoucherServiceLocal

All Known Implementing Classes:

VoucherServiceSecurity

public interface VoucherService
extends Service

Service used to manage vouchers

Author:

luis

Method Summary

Modifier and Type	Method and Description
SerializableInputStream	barcode(@NotNull VoucherBarcodeParams params) Returns a barcode image of the token of the given voucher
VoucherPackWithIdsVO	buy(@NotNull BuyVouchersDTO params) Buys one or more vouchers
int	cancel(@NotNull CancelVouchersDTO params) Cancels one or more vouchers
void	changeExpirationDate(@NotNull ChangeVoucherExpirationDateDTO params) Changes the voucher expiration date according to the given information.
SerializableInputStream	exportToCSV(@NotNull VoucherQuery params, boolean markAsPrinted) Returns a CSV version of all returned vouchers, optionally marking them as printed
VoucherPackWithIdsVO	generate(@NotNull GenerateVouchersDTO params) Generates vouchers
BuyVoucherData	getBuyData(@NotNull BuyVoucherDataParams params) Returns data used to buy a voucher
VoucherData	getData(@NotNull java.lang.Long id) Returns data about a specific voucher
GenerateVouchersData	getGenerateData(@NotNull VoucherTypeVO voucherType) Returns data which is needed for generating vouchers
RedeemVoucherData	getRedeemData(@NotNull RedeemVoucherDataParams params) Returns data used to redeem a voucher
InitialRedeemVoucherData	getRedeemInitialData(UserLocatorVO user) Returns data for starting a voucher redeeming
VouchersSearchData	getSearchData(VoucherSearchContext context, UserLocatorVO user) Returns data for searching vouchers, either over a user or for a general search
java.util.List<VoucherTypeDetailedVO>	listTypesForBuy(UserLocatorVO forUser) Returns the voucher types the logged user can buy vouchers to the given user (defaults to the logged user himself)
java.util.List<VoucherTypeDetailedVO>	listTypesForGenerate() Returns the voucher types the logged administrator can generate vouchers on
VoucherVO	loadByToken(@NotNull java.lang.String token) Returns a voucher by token
SerializableInputStream	print(@NotNull java.lang.Long id) Returns a PDF-printable version of the voucher, and marks it as printed
SerializableInputStream	printAll(@NotNull VoucherQuery query, boolean markAsPrinted) Returns a PDF-printable version of all returned vouchers, optionally marking them as printed
RedeemVoucherResult	redeem(@NotNull RedeemVoucherDTO params) Redeems a voucher, returning the generated voucher id
Page<VoucherVO>	search(@NotNull VoucherQuery params) Searches for vouchers according to the given filters
VouchersResultsWithSummaryVO	searchWithSummary(@NotNull VoucherQuery params) Searches for vouchers according to the given filters, also returning summaries per status

Method Detail

barcode

SerializableInputStream barcode(@NotNull
                                @NotNull VoucherBarcodeParams params)
                         throws FrameworkException

Returns a barcode image of the token of the given voucher

Throws:

FrameworkException

buy

VoucherPackWithIdsVO buy(@NotNull
                         @NotNull BuyVouchersDTO params)
                  throws FrameworkException,
                         VoucherBuyingException,
                         MaxTotalOpenAmountException,
                         TransferException

Buys one or more vouchers

Throws:

BuyingNotAllowedForUserException - When the user is not in a group allowed to buy this type

BuyingMaxOpenAmountException - When the max open amount for the given user is exceeded

MaxTotalOpenAmountException - When the total amount of all open vouchers of this type would be exceeded

TransferException - When there is an error on the payment

FrameworkException

VoucherBuyingException

cancel

int cancel(@NotNull
           @NotNull CancelVouchersDTO params)
    throws FrameworkException

Cancels one or more vouchers

Throws:

FrameworkException

changeExpirationDate

void changeExpirationDate(@NotNull
                          @NotNull ChangeVoucherExpirationDateDTO params)
                   throws FrameworkException

Changes the voucher expiration date according to the given information.

Throws:

FrameworkException

exportToCSV

SerializableInputStream exportToCSV(@NotNull
                                    @NotNull VoucherQuery params,
                                    boolean markAsPrinted)
                             throws FrameworkException

Returns a CSV version of all returned vouchers, optionally marking them as printed

Throws:

FrameworkException

generate

VoucherPackWithIdsVO generate(@NotNull
                              @NotNull GenerateVouchersDTO params)
                       throws FrameworkException,
                              MaxTotalOpenAmountException,
                              TransferException

Generates vouchers

Throws:

MaxTotalOpenAmountException - When the total amount of all open vouchers of this type would be exceeded

TransferException - When there is an error on the payment

FrameworkException

getBuyData

BuyVoucherData getBuyData(@NotNull
                          @NotNull BuyVoucherDataParams params)
                   throws FrameworkException

Returns data used to buy a voucher

Throws:

FrameworkException

getData

VoucherData getData(@NotNull
                    @NotNull java.lang.Long id)
             throws FrameworkException

Returns data about a specific voucher

Throws:

FrameworkException

getGenerateData

GenerateVouchersData getGenerateData(@NotNull
                                     @NotNull VoucherTypeVO voucherType)
                              throws FrameworkException

Returns data which is needed for generating vouchers

Throws:

FrameworkException

getRedeemData

RedeemVoucherData getRedeemData(@NotNull
                                @NotNull RedeemVoucherDataParams params)
                         throws FrameworkException,
                                VoucherRedeemingException

Returns data used to redeem a voucher

Throws:

FrameworkException

VoucherRedeemingException

See Also:

redeem(RedeemVoucherDTO)

getRedeemInitialData

InitialRedeemVoucherData getRedeemInitialData(UserLocatorVO user)
                                       throws FrameworkException

Returns data for starting a voucher redeeming

Throws:

FrameworkException

getSearchData

VouchersSearchData getSearchData(VoucherSearchContext context,
                                 UserLocatorVO user)
                          throws FrameworkException

Returns data for searching vouchers, either over a user or for a general search

Throws:

FrameworkException

listTypesForBuy

java.util.List<VoucherTypeDetailedVO> listTypesForBuy(UserLocatorVO forUser)
                                               throws FrameworkException

Returns the voucher types the logged user can buy vouchers to the given user (defaults to the logged user himself)

Throws:

FrameworkException

listTypesForGenerate

java.util.List<VoucherTypeDetailedVO> listTypesForGenerate()
                                                    throws FrameworkException

Returns the voucher types the logged administrator can generate vouchers on

Throws:

FrameworkException

loadByToken

VoucherVO loadByToken(@NotNull
                      @NotNull java.lang.String token)
               throws FrameworkException

Returns a voucher by token

Throws:

FrameworkException

print

SerializableInputStream print(@NotNull
                              @NotNull java.lang.Long id)
                       throws FrameworkException

Returns a PDF-printable version of the voucher, and marks it as printed

Throws:

FrameworkException

printAll

SerializableInputStream printAll(@NotNull
                                 @NotNull VoucherQuery query,
                                 boolean markAsPrinted)
                          throws FrameworkException

Returns a PDF-printable version of all returned vouchers, optionally marking them as printed

Throws:

FrameworkException

redeem

RedeemVoucherResult redeem(@NotNull
                           @NotNull RedeemVoucherDTO params)
                    throws FrameworkException,
                           VoucherRedeemingException

Redeems a voucher, returning the generated voucher id

Throws:

RedeemingNotAllowedForVoucherException - When the voucher is no longer open

RedeemingNotAllowedForUserException - When the given user cannot redeem this voucher

RedeemingNotAllowedYetException - When attempting to redeem a voucher before the redeem start date

RedeemingNotAllowedTodayException - When attempting to redeem a voucher in a day it is not allowed

FrameworkException

VoucherRedeemingException

search

Page<VoucherVO> search(@NotNull
                       @NotNull VoucherQuery params)
                throws FrameworkException

Searches for vouchers according to the given filters

Throws:

FrameworkException

searchWithSummary

VouchersResultsWithSummaryVO searchWithSummary(@NotNull
                                               @NotNull VoucherQuery params)
                                        throws FrameworkException

Searches for vouchers according to the given filters, also returning summaries per status

Throws:

FrameworkException