com.crm.process.vouchers

Class CRMProcessVoucherBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.process.CRMProcess

com.crm.process.vouchers.CRMProcessVoucherBean

All Implemented Interfaces:

java.io.Serializable

public class CRMProcessVoucherBean
extends CRMProcess

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMProcessVoucherBean()

Method Summary

Modifier and Type	Method and Description
void	acceptVouchers(java.lang.String processNum, java.lang.String lotID) Handles the lot acceptance process invoked by the scheduler.
void	activateVoucher(com.crm.dataobject.vouchers.CRMDOVoucher voucher, java.lang.String processRunLogID) Activates a voucher.
void	activateVouchers(java.lang.String processRunLogID) Handles the voucher activation process invoked by the scheduler.
void	activateVouchers(java.lang.String processRunLogID, java.lang.String voucherTypeID, java.lang.String lotID, java.lang.String fromNumber, java.lang.String toNumber) Handles the voucher activation process invoked by the scheduler.
void	amendLot(java.lang.String processNum, java.lang.String lotID, java.lang.Integer additionalVouchersToBeGenerated) Amends the lot.
com.crm.dataobject.financialtransactions.CRMDOInvoiceLine	calculateAvailableQuantity(com.crm.dataobject.financialtransactions.CRMDOInvoiceLine invoiceLine) Calculates the available quantity of vouchers for the given invoice line
com.crm.dataobject.vouchers.CRMDOVoucher	cancelElectronicVoucher(com.crm.dataobject.vouchers.CRMDOVoucher voucher, com.crm.dataobject.vouchers.VoucherCancellationReason cancellationReason) Cancels an electronic voucher.
void	cancelVouchers(java.lang.String processRunLogID) Handles the voucher cancellation process invoked by the scheduler.
void	cancelVouchers(java.lang.String processRunLogID, java.lang.String voucherTypeID, java.lang.String lotID, java.lang.String fromNumber, java.lang.String toNumber, java.lang.String partnerAccountID, java.lang.String invoiceID) Handles the voucher cancellation process invoked by the scheduler.
java.lang.String	constructInvoicedVouchersFile(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice)
com.crm.dataobject.financialtransactions.CRMDOCreditNote	createCreditNoteForReturnVoucherProcess(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.util.ArrayList<com.crm.dataobject.financialtransactions.CRMDOInvoiceLine> invoiceLines) Creates and posts a credit note for the return vouchers process.
java.lang.String	exportLotVouchers(com.crm.dataobject.vouchers.CRMDOLot lot)
java.lang.String	exportLotVouchers(com.crm.dataobject.vouchers.CRMDOLot lot, java.lang.String fileName) Exports a lot's vouchers to a file.
java.lang.String	exportLotVouchers(java.lang.String lotId, java.lang.String fileName) Exports the specified lot to an encrypted file.
void	generateLotVouchers(java.lang.String processNum, java.lang.String lotID, java.math.BigDecimal voucherValue, java.math.BigDecimal voucherExtraAddedValue) This method is invoked by the scheduler to generate a lot's vouchers.
com.crm.framework.util.ResultSetUtil	getDraftVouchers(java.lang.String lotID) Returns the draft vouchers of a lot.
java.lang.String[]	getFileHeaders() Return an array with the header of the export file
java.lang.String	getProcessRestrictedStateList(com.crm.dataobject.vouchers.VoucherProcess voucherProcess) Returns the restricted state list of a process.
java.lang.String	getProcessRestrictedStateListLabels(com.crm.dataobject.vouchers.VoucherProcess voucherProcess) Returns the labels of the restricted states of a process.
com.crm.framework.util.ResultSetUtil	getVouchersToBeActivated(java.lang.String voucherTypeID, java.lang.String lotID, java.lang.String fromNumber, java.lang.String toNumber) Returns the vouchers to be activated by a set of criteria.
com.crm.framework.util.ResultSetUtil	getVouchersToBeCanceled(java.lang.String voucherTypeID, java.lang.String lotID, java.lang.String fromNumber, java.lang.String toNumber, java.lang.String partnerAccountID, java.lang.String invoiceID) Returns the vouchers to be cancelled by a set of criteria.
com.crm.framework.util.ResultSetUtil	getVouchersToBeExported(java.lang.String lotID) Returns the vouchers of a lot to be exported.
com.crm.framework.util.ResultSetUtil	getVouchersToBePurged(java.lang.String lotIDs, java.lang.String voucherTypeIDs, java.lang.Integer daysAfterExpiration, java.lang.Integer applyOnDraft, java.lang.Integer applyOnAccepted, java.lang.Integer applyOnNotAccepted, java.lang.Integer applyOnCancelled) Returns the vouchers to be purged by a set of criteria.
com.crm.framework.util.ResultSetUtil	getVouchersToBeReturned(java.lang.String partnerAccountID, java.lang.String invoicedByID, java.lang.String fromNumber, java.lang.String toNumber) Returns the vouchers to be activated by a set of criteria.
void	importVoucher(com.crm.dataobject.vouchers.CRMDOVoucher voucher, com.crm.dataobject.CRMDOAttachment attachment, com.crm.dataobject.vouchers.ImportVoucherDefinition importVoucherDefinition, com.crm.dataobject.processrun.CRMDOProcessRunLog processRun)
void	modifyVouchers(java.lang.String processNum, java.lang.String lotID, java.lang.String newEffectiveDateSQL, java.lang.String newExpirationDateSQL, java.lang.String voucherTypeID, java.math.BigDecimal voucherValue, java.math.BigDecimal voucherExtraAddedValue) Handles the voucher modification process invoked by the scheduler.
com.crm.dataobject.vouchers.CRMDOVoucher	purchaseElectronicVoucher(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Purchases an electronic voucher.
com.crm.dataobject.vouchers.CRMDOVoucher	purchaseElectronicVoucherThroughRetailer(com.crm.dataobject.vouchers.CRMDOVoucher voucher) Purchases an electronic voucher through a Retailer.
java.util.Set<com.crm.dataobject.vouchers.CRMDOVoucher>	purchaseElectronicVoucherUsingWalletFunds(com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, java.lang.Integer quantity) Purchases an electronic voucher using wallet funds.
void	purgeVouchers(java.lang.String processRunLogID) Handles the voucher purging process invoked by the scheduler.
void	purgeVouchers(java.lang.String processRunLogID, java.lang.String lotIDs, java.lang.String voucherTypeIDs, java.lang.Integer daysAfterExpiration, java.lang.Integer applyOnDraft, java.lang.Integer applyOnAccepted, java.lang.Integer applyOnNotAccepted, java.lang.Integer applyOnCancelled) Handles the voucher purging process invoked by the scheduler.
void	rejectVouchers(java.lang.String processNum, java.lang.String lotID) Handles the lot rejection process invoked by the scheduler.
void	returnVouchers(java.lang.String processRunLogID) Handles the voucher return process invoked by the scheduler.
void	returnVouchers(java.lang.String processRunLogID, java.lang.String fromNumber, java.lang.String toNumber, java.lang.String partnerAccountID, java.lang.String invoicedByID) Handles the voucher return process invoked by the scheduler.
void	scheduleLotAcceptance(com.crm.dataobject.vouchers.CRMDOLot lot, java.util.Date executionDate) Creates a scheduled job for the lot acceptance process.
void	scheduleLotAmendment(com.crm.dataobject.vouchers.CRMDOLot lot, java.lang.Integer additionalVouchersToBeGenerated, java.util.Date executionDate) Schedules a lot amendment.
void	scheduleVoucherActivation(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, com.crm.dataobject.vouchers.CRMDOLot lot, java.lang.String fromNumber, java.lang.String toNumber, java.util.Date executionDate) Creates a scheduled job for the voucher activation process.
void	scheduleVoucherCancellation(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType, com.crm.dataobject.vouchers.CRMDOLot lot, java.lang.String fromNumber, java.lang.String toNumber, com.crm.dataobject.accounts.CRMDOAccountReceivable partnerAccount, com.crm.dataobject.financialtransactions.CRMDOInvoice invoice, java.util.Date executionDate) Creates a scheduled job for the voucher cancellation process.
void	scheduleVoucherGeneration(java.lang.String lotID, java.util.Date executionDate, java.math.BigDecimal voucherValue, java.math.BigDecimal voucherExtraAddedValue) Creates a scheduled job for the voucher generation process.
void	scheduleVoucherModification(com.crm.dataobject.vouchers.CRMDOLot lot, java.util.Date newEffectiveDate, java.util.Date newExpirationDate, java.lang.String voucherTypeID, java.math.BigDecimal voucherValue, java.math.BigDecimal voucherExtraAddedValue, java.util.Date executionDate) Creates a scheduled job for the voucher modification process.
void	scheduleVoucherPurging(java.lang.Integer daysAfterExpiration, java.lang.Integer applyOnDraft, java.lang.Integer applyOnAccepted, java.lang.Integer applyOnNotAccepted, java.lang.Integer applyOnCancelled, java.util.Date executionDate, java.util.ArrayList<com.crm.dataobject.vouchers.CRMDOLot> lots, java.util.ArrayList<com.crm.dataobject.vouchers.CRMDOVoucherType> voucherTypes) Creates a scheduled job for the voucher purging process.
void	scheduleVoucherRejection(com.crm.dataobject.vouchers.CRMDOLot lot, java.util.Date executionDate) Creates a scheduled job for the lot rejection process.
void	scheduleVoucherReturn(java.lang.String fromNumber, java.lang.String toNumber, com.crm.dataobject.accounts.CRMDOAccountReceivable partnerAccount, com.crm.dataobject.financialtransactions.CRMDOInvoice invoicedBy, java.util.Date executionDate) Creates a scheduled job for the voucher return process.
com.crm.dataobject.financialtransactions.CRMDOInvoice	sellVouchers(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice) Processes a vouchers sale.
com.crm.dataobject.financialtransactions.CRMDOInvoice	sellVouchers(java.util.Set<com.crm.dataobject.vouchers.VouchersSaleProduct> products, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType invoiceType, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionCategory category, java.util.Date dueDate) Processes a vouchers sale.
com.crm.dataobject.vouchers.CRMDOVoucher	useVoucher(com.crm.dataobject.vouchers.CRMDOVoucher voucher, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionCategory paymentCategory, java.lang.String notes) Uses a voucher.
void	validatePurchaseElectronicVoucherUsingWalletFunds(com.crm.dataobject.wallets.CRMDOWallet wallet, com.crm.dataobject.vouchers.CRMDOVoucherType voucherType) Validates the purchase of the Electronic Voucher Using Wallet Funds

Methods inherited from class com.crm.process.CRMProcess

createCronExpressionFromDate, createCronExpressionFromDate, setMandatoryField

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

Constructor Detail

CRMProcessVoucherBean

public CRMProcessVoucherBean()

Method Detail

generateLotVouchers

public void generateLotVouchers(java.lang.String processNum,
                                java.lang.String lotID,
                                java.math.BigDecimal voucherValue,
                                java.math.BigDecimal voucherExtraAddedValue)
                         throws java.lang.Exception

This method is invoked by the scheduler to generate a lot's vouchers.

Parameters:

processNum - - the process number

lotID - - the id of the lot to generate the vouchers for

Throws:

java.lang.Exception

scheduleVoucherGeneration

public void scheduleVoucherGeneration(java.lang.String lotID,
                                      java.util.Date executionDate,
                                      java.math.BigDecimal voucherValue,
                                      java.math.BigDecimal voucherExtraAddedValue)
                               throws java.lang.Exception

Creates a scheduled job for the voucher generation process.

Parameters:

lotID - - the id of the lot to be processed

executionDate - - the process execution date

voucherExtraAddedValue -

voucherValue -

Throws:

java.lang.Exception

scheduleLotAcceptance

public void scheduleLotAcceptance(com.crm.dataobject.vouchers.CRMDOLot lot,
                                  java.util.Date executionDate)
                           throws java.lang.Exception

Creates a scheduled job for the lot acceptance process.

Parameters:

lot - - a lot to be processed

executionDate - - the process execution date

Throws:

java.lang.Exception

acceptVouchers

public void acceptVouchers(java.lang.String processNum,
                           java.lang.String lotID)
                    throws java.lang.Exception

Handles the lot acceptance process invoked by the scheduler.

Parameters:

processNum - - the number of the scheduler process

lotID - - the id of the vouchers lot

Throws:

java.lang.Exception

scheduleVoucherRejection

public void scheduleVoucherRejection(com.crm.dataobject.vouchers.CRMDOLot lot,
                                     java.util.Date executionDate)
                              throws java.lang.Exception

Creates a scheduled job for the lot rejection process.

Parameters:

lot - - a lot to be processed

executionDate - - the process execution date

Throws:

java.lang.Exception

rejectVouchers

public void rejectVouchers(java.lang.String processNum,
                           java.lang.String lotID)
                    throws java.lang.Exception

Handles the lot rejection process invoked by the scheduler.

Parameters:

lotID - - a lot id to be processed

Throws:

java.lang.Exception

scheduleVoucherActivation

public void scheduleVoucherActivation(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                      com.crm.dataobject.vouchers.CRMDOLot lot,
                                      java.lang.String fromNumber,
                                      java.lang.String toNumber,
                                      java.util.Date executionDate)
                               throws java.lang.Exception,
                                      com.crm.exception.AtLeastOneFieldException,
                                      com.crm.exception.vouchers.VoucherNotFoundException

Creates a scheduled job for the voucher activation process.

Parameters:

voucherType - - the voucher type of the vouchers to be activated

lot - - the lot to be activated

fromNumber - - the start of the number range of the vouchers to be activated

toNumber - - the end of the number range of the vouchers to be activated

executionDate - - the process execution date

Throws:

java.lang.Exception

com.crm.exception.AtLeastOneFieldException

com.crm.exception.vouchers.VoucherNotFoundException

activateVoucher

public void activateVoucher(com.crm.dataobject.vouchers.CRMDOVoucher voucher,
                            java.lang.String processRunLogID)
                     throws java.lang.Exception

Activates a voucher. Activates and saves the voucher Logs the voucher activation

Parameters:

voucher - - the voucher to activate

processRunLogID - - the process run log ID

Throws:

java.lang.Exception

activateVouchers

public void activateVouchers(java.lang.String processRunLogID)
                      throws java.lang.Exception

Handles the voucher activation process invoked by the scheduler.

Parameters:

processRunLogID - - the process run log

Throws:

java.lang.Exception

activateVouchers

public void activateVouchers(java.lang.String processRunLogID,
                             java.lang.String voucherTypeID,
                             java.lang.String lotID,
                             java.lang.String fromNumber,
                             java.lang.String toNumber)
                      throws java.lang.Exception

Handles the voucher activation process invoked by the scheduler.

Parameters:

processRunLogID - - the process run log

voucherTypeID - - the voucher type of the vouchers to be activated

lotID - - the id of the lot to be activated

fromNumber - - the start of the voucher number range to be activated

toNumber - - the end of the voucher number range to be activated

Throws:

java.lang.Exception

scheduleVoucherCancellation

public void scheduleVoucherCancellation(com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                        com.crm.dataobject.vouchers.CRMDOLot lot,
                                        java.lang.String fromNumber,
                                        java.lang.String toNumber,
                                        com.crm.dataobject.accounts.CRMDOAccountReceivable partnerAccount,
                                        com.crm.dataobject.financialtransactions.CRMDOInvoice invoice,
                                        java.util.Date executionDate)
                                 throws java.lang.Exception,
                                        com.crm.exception.AtLeastOneFieldException,
                                        com.crm.exception.vouchers.VoucherCannotBeCancelledException

Creates a scheduled job for the voucher cancellation process.

Parameters:

voucherType - - the voucher type of the vouchers to be cancelled

lot - - the lot to be cancelled

fromNumber - - the start of the number range of the vouchers to be cancelled

toNumber - - the end of the number range of the vouchers to be cancelled

executionDate - - the process execution date

Throws:

java.lang.Exception

com.crm.exception.AtLeastOneFieldException

com.crm.exception.vouchers.VoucherCannotBeCancelledException

cancelVouchers

public void cancelVouchers(java.lang.String processRunLogID)
                    throws java.lang.Exception

Handles the voucher cancellation process invoked by the scheduler.

Parameters:

processRunLogID - - the process run log

Throws:

java.lang.Exception

cancelVouchers

public void cancelVouchers(java.lang.String processRunLogID,
                           java.lang.String voucherTypeID,
                           java.lang.String lotID,
                           java.lang.String fromNumber,
                           java.lang.String toNumber,
                           java.lang.String partnerAccountID,
                           java.lang.String invoiceID)
                    throws java.lang.Exception

Handles the voucher cancellation process invoked by the scheduler.

Parameters:

processRunLogID - - the process run log

voucherTypeID - - the voucher type of the vouchers to be cancelled

lotID - - the ID of the lot to be cancelled

fromNumber - - the start of the voucher number range to be cancelled

toNumber - - the end of the voucher number range to be cancelled

partnerAccountID - - the partner account that owns the vouchers to be cancelled

invoiceID - - the invoice that billed the vouchers to be cancelled

Throws:

java.lang.Exception

scheduleVoucherReturn

public void scheduleVoucherReturn(java.lang.String fromNumber,
                                  java.lang.String toNumber,
                                  com.crm.dataobject.accounts.CRMDOAccountReceivable partnerAccount,
                                  com.crm.dataobject.financialtransactions.CRMDOInvoice invoicedBy,
                                  java.util.Date executionDate)
                           throws java.lang.Exception,
                                  com.crm.exception.AtLeastOneFieldException,
                                  com.crm.exception.vouchers.VoucherCannotBeReturnedException

Creates a scheduled job for the voucher return process.

Parameters:

fromNumber - - the start of the number range of the vouchers to be returned

toNumber - - the end of the number range of the vouchers to be returned

partnerAccount - - the partner account that owns the vouchers to be returned

invoicedBy - - the invoice that billed the account that owns the vouchers to be returned

executionDate - - the process execution date

Throws:

java.lang.Exception

com.crm.exception.AtLeastOneFieldException

com.crm.exception.vouchers.VoucherCannotBeReturnedException

returnVouchers

public void returnVouchers(java.lang.String processRunLogID)
                    throws java.lang.Exception

Handles the voucher return process invoked by the scheduler.

Parameters:

processRunLogID - - the process run log

Throws:

java.lang.Exception

returnVouchers

public void returnVouchers(java.lang.String processRunLogID,
                           java.lang.String fromNumber,
                           java.lang.String toNumber,
                           java.lang.String partnerAccountID,
                           java.lang.String invoicedByID)
                    throws java.lang.Exception

Handles the voucher return process invoked by the scheduler.

Parameters:

processRunLogID - - the process run log

fromNumber - - the start of the voucher number range to be returned

toNumber - - the end of the voucher number range to be returned

partnerAccountID - - the partner account that owns the vouchers to be returned

invoicedByID - - the invoice that billed the vouchers to be returned

Throws:

java.lang.Exception

createCreditNoteForReturnVoucherProcess

public com.crm.dataobject.financialtransactions.CRMDOCreditNote createCreditNoteForReturnVoucherProcess(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                                                                        java.util.ArrayList<com.crm.dataobject.financialtransactions.CRMDOInvoiceLine> invoiceLines)
                                                                                                 throws java.lang.Exception

Creates and posts a credit note for the return vouchers process.

Parameters:

account - - the account to post the credit note against

invoiceLines - - the invoice lines of the invoices that billed the vouchers to be returned

Returns:

the created credit note

Throws:

java.lang.Exception

scheduleVoucherPurging

public void scheduleVoucherPurging(java.lang.Integer daysAfterExpiration,
                                   java.lang.Integer applyOnDraft,
                                   java.lang.Integer applyOnAccepted,
                                   java.lang.Integer applyOnNotAccepted,
                                   java.lang.Integer applyOnCancelled,
                                   java.util.Date executionDate,
                                   java.util.ArrayList<com.crm.dataobject.vouchers.CRMDOLot> lots,
                                   java.util.ArrayList<com.crm.dataobject.vouchers.CRMDOVoucherType> voucherTypes)
                            throws java.lang.Exception,
                                   com.crm.exception.AtLeastOneFieldException

Creates a scheduled job for the voucher purging process.

Parameters:

daysAfterExpiration - - the number of days after the expiration date

applyOnDraft - - indicates that only the vouchers with state Draft should be purged (1) or not (0)

applyOnAccepted - - indicates that only the vouchers with state Accepted for Activation should be purged (1) or not (0)

applyOnNotAccepted - - indicates that only the vouchers with state Not Accepted for Activation should be purged (1) or not (0)

applyOnCancelled - - indicates that only the vouchers with state Cancelled should be purged (1) or not (0)

executionDate - - the process execution date

voucherTypes -

lots -

Throws:

java.lang.Exception

com.crm.exception.AtLeastOneFieldException

purgeVouchers

public void purgeVouchers(java.lang.String processRunLogID)
                   throws java.lang.Exception

Handles the voucher purging process invoked by the scheduler.

Parameters:

processRunLogID - - the process run log

Throws:

java.lang.Exception

purgeVouchers

public void purgeVouchers(java.lang.String processRunLogID,
                          java.lang.String lotIDs,
                          java.lang.String voucherTypeIDs,
                          java.lang.Integer daysAfterExpiration,
                          java.lang.Integer applyOnDraft,
                          java.lang.Integer applyOnAccepted,
                          java.lang.Integer applyOnNotAccepted,
                          java.lang.Integer applyOnCancelled)
                   throws java.lang.Exception

Handles the voucher purging process invoked by the scheduler.

Parameters:

processRunLogID - - the process run log

lotIDs - - the lots of the vouchers that should be purged

voucherTypeIDs - - the voucher types of the vouchers that should be purged

daysAfterExpiration - - the number of days after the expiration date

applyOnDraft - - indicates that only the vouchers with state Draft should be purged (1) or not (0)

applyOnAccepted - - indicates that only the vouchers with state Accepted for Activation should be purged (1) or not (0)

applyOnNotAccepted - - indicates that only the vouchers with state Not Accepted for Activation should be purged (1) or not (0)

applyOnCancelled - - indicates that only the vouchers with state Cancelled should be purged (1) or not (0)

Throws:

java.lang.Exception

scheduleVoucherModification

public void scheduleVoucherModification(com.crm.dataobject.vouchers.CRMDOLot lot,
                                        java.util.Date newEffectiveDate,
                                        java.util.Date newExpirationDate,
                                        java.lang.String voucherTypeID,
                                        java.math.BigDecimal voucherValue,
                                        java.math.BigDecimal voucherExtraAddedValue,
                                        java.util.Date executionDate)
                                 throws java.lang.Exception

Creates a scheduled job for the voucher modification process.

Parameters:

lot - - a lot to be processed

newEffectiveDate - - the lot and lot's vouchers new effective date

newExpirationDate - - the lot and lot's vouchers new expiration date

voucherTypeID - - the lot and lot's vouchers new voucher type

voucherExtraAddedValue -

voucherValue -

executionDate - - the process execution date

Throws:

java.lang.Exception

modifyVouchers

public void modifyVouchers(java.lang.String processNum,
                           java.lang.String lotID,
                           java.lang.String newEffectiveDateSQL,
                           java.lang.String newExpirationDateSQL,
                           java.lang.String voucherTypeID,
                           java.math.BigDecimal voucherValue,
                           java.math.BigDecimal voucherExtraAddedValue)
                    throws java.lang.Exception

Handles the voucher modification process invoked by the scheduler.

Parameters:

processNum -

lotID -

newEffectiveDateSQL -

newExpirationDateSQL -

voucherTypeID -

voucherValue -

voucherExtraAddedValue -

Throws:

java.lang.Exception

exportLotVouchers

public java.lang.String exportLotVouchers(java.lang.String lotId,
                                          java.lang.String fileName)
                                   throws java.lang.Exception

Exports the specified lot to an encrypted file.

Parameters:

lotId - the ID of the lot to export

Returns:

the path of the exported file

Throws:

java.lang.Exception

exportLotVouchers

public java.lang.String exportLotVouchers(com.crm.dataobject.vouchers.CRMDOLot lot)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

exportLotVouchers

public java.lang.String exportLotVouchers(com.crm.dataobject.vouchers.CRMDOLot lot,
                                          java.lang.String fileName)
                                   throws java.lang.Exception

Exports a lot's vouchers to a file.

Parameters:

lot - - the lot to export the vouchers for

fileName - - the export file name

Returns:

the file path

Throws:

java.lang.Exception

getProcessRestrictedStateList

public java.lang.String getProcessRestrictedStateList(com.crm.dataobject.vouchers.VoucherProcess voucherProcess)
                                               throws java.lang.Exception

Returns the restricted state list of a process.

Parameters:

voucherProcess - - the process id

Returns:

the restricted state list of the given process

Throws:

java.lang.Exception

getProcessRestrictedStateListLabels

public java.lang.String getProcessRestrictedStateListLabels(com.crm.dataobject.vouchers.VoucherProcess voucherProcess)
                                                     throws java.lang.Exception

Returns the labels of the restricted states of a process.

Parameters:

voucherProcess - - the process id

Returns:

the restricted state list labels of the given process

Throws:

java.lang.Exception

purchaseElectronicVoucher

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

Purchases an electronic voucher. Sets the account that purchased the voucher as the account that owns the voucher Validates the voucher Constructs an invoice against the account that purchased the voucher and posts the voucher's payment Saves the voucher Creates and saves the voucher history

Parameters:

voucher - - the voucher to purchase

Returns:

the purchased voucher

Throws:

java.lang.Exception

purchaseElectronicVoucherThroughRetailer

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

Purchases an electronic voucher through a Retailer. Sets the account that purchased the voucher as the account that owns the voucher Validates the voucher Constructs an invoice against the retailer's account and posts it Saves the voucher Creates and saves the voucher history

Parameters:

voucher - - the voucher to purchase

Returns:

the purchased voucher

Throws:

java.lang.Exception

purchaseElectronicVoucherUsingWalletFunds

public java.util.Set<com.crm.dataobject.vouchers.CRMDOVoucher> purchaseElectronicVoucherUsingWalletFunds(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                                                                         com.crm.dataobject.vouchers.CRMDOVoucherType voucherType,
                                                                                                         java.lang.Integer quantity)
                                                                                                  throws java.lang.Exception

Purchases an electronic voucher using wallet funds.

Parameters:

wallet - - the wallet to purchase the voucher for

voucherType - - The voucher type that the participant wants to buy

quantity - - The quantity of vouchers to buy

Returns:

the purchased voucher

Throws:

java.lang.Exception

validatePurchaseElectronicVoucherUsingWalletFunds

public void validatePurchaseElectronicVoucherUsingWalletFunds(com.crm.dataobject.wallets.CRMDOWallet wallet,
                                                              com.crm.dataobject.vouchers.CRMDOVoucherType voucherType)
                                                       throws java.lang.Exception

Validates the purchase of the Electronic Voucher Using Wallet Funds

Parameters:

wallet - - the wallet to validate

voucherType - - the voucher Type to validate

Throws:

java.lang.Exception

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. Constructs the electronic voucher history Validates the cancellation of the voucher Cancels the voucher and sets the cancellation reason Saves the voucher and the voucher history

Parameters:

voucher - - the voucher to cancel

cancellationReason - - the cancellation reason

Returns:

the cancelled voucher

Throws:

java.lang.Exception

useVoucher

public com.crm.dataobject.vouchers.CRMDOVoucher useVoucher(com.crm.dataobject.vouchers.CRMDOVoucher voucher,
                                                           com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                           com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionCategory paymentCategory,
                                                           java.lang.String notes)
                                                    throws java.lang.Exception

Uses a voucher. Constructs the voucher history Validates that the voucher can be used If the voucher is a Printed Payment Voucher or an Electronic Payment Voucher, constructs a payment that has the default payment type defined on the voucher type, sets the payment's account receivable, payment category, notes and amount and validates, saves and posts the payment Uses the voucher and saves it Saves the voucher history

Parameters:

voucher - - the voucher to use

accountReceivable - - the voucher account receivable

paymentCategory - - the payment category to set on the created payment

notes - - the notes to set on the created payment

Returns:

the used voucher

Throws:

java.lang.Exception

getVouchersToBeCanceled

public com.crm.framework.util.ResultSetUtil getVouchersToBeCanceled(java.lang.String voucherTypeID,
                                                                    java.lang.String lotID,
                                                                    java.lang.String fromNumber,
                                                                    java.lang.String toNumber,
                                                                    java.lang.String partnerAccountID,
                                                                    java.lang.String invoiceID)
                                                             throws java.lang.Exception

Returns the vouchers to be cancelled by a set of criteria.

Parameters:

voucherTypeID - - the voucher type ID

lotID - - the lot ID

fromNumber - - the voucher From Number of the vouchers to be cancelled

toNumber - - the voucher To Number of the vouchers to be cancelled

partnerAccountID - - the partner account that owns the vouchers to be cancelled

invoiceID - - the invoice that billed the vouchers to be cancelled

Returns:

the vouchers to be cancelled by the given criteria

Throws:

java.lang.Exception

getVouchersToBeActivated

public com.crm.framework.util.ResultSetUtil getVouchersToBeActivated(java.lang.String voucherTypeID,
                                                                     java.lang.String lotID,
                                                                     java.lang.String fromNumber,
                                                                     java.lang.String toNumber)
                                                              throws java.lang.Exception

Returns the vouchers to be activated by a set of criteria.

Parameters:

voucherTypeID - - the voucher type ID

lotID - - the lot ID

fromNumber - - the voucher From Number of the vouchers to be cancelled

toNumber - - the voucher To Number of the vouchers to be cancelled

Returns:

the vouchers to be activated by the given criteria

Throws:

java.lang.Exception

getVouchersToBePurged

public com.crm.framework.util.ResultSetUtil getVouchersToBePurged(java.lang.String lotIDs,
                                                                  java.lang.String voucherTypeIDs,
                                                                  java.lang.Integer daysAfterExpiration,
                                                                  java.lang.Integer applyOnDraft,
                                                                  java.lang.Integer applyOnAccepted,
                                                                  java.lang.Integer applyOnNotAccepted,
                                                                  java.lang.Integer applyOnCancelled)
                                                           throws java.lang.Exception

Returns the vouchers to be purged by a set of criteria.

Parameters:

daysAfterExpiration - - the number of days after the expiration date

applyOnDraft - - indicates that only the vouchers with state Draft should be purged (1) or not (0)

applyOnAccepted - - indicates that only the vouchers with state Accepted for Activation should be purged (1) or not (0)

applyOnNotAccepted - - indicates that only the vouchers with state Not Accepted for Activation should be purged (1) or not (0)

applyOnCancelled - - indicates that only the vouchers with state Cancelled should be purged (1) or not (0)

Returns:

the vouchers to be purged by the given criteria

Throws:

java.lang.Exception

getVouchersToBeReturned

public com.crm.framework.util.ResultSetUtil getVouchersToBeReturned(java.lang.String partnerAccountID,
                                                                    java.lang.String invoicedByID,
                                                                    java.lang.String fromNumber,
                                                                    java.lang.String toNumber)
                                                             throws java.lang.Exception

Returns the vouchers to be activated by a set of criteria.

Parameters:

partnerAccountID - - the partner account ID

invoicedByID - - the invoice ID

fromNumber - - the voucher From Number of the vouchers to be cancelled

toNumber - - the voucher To Number of the vouchers to be cancelled

Returns:

the vouchers to be activated by the given criteria

Throws:

java.lang.Exception

getDraftVouchers

public com.crm.framework.util.ResultSetUtil getDraftVouchers(java.lang.String lotID)
                                                      throws java.lang.Exception

Returns the draft vouchers of a lot.

Parameters:

lotID - - the lot ID

Returns:

- the draft vouchers

Throws:

java.lang.Exception

getVouchersToBeExported

public com.crm.framework.util.ResultSetUtil getVouchersToBeExported(java.lang.String lotID)
                                                             throws java.lang.Exception

Returns the vouchers of a lot to be exported.

Parameters:

lotID - - the lot ID

Returns:

the vouchers to be exported

Throws:

java.lang.Exception

scheduleLotAmendment

public void scheduleLotAmendment(com.crm.dataobject.vouchers.CRMDOLot lot,
                                 java.lang.Integer additionalVouchersToBeGenerated,
                                 java.util.Date executionDate)
                          throws java.lang.Exception

Schedules a lot amendment.

Parameters:

lot - - the lot to amend

additionalVouchersToBeGenerated - - the additional number of vouchers to be generated

executionDate - - the execution date

Throws:

java.lang.Exception

amendLot

public void amendLot(java.lang.String processNum,
                     java.lang.String lotID,
                     java.lang.Integer additionalVouchersToBeGenerated)
              throws java.lang.Exception

Amends the lot.

Parameters:

processNum - - the process number

lotID - - the lot id

additionalVouchersToBeGenerated - - the additional number of vouchers to be generated

Throws:

java.lang.Exception

constructInvoicedVouchersFile

public java.lang.String constructInvoicedVouchersFile(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getFileHeaders

public java.lang.String[] getFileHeaders()
                                  throws java.lang.Exception

Return an array with the header of the export file

Returns:

the array with the headers of the file

Throws:

java.lang.Exception

sellVouchers

public com.crm.dataobject.financialtransactions.CRMDOInvoice sellVouchers(java.util.Set<com.crm.dataobject.vouchers.VouchersSaleProduct> products,
                                                                          com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                          com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType invoiceType,
                                                                          com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionCategory category,
                                                                          java.util.Date dueDate)
                                                                   throws java.lang.Exception

Processes a vouchers sale. Validates that the mandatory fields (products, accountReceivable, invoiceType) are given Constructs an invoice for the given account Sets the invoice type, category and due date Validates that the mandatory fields for each product (voucher type, price plan, requested option and requested values) are given and using the product creates an invoice line and sets the line's cost, vat rate and discount Calculates the invoice net amount, discount amount, vat amount, tax amount and total amount Sets the invoice items on the invoice Sells the vouchers to the account owner

Parameters:

products - - the products that will be used to create the invoice lines. (mandatory)

accountReceivable - - the account receivable to which the vouchers will be sold. (mandatory)

invoiceType - - the type of the invoice to be created. (mandatory)

category - - the category of the invoice to be created

dueDate - - the invoice's due date

Returns:

the invoice created for the vouchers sale

Throws:

java.lang.Exception

calculateAvailableQuantity

public com.crm.dataobject.financialtransactions.CRMDOInvoiceLine calculateAvailableQuantity(com.crm.dataobject.financialtransactions.CRMDOInvoiceLine invoiceLine)
                                                                                     throws java.lang.Exception

Calculates the available quantity of vouchers for the given invoice line

Parameters:

invoiceLine - - the invoice line to calculate the available vouchers quantity for

Returns:

the updated invoice line

Throws:

java.lang.Exception

sellVouchers

public com.crm.dataobject.financialtransactions.CRMDOInvoice sellVouchers(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice)
                                                                   throws java.lang.Exception

Processes a vouchers sale. Validates the invoice items and the invoice account Validates and saves the invoice Stocks out the physical goods of the invoice Sets the invoice's vat information Retrieves the vouchers to sell and sets the invoice account as the account that owns the vouchers and the invoice as the vouchers' related invoice Posts the invoice Sets the outstanding and unsettled amount on the invoice Sends communications for the invoice

Parameters:

invoice - - the invoice generated to bill the owner of the account for the vouchers sale

Returns:

the invoice

Throws:

java.lang.Exception

importVoucher

public void importVoucher(com.crm.dataobject.vouchers.CRMDOVoucher voucher,
                          com.crm.dataobject.CRMDOAttachment attachment,
                          com.crm.dataobject.vouchers.ImportVoucherDefinition importVoucherDefinition,
                          com.crm.dataobject.processrun.CRMDOProcessRunLog processRun)
                   throws java.lang.Exception

Throws:

java.lang.Exception