org.cyclos.security.banking

Class VoucherServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.banking.VoucherServiceSecurity

All Implemented Interfaces:

VoucherService, Service

@Security
public class VoucherServiceSecurity
extends BaseServiceSecurity
implements VoucherService

Security layer for VoucherService

Author:

luis

Constructor Summary

Constructors

Constructor and Description
VoucherServiceSecurity()

Method Summary

Modifier and Type	Method and Description
SerializableInputStream	barcode(VoucherBarcodeParams params) Returns a barcode image of the token of the given voucher
VoucherPackWithIdsVO	buy(BuyVouchersDTO params) Buys one or more vouchers
int	cancel(CancelVouchersDTO params) Cancels one or more vouchers
void	changeExpirationDate(ChangeVoucherExpirationDateDTO params) Changes the voucher expiration date according to the given information.
SerializableInputStream	exportToCSV(VoucherQuery query, boolean markAsPrinted) Returns a CSV version of all returned vouchers, optionally marking them as printed
VoucherPackWithIdsVO	generate(GenerateVouchersDTO params) Generates vouchers
BuyVoucherData	getBuyData(BuyVoucherDataParams params) Returns data used to buy a voucher
VoucherData	getData(java.lang.Long id) Returns data about a specific voucher
GenerateVouchersData	getGenerateData(VoucherTypeVO voucherTypeVO) Returns data which is needed for generating vouchers
RedeemVoucherData	getRedeemData(RedeemVoucherDataParams params) Returns data used to redeem a voucher
InitialRedeemVoucherData	getRedeemInitialData(UserLocatorVO userVO) Returns data for starting a voucher redeeming
VouchersSearchData	getSearchData(VoucherSearchContext context, UserLocatorVO locator) Returns data for searching vouchers, either over an user or for a general search
java.util.List<VoucherTypeDetailedVO>	listTypesForBuy(UserLocatorVO forUserVO) 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(java.lang.String token) Returns a voucher by token
SerializableInputStream	print(java.lang.Long id) Returns a PDF-printable version of the voucher, and marks it as printed
SerializableInputStream	printAll(VoucherQuery query, boolean markAsPrinted) Returns a PDF-printable version of all returned vouchers, optionally marking them as printed
RedeemVoucherResult	redeem(RedeemVoucherDTO params) Redeems a voucher, returning the generated voucher id
protected org.cyclos.impl.access.EntityCheck<?>	resolveEntityCheck() Must be implemented in order to return the EntityCheck managed by this security component, or null if none
Page<VoucherVO>	search(VoucherQuery params) Searches for vouchers according to the given filters
VouchersResultsWithSummaryVO	searchWithSummary(VoucherQuery params) Searches for vouchers according to the given filters, also returning summaries per status

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkVO, checkVOs, doInitialize, getEntityCheckRegistry, getUser, initialize

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getAccountHandler, getAuthHandler, getBaseEntityManagerHandler, getChannelConfiguration, getConfiguration, getConversionHandler, getCustomFieldValueHandler, getEntityManagerHandler, getGroupsHandler, getLoggedBasicUser, getLoggedUser, getProducts, getProductsHandler, getReportHandler, getTranslatedName, getTranslatedValue, getUserLocatorHandler, getValidationResult, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

delete, detach, find, flush, from, getApplicationContext, getConfigurationHandler, getDataTranslationHandler, getFormatter, getFormatter, getFormatter, getLogger, getNotificationHandler, getProfileFieldHandler, getRemoteAddress, getSessionData, getTransactionHandler, getTranslationHandler, message, message, persist, processBatch, refresh, remove, subQuery, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VoucherServiceSecurity

public VoucherServiceSecurity()

Method Detail

barcode

public SerializableInputStream barcode(VoucherBarcodeParams params)
                                throws FrameworkException

Description copied from interface: VoucherService

Returns a barcode image of the token of the given voucher

Specified by:

barcode in interface VoucherService

Throws:

FrameworkException

buy

public VoucherPackWithIdsVO buy(BuyVouchersDTO params)
                         throws FrameworkException

Description copied from interface: VoucherService

Buys one or more vouchers

Specified by:

buy in interface VoucherService

Throws:

FrameworkException

cancel

public int cancel(CancelVouchersDTO params)
           throws FrameworkException

Description copied from interface: VoucherService

Cancels one or more vouchers

Specified by:

cancel in interface VoucherService

Throws:

FrameworkException

changeExpirationDate

public void changeExpirationDate(ChangeVoucherExpirationDateDTO params)
                          throws FrameworkException

