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

Methods

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	construct(com.crm.dataobject.vouchers.CRMDOLot lot, java.math.BigDecimal voucherValue, java.math.BigDecimal voucherExtraAddedValue) Constructs a voucher with specific characteristics.
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.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.
com.crm.dataobject.vouchers.CRMDOVoucher	loadAdditionalInformation(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Loads additional information of the voucher.
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 a voucher related with a payment of the given voucher.
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	use(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Uses a voucher.

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, createAndUpdate, delete, delete, delete, getDOName, getDOName, getNextSequenceNumber, getNextSequenceNumber, getNumberScheme, load, load, load, load, load, load, load, load, loadAll, loadAll, loadAll, parseAssociations, save, save, save, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, validateOnDelete, validateOnDelete, validateOnDelete, validateOnSave, validateOnSave, validateOnSave

Methods inherited from class com.crm.businessobject.CRMBase

dispatch, getCRMSession, getCRMSessionHandle, 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

construct

public com.crm.dataobject.vouchers.CRMDOVoucher construct(com.crm.dataobject.vouchers.CRMDOLot lot,
                                                 java.math.BigDecimal voucherValue,
                                                 java.math.BigDecimal voucherExtraAddedValue)
                                                   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

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

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

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

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

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

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 a voucher related with a payment of the given voucher.

Parameters:

voucher - - the voucher to load from the related payment

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(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

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