com.crm.businessobject.vouchers

Class CRMBOVoucherBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.CRMBOMasterEntity

com.crm.businessobject.vouchers.CRMBOVoucherBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOVoucherBean
extends CRMBOMasterEntity

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	VOUCHERS_MAINTAIN_FEATURE_ID
java.lang.String	VOUCHERS_MODULE_ID

Constructor Summary

Constructors

Constructor and Description
CRMBOVoucherBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
com.crm.dataobject.vouchers.CRMDOVoucher	accept(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Accepts a voucher.
com.crm.dataobject.vouchers.CRMDOVoucher	activate(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Activates a voucher.
com.crm.dataobject.vouchers.CRMDOVoucher	cancel(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Cancels a voucher.
com.crm.dataobject.vouchers.CRMDOVoucher	cancelElectronicVoucher(com.crm.dataobject.vouchers.CRMDOVoucher voucher, com.crm.dataobject.vouchers.VoucherCancellationReason cancellationReason) Cancels an electronic voucher.
com.crm.dataobject.vouchers.CRMDOVoucher	construct(com.crm.dataobject.vouchers.CRMDOLot lot, java.math.BigDecimal voucherValue, java.math.BigDecimal voucherExtraAddedValue, com.crm.dataobject.accounts.CRMDOAccountReceivable internalAccount) Constructs a voucher with specific characteristics.
com.crm.dataobject.vouchers.CRMDOVoucher	copyInformationFromType(com.crm.dataobject.vouchers.CRMDOVoucher voucher, com.crm.dataobject.vouchers.CRMDOVoucherType voucherType)
java.lang.String	decryptSecretNumber(java.lang.String voucherSecretNumber) Decrypts and returns the secret number of a voucher.
java.lang.String	encryptSecretNumber(java.lang.String voucherSecretNumber) Encrypts and returns the secret number of a voucher.
com.crm.framework.util.ResultSetUtil	getAcceptedForActivation(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, com.crm.dataobject.vouchers.CRMDOLot lot, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.networkmanagement.CRMDOUnitGroup group, com.crm.dataobject.networkmanagement.CRMDOUnit unit, java.lang.Integer maxRows)
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Gets the default association data objects of the voucher.
java.util.HashMap<com.crm.dataobject.LifeCycleState,java.lang.String>	getProcessRestrictedStates(com.crm.dataobject.vouchers.CRMDOVoucherDefinition voucherDefinition, com.crm.dataobject.vouchers.VoucherProcess voucherProcess) Returns the process restricted life cycle states for a voucher definition.
java.lang.String	getSecretNumber(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Decrypts and returns the secret number of a voucher.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.Boolean availableForUse, java.lang.Integer numberOfResults, java.lang.Integer offSet, java.util.ArrayList<java.lang.String> associations) Loads a list of vouchers that are available to be used based on the given account.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.Integer numberOfResults, java.lang.Integer offSet) Loads a list of vouchers related with the given account.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.Integer numberOfResults, java.lang.Integer offSet, java.util.ArrayList<java.lang.String> associations) Loads a list of vouchers related with the given account.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.vouchers.CRMDOLot lot) Loads vouchers based on a lot.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.vouchers.CRMDOLot lot, java.util.ArrayList<java.lang.String> associations) Loads vouchers based on a lot.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, com.crm.dataobject.vouchers.CRMDOLot lot) Loads a list of vouchers based on a voucher type and a lot.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, com.crm.dataobject.vouchers.CRMDOLot lot, java.util.ArrayList<java.lang.String> associations) Loads a list of vouchers based on a voucher type and a lot.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, com.crm.dataobject.vouchers.CRMDOLot lot, com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.networkmanagement.CRMDOUnitGroup group, com.crm.dataobject.networkmanagement.CRMDOUnit unit) Loads a list of vouchers based on a voucher type, a lot, a related account, a related group and a related unit.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, com.crm.dataobject.vouchers.CRMDOLot lot, com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.networkmanagement.CRMDOUnitGroup group, com.crm.dataobject.networkmanagement.CRMDOUnit unit, java.util.ArrayList<java.lang.String> associations) Loads a list of vouchers based on a voucher type, a lot, a related account, a related group and a related unit.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, com.crm.dataobject.vouchers.CRMDOLot lot, com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.networkmanagement.CRMDOUnitGroup group, com.crm.dataobject.networkmanagement.CRMDOUnit unit, com.crm.dataobject.vouchers.VoucherLifeCycleState lifeCycleState, java.util.ArrayList<java.lang.String> associations) Loads a list of vouchers based on a voucher type, a lot, a related account, a related group and a related unit.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(java.lang.String orderBy, java.lang.Integer numberOfResults, java.lang.Integer offSet, com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, com.crm.dataobject.vouchers.CRMDOLot lot, java.util.ArrayList<java.lang.String> associations) Loads a list of vouchers based on a voucher type and a lot.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadActivatedVouchers(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, com.crm.dataobject.vouchers.CRMDOLot lot, java.lang.String rangeFrom, java.lang.String rangeTo, java.lang.String orderBy, java.lang.Integer numberOfResults, java.util.ArrayList<java.lang.String> associations) Loads the number of activated vouchers based on a voucher type and a lot or a range of voucher numbers.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadActivatedVouchersByLot(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, com.crm.dataobject.vouchers.CRMDOLot lot) Loads all the activated vouchers from the given lot having the given voucher type
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadActivatedVouchersByLot(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, com.crm.dataobject.vouchers.CRMDOLot lot, java.util.ArrayList<java.lang.String> associations) Loads all the activated vouchers from the given lot having the given voucher type with the given associations
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadActivatedVouchersByNumberRange(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, java.lang.String rangeFrom, java.lang.String rangeTo) Loads all the activated vouchers with numbers between the given range and having the given voucher type
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadActivatedVouchersByNumberRange(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, java.lang.String rangeFrom, java.lang.String rangeTo, java.util.ArrayList<java.lang.String> associations) Loads all the activated vouchers with numbers between the given range and having the given voucher type with the given associations
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadActivatedVouchersByType(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType) Loads all the activated vouchers having the given voucher type
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadActivatedVouchersByType(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, java.util.ArrayList<java.lang.String> associations) Loads all the activated vouchers having the given voucher type with the given associations
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadActivatedVouchersByType(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, java.lang.Integer quantity) Loads a quantity of activated vouchers having the given voucher type
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadActivatedVouchersByType(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, java.lang.Integer quantity, java.util.ArrayList<java.lang.String> associations) Loads a quantity of activated vouchers having the given voucher type with the given associations
com.crm.dataobject.vouchers.CRMDOVoucher	loadAdditionalInformation(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Loads additional information of the voucher.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAvailableForUse(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.Integer numberOfResults, java.lang.Integer offSet) Loads a list of vouchers that are available to be used based on the given account.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadByInvoice(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice) Loads vouchers based on an invoice.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadByInvoice(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice, java.lang.String orderBy)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadByInvoice(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice, java.lang.String orderBy, java.util.ArrayList<java.lang.String> associations) Loads vouchers based on an invoice.
com.crm.dataobject.vouchers.CRMDOVoucher	loadByNumber(java.lang.String number) Loads a voucher based on a number.
com.crm.dataobject.vouchers.CRMDOVoucher	loadByNumber(java.lang.String number, java.util.ArrayList<java.lang.String> associations) Loads the voucher based on a number.
com.crm.dataobject.vouchers.CRMDOVoucher	loadBySecretNumber(java.lang.String secretNumber) Loads a voucher based a secret number.
com.crm.dataobject.vouchers.CRMDOVoucher	loadBySecretNumber(java.lang.String secretNumber, java.util.ArrayList<java.lang.String> associations) Loads a voucher based a secret number.
com.crm.dataobject.vouchers.CRMDOVoucher	loadPayment(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Loads the payment related with the given voucher.
com.crm.dataobject.vouchers.CRMDOVoucher	loadRefund(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Loads the refund related with the given voucher.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadUsedVouchers(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.Integer numberOfResults, java.lang.Integer offSet) Loads a list of vouchers that were used based on the given account.
java.util.ArrayList<com.crm.dataobject.vouchers.VoucherLifeCycleState>	loadVouchersLifeCycleState(com.crm.dataobject.vouchers.CRMDOLot lot) Loads vouchers life cycle states based on a lot.
com.crm.dataobject.vouchers.CRMDOVoucher	modify(com.crm.dataobject.vouchers.CRMDOVoucher voucher, com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, java.math.BigDecimal voucherValue, java.math.BigDecimal voucherExtraAddedValue, java.util.Date newEffectiveDate, java.util.Date newExpirationDate) Modifies a voucher.
com.crm.dataobject.vouchers.CRMDOVoucher	purge(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Purges a voucher.
com.crm.dataobject.vouchers.CRMDOVoucher	reject(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Rejects a voucher.
com.crm.dataobject.vouchers.CRMDOVoucher	returnVoucher(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Returns a voucher.
com.crm.dataobject.vouchers.CRMDOVoucher	setCurrency(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
com.crm.dataobject.vouchers.CRMDOVoucher	setVoucherSecretNumber(com.crm.dataobject.vouchers.CRMDOVoucher voucher, com.crm.dataobject.vouchers.CRMDOVoucherType voucherType) Sets the voucher secret number.
com.crm.dataobject.vouchers.CRMDOVoucher	setVoucherValidityPeriod(com.crm.dataobject.vouchers.CRMDOVoucher voucher, com.crm.dataobject.vouchers.CRMDOVoucherType voucherType) Sets the voucher validity period based on a voucher type validity period.
com.crm.dataobject.vouchers.CRMDOVoucher	setVoucherValue(com.crm.dataobject.vouchers.CRMDOVoucher voucher, com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, java.math.BigDecimal value, java.math.BigDecimal extraAddedValue) Sets the voucher value based the voucher type.
com.crm.dataobject.vouchers.CRMDOVoucher	use(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Uses a voucher.
com.crm.dataobject.vouchers.CRMDOVoucher	use(com.crm.dataobject.vouchers.CRMDOVoucher voucher, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Uses a voucher.
void	validateOnCancel(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Validates a voucher on cancel.
void	validateOnUse(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Validates a voucher on use
void	validateOnUse(com.crm.dataobject.vouchers.CRMDOVoucher voucher, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Validates a voucher on use

Methods inherited from class com.crm.businessobject.CRMBOMasterEntity

setLifeCycleState

Methods inherited from class com.crm.businessobject.CRMBO

construct, construct, construct, construct, construct, construct, construct, construct, construct, createAndUpdate, delete, delete, delete, getDOName, getDOName, getNextSequenceNumber, getNextSequenceNumber, getNumberScheme, isAssignable, load, load, load, load, load, load, load, load, load, load, load, load, load, load, loadAll, loadAll, loadAll, loadAllEntityStatusDO, loadAllEntityStatusDO, loadDataObject, loadDataObject, loadDataObject, loadDataObjects, loadDataObjects, loadEntityCategoryDO, loadEntityCategoryDO, loadEntityDO, loadEntityDO, loadEntityStatusDO, loadEntityStatusDO, parseAssociations, parseAssociations, parseAssociations, save, save, save, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, validateApprovalRequestEntity, validateFormatSettings, validateFormatSettings, validateOnDelete, validateOnDelete, validateOnDelete, validateOnSave, validateOnSave, validateOnSave

Methods inherited from class com.crm.businessobject.CRMBase

deepCopy, dispatch, getCRMSession, getCRMSessionHandle, getCurrentDate, getEJBHomeInterface, getInitialContext, getSessionContext, invoke, setCRMSessionHandle, setInitialContext, setSessionContext

Methods inherited from class java.lang.Object

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

Field Detail

VOUCHERS_MODULE_ID

public final java.lang.String VOUCHERS_MODULE_ID

See Also:

Constant Field Values

VOUCHERS_MAINTAIN_FEATURE_ID

public final java.lang.String VOUCHERS_MAINTAIN_FEATURE_ID

See Also:

Constant Field Values

Constructor Detail

CRMBOVoucherBean

public CRMBOVoucherBean()

Default constructor.

Method Detail

copyInformationFromType

public com.crm.dataobject.vouchers.CRMDOVoucher copyInformationFromType(com.crm.dataobject.vouchers.CRMDOVoucher voucher,
                                                                        com.crm.dataobject.vouchers.CRMDOVoucherType voucherType)
                                                                 throws java.lang.Exception

Throws:

java.lang.Exception

setCurrency

public com.crm.dataobject.vouchers.CRMDOVoucher setCurrency(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

construct

public com.crm.dataobject.vouchers.CRMDOVoucher construct(com.crm.dataobject.vouchers.CRMDOLot lot,
                                                          java.math.BigDecimal voucherValue,
                                                          java.math.BigDecimal voucherExtraAddedValue,
                                                          com.crm.dataobject.accounts.CRMDOAccountReceivable internalAccount)
                                                   throws java.lang.Exception

Constructs a voucher with specific characteristics.

Parameters:

lot - - the lot to relate the voucher with

voucherValue - - the voucher voucher

voucherExtraAddedValue - - the extra added value

Returns:

a voucher

Throws:

java.lang.Exception

setVoucherSecretNumber

public com.crm.dataobject.vouchers.CRMDOVoucher setVoucherSecretNumber(com.crm.dataobject.vouchers.CRMDOVoucher voucher,
                                                                       com.crm.dataobject.vouchers.CRMDOVoucherType voucherType)
                                                                throws java.lang.Exception

Sets the voucher secret number.

Parameters:

voucher - - the voucher to set the secret number to

voucherType - - the voucher type

Returns:

the updated voucher

Throws:

java.lang.Exception

setVoucherValue

public com.crm.dataobject.vouchers.CRMDOVoucher setVoucherValue(com.crm.dataobject.vouchers.CRMDOVoucher voucher,
                                                                com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                                java.math.BigDecimal value,
                                                                java.math.BigDecimal extraAddedValue)
                                                         throws java.lang.Exception

Sets the voucher value based the voucher type.

Parameters:

voucher - - the voucher to set the value to

voucherType - - the voucher type

value - - the voucher value

extraAddedValue - - the extra added value

Returns:

the updated voucher

Throws:

java.lang.Exception

setVoucherValidityPeriod

public com.crm.dataobject.vouchers.CRMDOVoucher setVoucherValidityPeriod(com.crm.dataobject.vouchers.CRMDOVoucher voucher,
                                                                         com.crm.dataobject.vouchers.CRMDOVoucherType voucherType)
                                                                  throws java.lang.Exception

Sets the voucher validity period based on a voucher type validity period.

Parameters:

voucher - - the voucher to set the validity period to

voucherType - - the voucher type

Returns:

the updated voucher

Throws:

java.lang.Exception

getDefaultAssociations

public java.util.ArrayList<java.lang.String> getDefaultAssociations()

Gets the default association data objects of the voucher.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the voucher

accept

public com.crm.dataobject.vouchers.CRMDOVoucher accept(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
                                                throws java.lang.Exception,
                                                       com.crm.exception.vouchers.VoucherAcceptanceException

Accepts a voucher.

Parameters:

voucher - - the voucher to accept

Returns:

the updated voucher

Throws:

java.lang.Exception

com.crm.exception.vouchers.VoucherAcceptanceException

reject

public com.crm.dataobject.vouchers.CRMDOVoucher reject(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
                                                throws java.lang.Exception,
                                                       com.crm.exception.vouchers.VoucherRejectionException

Rejects a voucher.

Parameters:

voucher - - the voucher to reject.

Returns:

the updated voucher

Throws:

java.lang.Exception

com.crm.exception.vouchers.VoucherRejectionException

activate

public com.crm.dataobject.vouchers.CRMDOVoucher activate(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
                                                  throws java.lang.Exception,
                                                         com.crm.exception.vouchers.VoucherActivationException

Activates a voucher.

Parameters:

voucher - - the voucher to activate

Returns:

the updated voucher

Throws:

java.lang.Exception

com.crm.exception.vouchers.VoucherActivationException

cancel

public com.crm.dataobject.vouchers.CRMDOVoucher cancel(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
                                                throws java.lang.Exception,
                                                       com.crm.exception.vouchers.VoucherCancellationException

Cancels a voucher.

Parameters:

voucher - - the voucher to cancel

Returns:

the updated voucher

Throws:

java.lang.Exception

com.crm.exception.vouchers.VoucherCancellationException

cancelElectronicVoucher

public com.crm.dataobject.vouchers.CRMDOVoucher cancelElectronicVoucher(com.crm.dataobject.vouchers.CRMDOVoucher voucher,
                                                                        com.crm.dataobject.vouchers.VoucherCancellationReason cancellationReason)
                                                                 throws java.lang.Exception

Cancels an electronic voucher.

Parameters:

voucher - - the electronic voucher to cancel

Returns:

the updated electronic voucher

Throws:

java.lang.Exception

returnVoucher

public com.crm.dataobject.vouchers.CRMDOVoucher returnVoucher(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
                                                       throws java.lang.Exception

Returns a voucher.

Parameters:

voucher - - the voucher to cancel

Returns:

the updated voucher

Throws:

java.lang.Exception

purge

public com.crm.dataobject.vouchers.CRMDOVoucher purge(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
                                               throws java.lang.Exception,
                                                      com.crm.exception.vouchers.VoucherPurgeException

Purges a voucher.

Parameters:

voucher - - the voucher to purge

Returns:

the updated voucher

Throws:

java.lang.Exception

com.crm.exception.vouchers.VoucherPurgeException

loadBySecretNumber

public com.crm.dataobject.vouchers.CRMDOVoucher loadBySecretNumber(java.lang.String secretNumber)
                                                            throws java.lang.Exception

Loads a voucher based a secret number.

Parameters:

secretNumber - - the secret number

Returns:

the voucher with specified secret number

Throws:

java.lang.Exception

loadBySecretNumber

public com.crm.dataobject.vouchers.CRMDOVoucher loadBySecretNumber(java.lang.String secretNumber,
                                                                   java.util.ArrayList<java.lang.String> associations)
                                                            throws java.lang.Exception,
                                                                   com.crm.exception.vouchers.VoucherNotFoundException

Loads a voucher based a secret number.

Parameters:

secretNumber - - the secret number

associations - - a list of related associations

Returns:

the voucher with specified secret number

Throws:

java.lang.Exception

com.crm.exception.vouchers.VoucherNotFoundException

validateOnUse

public void validateOnUse(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
                   throws java.lang.Exception

Validates a voucher on use

Parameters:

voucher - - the voucher to validate

Throws:

java.lang.Exception

validateOnUse

public void validateOnUse(com.crm.dataobject.vouchers.CRMDOVoucher voucher,
                          com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                   throws java.lang.Exception

Validates a voucher on use

Parameters:

voucher - - the voucher to validate

accountReceivable - - the account that will use the voucher

Throws:

java.lang.Exception

validateOnCancel

public void validateOnCancel(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
                      throws java.lang.Exception

Validates a voucher on cancel.

Parameters:

voucher - - the voucher to validate

Throws:

java.lang.Exception

use

public com.crm.dataobject.vouchers.CRMDOVoucher use(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
                                             throws java.lang.Exception,
                                                    com.crm.exception.InvalidValueException,
                                                    com.crm.exception.vouchers.VoucherUsageException,
                                                    com.crm.exception.vouchers.VoucherUsageDateException

Uses a voucher.
- validates if it can be used and if so, sets the life cycle state to USED.

Parameters:

voucher - - the voucher to use

Returns:

the updated voucher

Throws:

java.lang.Exception

com.crm.exception.InvalidValueException

com.crm.exception.vouchers.VoucherUsageException

com.crm.exception.vouchers.VoucherUsageDateException

use

public com.crm.dataobject.vouchers.CRMDOVoucher use(com.crm.dataobject.vouchers.CRMDOVoucher voucher,
                                                    com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                             throws java.lang.Exception,
                                                    com.crm.exception.InvalidValueException,
                                                    com.crm.exception.vouchers.VoucherUsageException,
                                                    com.crm.exception.vouchers.VoucherUsageDateException

Uses a voucher.
- validates if it can be used and if so, sets the life cycle state to USED.

Parameters:

voucher - - the voucher to use

accountReceivable - - the account that will use the voucher

Returns:

the updated voucher

Throws:

java.lang.Exception

com.crm.exception.InvalidValueException

com.crm.exception.vouchers.VoucherUsageException

com.crm.exception.vouchers.VoucherUsageDateException

modify

public com.crm.dataobject.vouchers.CRMDOVoucher modify(com.crm.dataobject.vouchers.CRMDOVoucher voucher,
                                                       com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                       java.math.BigDecimal voucherValue,
                                                       java.math.BigDecimal voucherExtraAddedValue,
                                                       java.util.Date newEffectiveDate,
                                                       java.util.Date newExpirationDate)
                                                throws java.lang.Exception,
                                                       com.crm.exception.vouchers.VoucherModificationException

Modifies a voucher.

Parameters:

voucher - - the voucher to modify

voucherType - - the new voucher type of the voucher

voucherValue - - the new voucher value of the voucher

voucherExtraAddedValue - - the new voucher extra added value of the voucher

newEffectiveDate - - the new voucher effective date of the voucher

newExpirationDate - - the new voucher expiration date of the voucher

Returns:

the updated voucher

Throws:

java.lang.Exception

com.crm.exception.vouchers.VoucherModificationException

getSecretNumber

public java.lang.String getSecretNumber(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
                                 throws java.lang.Exception,
                                        com.crm.exception.CannotDecryptException

Decrypts and returns the secret number of a voucher.

Parameters:

voucher - - the voucher to use

Returns:

the voucher secret number

Throws:

java.lang.Exception

com.crm.exception.CannotDecryptException

decryptSecretNumber

public java.lang.String decryptSecretNumber(java.lang.String voucherSecretNumber)
                                     throws java.lang.Exception,
                                            com.crm.exception.CannotDecryptException

Decrypts and returns the secret number of a voucher.

Parameters:

voucherSecretNumber - - the voucher secret number

Returns:

the voucher secret number

Throws:

java.lang.Exception

com.crm.exception.CannotDecryptException

encryptSecretNumber

public java.lang.String encryptSecretNumber(java.lang.String voucherSecretNumber)
                                     throws java.lang.Exception,
                                            com.crm.exception.CannotDecryptException

Encrypts and returns the secret number of a voucher.

Parameters:

voucherSecretNumber - - the voucher secret number

Returns:

the voucher secret number

Throws:

java.lang.Exception

com.crm.exception.CannotEncryptException

com.crm.exception.CannotDecryptException

getProcessRestrictedStates

public java.util.HashMap<com.crm.dataobject.LifeCycleState,java.lang.String> getProcessRestrictedStates(com.crm.dataobject.vouchers.CRMDOVoucherDefinition voucherDefinition,
                                                                                                        com.crm.dataobject.vouchers.VoucherProcess voucherProcess)
                                                                                                 throws java.lang.Exception

Returns the process restricted life cycle states for a voucher definition.

Parameters:

voucherDefinition - - the voucher definition

voucherProcess - - the voucher process

Returns:

the restricted life cycle states

Throws:

java.lang.Exception

loadByNumber

public com.crm.dataobject.vouchers.CRMDOVoucher loadByNumber(java.lang.String number)
                                                      throws java.lang.Exception

Loads a voucher based on a number.

Parameters:

number - - the voucher number

Returns:

the voucher with the specified number

Throws:

java.lang.Exception

loadByNumber

public com.crm.dataobject.vouchers.CRMDOVoucher loadByNumber(java.lang.String number,
                                                             java.util.ArrayList<java.lang.String> associations)
                                                      throws java.lang.Exception

Loads the voucher based on a number.

Parameters:

number - - the voucher number

associations - - a list of associated data objects

Returns:

the voucher with the specified number

Throws:

java.lang.Exception

loadActivatedVouchersByType

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadActivatedVouchersByType(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType)
                                                                          throws java.lang.Exception

Loads all the activated vouchers having the given voucher type

Parameters:

voucherType - - the type the vouchers should have

Returns:

a list of activated vouchers

Throws:

java.lang.Exception

loadActivatedVouchersByType

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadActivatedVouchersByType(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                                                 java.util.ArrayList<java.lang.String> associations)
                                                                          throws java.lang.Exception

Loads all the activated vouchers having the given voucher type with the given associations

Parameters:

voucherType - - the type the vouchers should have

associations - - a list of associated objects

Returns:

a list of activated vouchers

Throws:

java.lang.Exception

loadActivatedVouchersByType

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadActivatedVouchersByType(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                                                 java.lang.Integer quantity)
                                                                          throws java.lang.Exception

Loads a quantity of activated vouchers having the given voucher type

Parameters:

voucherType - - the type the vouchers should have

quantity - - the quantity of vouchers to load

Returns:

the qiven quantity of activated vouchers

Throws:

java.lang.Exception

loadActivatedVouchersByType

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadActivatedVouchersByType(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                                                 java.lang.Integer quantity,
                                                                                 java.util.ArrayList<java.lang.String> associations)
                                                                          throws java.lang.Exception

Loads a quantity of activated vouchers having the given voucher type with the given associations

Parameters:

voucherType - - the type the vouchers should have

quantity - - the quantity of vouchers to load

associations - - a list of associated objects

Returns:

the qiven quantity of activated vouchers

Throws:

java.lang.Exception

loadActivatedVouchersByLot

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadActivatedVouchersByLot(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                                                com.crm.dataobject.vouchers.CRMDOLot lot)
                                                                         throws java.lang.Exception

Loads all the activated vouchers from the given lot having the given voucher type

Parameters:

voucherType - - the type the vouchers should have

lot - - the vouchers' lot

Returns:

a list of activated vouchers

Throws:

java.lang.Exception

loadActivatedVouchersByLot

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadActivatedVouchersByLot(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                                                com.crm.dataobject.vouchers.CRMDOLot lot,
                                                                                java.util.ArrayList<java.lang.String> associations)
                                                                         throws java.lang.Exception

Loads all the activated vouchers from the given lot having the given voucher type with the given associations

Parameters:

voucherType - - the type the vouchers should have

lot - - the vouchers' lot

associations - - a list of associated objects

Returns:

a list of activated vouchers

Throws:

java.lang.Exception

loadActivatedVouchersByNumberRange

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadActivatedVouchersByNumberRange(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                                                        java.lang.String rangeFrom,
                                                                                        java.lang.String rangeTo)
                                                                                 throws java.lang.Exception

Loads all the activated vouchers with numbers between the given range and having the given voucher type

Parameters:

voucherType - - the type the vouchers should have

rangeFrom - - the voucher number where the range begins

rangeTo - - the voucher number where range ends

Returns:

a list of activated vouchers within the given range

Throws:

java.lang.Exception

loadActivatedVouchersByNumberRange

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadActivatedVouchersByNumberRange(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                                                        java.lang.String rangeFrom,
                                                                                        java.lang.String rangeTo,
                                                                                        java.util.ArrayList<java.lang.String> associations)
                                                                                 throws java.lang.Exception

Loads all the activated vouchers with numbers between the given range and having the given voucher type with the given associations

Parameters:

voucherType - - the type the vouchers should have

rangeFrom - - the voucher number where the range begins

rangeTo - - the voucher number where range ends

associations - - a list of activated vouchers

Returns:

a list of activated vouchers within the given range

Throws:

java.lang.Exception

loadActivatedVouchers

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadActivatedVouchers(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                                           com.crm.dataobject.vouchers.CRMDOLot lot,
                                                                           java.lang.String rangeFrom,
                                                                           java.lang.String rangeTo,
                                                                           java.lang.String orderBy,
                                                                           java.lang.Integer numberOfResults,
                                                                           java.util.ArrayList<java.lang.String> associations)
                                                                    throws java.lang.Exception

Loads the number of activated vouchers based on a voucher type and a lot or a range of voucher numbers.

Parameters:

voucherType - - the voucher type the vouchers should have

lot - - the vouchers' lot

rangeFrom - - the voucher number where the range begins

rangeTo - - the voucher number where range ends

orderBy - - the ordering field

numberOfResults - - the quantity of vouchers to retrieve

associations - - a list of associated data objects

Returns:

the number of activated vouchers

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.vouchers.CRMDOLot lot)
                                                   throws java.lang.Exception

Loads vouchers based on a lot.

Parameters:

lot - - the lot to load the vouchers from

Returns:

a list of vouchers of the given lot

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.vouchers.CRMDOLot lot,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception,
                                                          com.crm.exception.vouchers.VoucherNotFoundException

Loads vouchers based on a lot.

Parameters:

lot - - the lot to load the vouchers from

associations - - a list of associated data objects

Returns:

a list of vouchers of the given lot

Throws:

java.lang.Exception

com.crm.exception.vouchers.VoucherNotFoundException

loadVouchersLifeCycleState

public java.util.ArrayList<com.crm.dataobject.vouchers.VoucherLifeCycleState> loadVouchersLifeCycleState(com.crm.dataobject.vouchers.CRMDOLot lot)
                                                                                                  throws java.lang.Exception

Loads vouchers life cycle states based on a lot.

Parameters:

lot - - the lot to load the vouchers life cycle states from

Returns:

a list of vouchers life cycle states of the given lot

Throws:

java.lang.Exception

loadByInvoice

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadByInvoice(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice)
                                                            throws java.lang.Exception

Loads vouchers based on an invoice.

Parameters:

invoice - - the invoice to load the vouchers from

Returns:

a list of vouchers

Throws:

java.lang.Exception

loadByInvoice

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadByInvoice(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice,
                                                                   java.lang.String orderBy)
                                                            throws java.lang.Exception

Throws:

java.lang.Exception

loadByInvoice

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadByInvoice(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice,
                                                                   java.lang.String orderBy,
                                                                   java.util.ArrayList<java.lang.String> associations)
                                                            throws java.lang.Exception

Loads vouchers based on an invoice.

Parameters:

invoice - - the invoice to load the vouchers from

orderBy - - the order by clause

associations - - a list of associated data objects

Returns:

a list of vouchers

Throws:

java.lang.Exception

loadAdditionalInformation

public com.crm.dataobject.vouchers.CRMDOVoucher loadAdditionalInformation(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
                                                                   throws java.lang.Exception

Loads additional information of the voucher.

Parameters:

voucher - - the voucher to load the additional information for

Returns:

the updated voucher

Throws:

java.lang.Exception

loadPayment

public com.crm.dataobject.vouchers.CRMDOVoucher loadPayment(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
                                                     throws java.lang.Exception

Loads the payment related with the given voucher.

Parameters:

voucher - - the voucher to load from the related payment

Returns:

the updated voucher

Throws:

java.lang.Exception

loadRefund

public com.crm.dataobject.vouchers.CRMDOVoucher loadRefund(com.crm.dataobject.vouchers.CRMDOVoucher voucher)
                                                    throws java.lang.Exception

Loads the refund related with the given voucher.

Parameters:

voucher - - the voucher to load from the related refund

Returns:

the updated voucher

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                          com.crm.dataobject.vouchers.CRMDOLot lot)
                                                   throws java.lang.Exception

Loads a list of vouchers based on a voucher type and a lot.

Parameters:

voucherType - - the voucher type

lot - - the lot

Returns:

a list of vouchers based on the given voucher type and lot

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                          com.crm.dataobject.vouchers.CRMDOLot lot,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of vouchers based on a voucher type and a lot.

Parameters:

voucherType - - the voucher type

lot - - the lot

associations - - a list of associated data objects

Returns:

a list of vouchers based on a voucher type and a lot

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(java.lang.String orderBy,
                                                          java.lang.Integer numberOfResults,
                                                          java.lang.Integer offSet,
                                                          com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                          com.crm.dataobject.vouchers.CRMDOLot lot,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of vouchers based on a voucher type and a lot.

Parameters:

numberOfResults - - The number of results that can be retrieved

orderBy - - the ordering field

offSet - - It defines the number of entities that should be skipped from the results

voucherType - - the voucher type

lot - - the lot

associations - - a list of associated data objects

Returns:

a list of vouchers based on a voucher type and a lot

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                          com.crm.dataobject.vouchers.CRMDOLot lot,
                                                          com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                          com.crm.dataobject.networkmanagement.CRMDOUnitGroup group,
                                                          com.crm.dataobject.networkmanagement.CRMDOUnit unit)
                                                   throws java.lang.Exception

Loads a list of vouchers based on a voucher type, a lot, a related account, a related group and a related unit.

Parameters:

voucherType - - the voucher type

lot - - the lot

account - - the account related to the voucher

group - - the group related to the voucher

unit - - the unit related to the voucher

Returns:

a list of vouchers based on the given voucher type, lot, related account, related group and related unit

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                          com.crm.dataobject.vouchers.CRMDOLot lot,
                                                          com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                          com.crm.dataobject.networkmanagement.CRMDOUnitGroup group,
                                                          com.crm.dataobject.networkmanagement.CRMDOUnit unit,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of vouchers based on a voucher type, a lot, a related account, a related group and a related unit.

Parameters:

voucherType - - the voucher type

lot - - the lot

account - - the account related to the voucher

group - - the group related to the voucher

unit - - the unit related to the voucher

associations - - a list of associated data objects

Returns:

a list of vouchers based on the given voucher type, lot, related account, related group and related unit

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                          com.crm.dataobject.vouchers.CRMDOLot lot,
                                                          com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                          com.crm.dataobject.networkmanagement.CRMDOUnitGroup group,
                                                          com.crm.dataobject.networkmanagement.CRMDOUnit unit,
                                                          com.crm.dataobject.vouchers.VoucherLifeCycleState lifeCycleState,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of vouchers based on a voucher type, a lot, a related account, a related group and a related unit.

Parameters:

voucherType - - the voucher type

lot - - the lot

account - - the account related to the voucher

group - - the group related to the voucher

unit - - the unit related to the voucher

lifeCycleState - - the life cycle state of the voucher

associations - - a list of associated data objects

Returns:

a list of vouchers based on the given voucher type, lot, related account, related group and related unit

Throws:

java.lang.Exception

getAcceptedForActivation

public com.crm.framework.util.ResultSetUtil getAcceptedForActivation(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                                     com.crm.dataobject.vouchers.CRMDOLot lot,
                                                                     com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                     com.crm.dataobject.networkmanagement.CRMDOUnitGroup group,
                                                                     com.crm.dataobject.networkmanagement.CRMDOUnit unit,
                                                                     java.lang.Integer maxRows)
                                                              throws java.lang.Exception

Throws:

java.lang.Exception

loadAvailableForUse

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadAvailableForUse(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                         java.lang.Integer numberOfResults,
                                                                         java.lang.Integer offSet)
                                                                  throws java.lang.Exception

Loads a list of vouchers that are available to be used based on the given account.

Parameters:

accountReceivable - - the account receivable to load the vouchers that are available to use

numberOfResults - - The number of results that can be retrieved

offSet - - It defines the number of entities that should be skipped from the results

Returns:

a list of vouchers that are available to be used

Throws:

java.lang.Exception

loadUsedVouchers

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadUsedVouchers(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                      java.lang.Integer numberOfResults,
                                                                      java.lang.Integer offSet)
                                                               throws java.lang.Exception

Loads a list of vouchers that were used based on the given account.

Parameters:

accountReceivable - - the account receivable to load the vouchers that were used

numberOfResults - - The number of results that can be retrieved

offSet - - It defines the number of entities that should be skipped from the results

Returns:

a list of vouchers that were used

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          java.lang.Boolean availableForUse,
                                                          java.lang.Integer numberOfResults,
                                                          java.lang.Integer offSet,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of vouchers that are available to be used based on the given account.

Parameters:

accountReceivable - - the account receivable to load the vouchers for

availableForUse - - if true then only activated vouchers which are not expired will be retrieved, otherwise only vouchers that were used or expired will be retrieved

numberOfResults - - The number of results that can be retrieved

offSet - - It defines the number of entities that should be skipped from the results

associations - - a list of associated data objects

Returns:

a list of vouchers that are available to be used

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          java.lang.Integer numberOfResults,
                                                          java.lang.Integer offSet)
                                                   throws java.lang.Exception

Loads a list of vouchers related with the given account.

Parameters:

accountReceivable - - the account receivable to load the related vouchers

numberOfResults - - The number of results that can be retrieved

offSet - - It defines the number of entities that should be skipped from the results

Returns:

a list of vouchers

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          java.lang.Integer numberOfResults,
                                                          java.lang.Integer offSet,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of vouchers related with the given account.

Parameters:

accountReceivable - - the account receivable to load the related vouchers

numberOfResults - - The number of results that can be retrieved

offSet - - It defines the number of entities that should be skipped from the results

associations - - a list of associated data objects

Returns:

a list of vouchers that were used

Throws:

java.lang.Exception