Package org.cyclos.services.banking

Interface VoucherCustomFieldService

All Superinterfaces:

BaseCustomFieldService<VoucherCustomFieldDTO,VoucherCustomFieldData,Void>, CRUDService<VoucherCustomFieldDTO,VoucherCustomFieldData,Void>, Service

All Known Subinterfaces:

VoucherCustomFieldServiceLocal

public interface VoucherCustomFieldService
extends BaseCustomFieldService<VoucherCustomFieldDTO,VoucherCustomFieldData,Void>

Service for voucher custom fields

Method Summary

Modifier and Type	Method	Description
void	addRelation(@NotNull VoucherTypeVO voucherType, @NotNull CustomFieldVO customField)	Relates the given voucher type with the given custom field
List<CustomFieldVO>	list()	Lists all voucher custom fields with detailed information
List<CustomFieldVO>	listAllRelated(@NotNull VoucherTypeVO voucherType)	Returns all the custom fields which are related to the given voucher type
List<CustomFieldVO>	listRelated(@NotNull VoucherTypeVO voucherType, UserVO userVO)	Returns the custom fields which are visible (according to the products) and related to the given voucher type
void	removeRelation(@NotNull VoucherTypeVO voucherType, @NotNull CustomFieldVO customField)	Removes the given voucher type with the given custom field

Methods inherited from interface org.cyclos.services.system.BaseCustomFieldService

saveOrder

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

addRelation

void addRelation(@NotNull
                 @NotNull VoucherTypeVO voucherType,
                 @NotNull
                 @NotNull CustomFieldVO customField)
          throws FrameworkException

Relates the given voucher type with the given custom field

Throws:

FrameworkException

list

List<CustomFieldVO> list()
                  throws FrameworkException

Lists all voucher custom fields with detailed information

Throws:

FrameworkException

listAllRelated

List<CustomFieldVO> listAllRelated(@NotNull
                                   @NotNull VoucherTypeVO voucherType)
                            throws FrameworkException

Returns all the custom fields which are related to the given voucher type

Throws:

FrameworkException

listRelated

List<CustomFieldVO> listRelated(@NotNull
                                @NotNull VoucherTypeVO voucherType,
                                UserVO userVO)
                         throws FrameworkException

Returns the custom fields which are visible (according to the products) and related to the given voucher type

Throws:

FrameworkException

removeRelation

void removeRelation(@NotNull
                    @NotNull VoucherTypeVO voucherType,
                    @NotNull
                    @NotNull CustomFieldVO customField)
             throws FrameworkException

Removes the given voucher type with the given custom field

Throws:

FrameworkException