Package org.cyclos.impl.banking

Interface VoucherServiceLocal

All Superinterfaces:

Service, VoucherService

public interface VoucherServiceLocal
extends VoucherService

Local interface for VoucherService

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_VOUCHER	Script bind variable: the Voucher
static String	ATTR_VOUCHER_CREATION_TYPE	Script bind variable: the VoucherCreationType
static String	ATTR_VOUCHER_TYPE	Script bind variable: the VoucherType
static int	MASKED_TOKEN_LENGTH

Method Summary

Modifier and Type	Method	Description
void	block(Voucher voucher)	Sets the voucher status as blocked.
VoucherChargeback	chargeback(Payment payment)	Creates a voucher chargeback for the given chargeback transaction.
int	countTotalOpenVouchers()	Returns the number of open vouchers for all networks
void	expire(Voucher voucher)	Expires the given voucher
void	expireActivation(Voucher voucher)	Expires the activation of the given voucher
void	fill(AccountHistoryEntryVO entry, Long boughtTypeId, List<String> boughtTokens, String boughtSentTo, VoucherTransactionNature transcationNature, Long transactionTypeId)	Fills the account history entry object with details of a voucher operation
Voucher	findByToken(String token, Collection<VoucherConfiguration> possibleConfigurations)	Returns a voucher by token code in one of the given configurations
String	formatMobilePhone(Voucher voucher)	Formats the voucher's mobile phone according to the configuration of the owner/buyer first or, if null, from the user who activated the voucher.
String	formatToken(Voucher voucher)	Formats the voucher token with the mask from configuration.
VoucherDetailsOnPayment	getDetailsOnPayment(Payment payment)	Returns details that should be displayed on a payment
boolean	hasAmountReservation(Voucher voucher)	Returns whether the given voucher has any reservations, either by pack or by top-ups
com.mysema.commons.lang.CloseableIterator<Voucher>	iterateVouchers(VoucherPack voucherPack)	Iterates all voucher of a voucher pack
void	notifyAboutToExpire(Voucher voucher)	Notifies that a voucher is about to expire
default List<String>	resendPinForRedeem(@NotNull String token)	Deprecated. Use VoucherService.resendPinForRedeem(String, UserLocatorVO) instead
Voucher	sendByImport(SendVoucherDTO params)	Imports a voucher sending
boolean	showPinOnDetails(Voucher v)	Indicates whether the PIN should be shown in the voucher details
boolean	showQrCode(Voucher voucher)	Returns if the QrCode of the voucher can be shown (e.g for printing or in the details page)
boolean	usePin(Voucher voucher)	The voucher uses PIN if has a defined one and was not switched-off in the voucher configuration.
void	validate(SendVoucherDTO dto)	Validates a voucher sending parameters

Methods inherited from interface org.cyclos.services.banking.VoucherService

activateGiftVoucher, assign, barcode, buy, cancel, changeExpirationDate, changeInfoNotificationSettings, changeInfoPin, changeNotificationSettings, changePin, exportTransaction, exportVoucher, exportVouchers, generalSearchSummary, generate, getBuyData, getData, getGeneralSearchData, getGenerateData, getInfo, getInfoData, getRedeemData, getRedeemInitialData, getSendData, getTopUpData, getTopUpInitialData, getTransactionData, getUserTransactionsSearchData, getUserVouchersSearchData, loadByToken, previewBuy, previewRedeem, previewSend, previewTopUp, redeem, resendEmail, resendPin, resendPinForRedeem, searchGeneral, searchInfoTransactions, searchTransactions, searchUser, send, topUp, unblock, unblockPin

Field Detail

MASKED_TOKEN_LENGTH

static final int MASKED_TOKEN_LENGTH

See Also:

Constant Field Values

ATTR_VOUCHER_TYPE

static final String ATTR_VOUCHER_TYPE

Script bind variable: the VoucherType

See Also:

Constant Field Values

ATTR_VOUCHER

static final String ATTR_VOUCHER

Script bind variable: the Voucher

See Also:

Constant Field Values

ATTR_VOUCHER_CREATION_TYPE

static final String ATTR_VOUCHER_CREATION_TYPE

Script bind variable: the VoucherCreationType

See Also:

Constant Field Values

Method Detail

block

void block(Voucher voucher)

Sets the voucher status as blocked. The voucher needs to be open. It will be needed to be unblocked in the /voucher app. WARNING: this method is used by scripts only. There's no use case for having it in the public API.

chargeback

VoucherChargeback chargeback(Payment payment)

Creates a voucher chargeback for the given chargeback transaction. Returns the voucher chargeback if it was generated, or null if there's no chargeback to perform.

countTotalOpenVouchers

int countTotalOpenVouchers()

Returns the number of open vouchers for all networks

expire

void expire(Voucher voucher)

Expires the given voucher

expireActivation

void expireActivation(Voucher voucher)

Expires the activation of the given voucher

fill

void fill(AccountHistoryEntryVO entry,
          Long boughtTypeId,
          List<String> boughtTokens,
          String boughtSentTo,
          VoucherTransactionNature transcationNature,
          Long transactionTypeId)

Fills the account history entry object with details of a voucher operation

findByToken

Voucher findByToken(String token,
                    Collection<VoucherConfiguration> possibleConfigurations)

Returns a voucher by token code in one of the given configurations

formatMobilePhone

String formatMobilePhone(Voucher voucher)

Formats the voucher's mobile phone according to the configuration of the owner/buyer first or, if null, from the user who activated the voucher. If the resolved user still is null then the default configuration will be used.

formatToken

String formatToken(Voucher voucher)

Formats the voucher token with the mask from configuration. If VoucherConfiguration.isShowPlainToken() is false, returns null. If the token should be masked, it will be returned masked.

getDetailsOnPayment

VoucherDetailsOnPayment getDetailsOnPayment(Payment payment)

Returns details that should be displayed on a payment

hasAmountReservation

boolean hasAmountReservation(Voucher voucher)

Returns whether the given voucher has any reservations, either by pack or by top-ups

iterateVouchers

com.mysema.commons.lang.CloseableIterator<Voucher> iterateVouchers(VoucherPack voucherPack)

Iterates all voucher of a voucher pack

notifyAboutToExpire

void notifyAboutToExpire(Voucher voucher)

Notifies that a voucher is about to expire

resendPinForRedeem

@Deprecated
default List<String> resendPinForRedeem(@NotNull
                                        @NotNull String token)
                                 throws FrameworkException

Deprecated.

Use VoucherService.resendPinForRedeem(String, UserLocatorVO) instead

Will be removed in Cyclos 4.17

Throws:

FrameworkException

sendByImport

Voucher sendByImport(SendVoucherDTO params)

Imports a voucher sending

showPinOnDetails

boolean showPinOnDetails(Voucher v)

Indicates whether the PIN should be shown in the voucher details

showQrCode

boolean showQrCode(Voucher voucher)

Returns if the QrCode of the voucher can be shown (e.g for printing or in the details page)

usePin

boolean usePin(Voucher voucher)

The voucher uses PIN if has a defined one and was not switched-off in the voucher configuration.

validate

void validate(SendVoucherDTO dto)

Validates a voucher sending parameters