Description copied from interface: VoucherService

Changes the voucher expiration date according to the given information.

Specified by:

changeExpirationDate in interface VoucherService

Throws:

FrameworkException

exportToCSV

public SerializableInputStream exportToCSV(VoucherQuery query,
                                           boolean markAsPrinted)
                                    throws FrameworkException

Description copied from interface: VoucherService

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

Specified by:

exportToCSV in interface VoucherService

Throws:

FrameworkException

generate

public VoucherPackWithIdsVO generate(GenerateVouchersDTO params)
                              throws FrameworkException

Description copied from interface: VoucherService

Generates vouchers

Specified by:

generate in interface VoucherService

Throws:

FrameworkException

getBuyData

public BuyVoucherData getBuyData(BuyVoucherDataParams params)
                          throws FrameworkException

Description copied from interface: VoucherService

Returns data used to buy a voucher

Specified by:

getBuyData in interface VoucherService

Throws:

FrameworkException

getData

public VoucherData getData(java.lang.Long id)
                    throws FrameworkException

Description copied from interface: VoucherService

Returns data about a specific voucher

Specified by:

getData in interface VoucherService

Throws:

FrameworkException

getGenerateData

public GenerateVouchersData getGenerateData(VoucherTypeVO voucherTypeVO)
                                     throws FrameworkException

Description copied from interface: VoucherService

Returns data which is needed for generating vouchers

Specified by:

getGenerateData in interface VoucherService

Throws:

FrameworkException

getRedeemData

public RedeemVoucherData getRedeemData(RedeemVoucherDataParams params)
                                throws FrameworkException

Description copied from interface: VoucherService

Returns data used to redeem a voucher

Specified by:

getRedeemData in interface VoucherService

Throws:

FrameworkException

See Also:

VoucherService.redeem(RedeemVoucherDTO)

getRedeemInitialData

public InitialRedeemVoucherData getRedeemInitialData(UserLocatorVO userVO)
                                              throws FrameworkException

Description copied from interface: VoucherService

Returns data for starting a voucher redeeming

Specified by:

getRedeemInitialData in interface VoucherService

Throws:

FrameworkException

getSearchData

public VouchersSearchData getSearchData(VoucherSearchContext context,
                                        UserLocatorVO locator)
                                 throws FrameworkException

Description copied from interface: VoucherService

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

Specified by:

getSearchData in interface VoucherService

Throws:

FrameworkException

listTypesForBuy

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

Description copied from interface: VoucherService

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

Specified by:

listTypesForBuy in interface VoucherService

Throws:

FrameworkException

listTypesForGenerate

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

Description copied from interface: VoucherService

Returns the voucher types the logged administrator can generate vouchers on

Specified by:

listTypesForGenerate in interface VoucherService

Throws:

FrameworkException

loadByToken

public VoucherVO loadByToken(java.lang.String token)
                      throws FrameworkException

Description copied from interface: VoucherService

Returns a voucher by token

Specified by:

loadByToken in interface VoucherService

Throws:

FrameworkException

print

public SerializableInputStream print(java.lang.Long id)
                              throws FrameworkException

Description copied from interface: VoucherService

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

Specified by:

print in interface VoucherService

Throws:

FrameworkException

printAll

public SerializableInputStream printAll(VoucherQuery query,
                                        boolean markAsPrinted)
                                 throws FrameworkException

Description copied from interface: VoucherService

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

Specified by:

printAll in interface VoucherService

Throws:

FrameworkException

redeem

public RedeemVoucherResult redeem(RedeemVoucherDTO params)
                           throws FrameworkException

Description copied from interface: VoucherService

Redeems a voucher, returning the generated voucher id

Specified by:

redeem in interface VoucherService

Throws:

FrameworkException

search

public Page<VoucherVO> search(VoucherQuery params)
                       throws FrameworkException

Description copied from interface: VoucherService

Searches for vouchers according to the given filters

Specified by:

search in interface VoucherService

Throws:

FrameworkException

searchWithSummary

public VouchersResultsWithSummaryVO searchWithSummary(VoucherQuery params)
                                               throws FrameworkException

Description copied from interface: VoucherService

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

Specified by:

searchWithSummary in interface VoucherService

Throws:

FrameworkException

resolveEntityCheck

protected org.cyclos.impl.access.EntityCheck<?> resolveEntityCheck()

Description copied from class: BaseServiceSecurity

Must be implemented in order to return the EntityCheck managed by this security component, or null if none

Specified by:

resolveEntityCheck in class BaseServiceSecurity