org.killbill.billing.invoice.dao

Class DefaultInvoiceDao

java.lang.Object

org.killbill.billing.util.entity.dao.EntityDaoBase<InvoiceModelDao,Invoice,InvoiceApiException>

org.killbill.billing.invoice.dao.DefaultInvoiceDao

All Implemented Interfaces:

InvoiceDao, EntityDao<InvoiceModelDao,Invoice,InvoiceApiException>

public class DefaultInvoiceDao
extends EntityDaoBase<InvoiceModelDao,Invoice,InvoiceApiException>
implements InvoiceDao

Field Summary

Fields inherited from class org.killbill.billing.util.entity.dao.EntityDaoBase

paginationHelper, transactionalSqlDao

Constructor Summary

Constructors

Constructor and Description

DefaultInvoiceDao(TagInternalApi tagInternalApi, org.skife.jdbi.v2.IDBI dbi, org.skife.jdbi.v2.IDBI roDbi, NextBillingDatePoster nextBillingDatePoster, org.killbill.bus.api.PersistentBus eventBus, org.killbill.clock.Clock clock, CacheControllerDispatcher cacheControllerDispatcher, NonEntityDao nonEntityDao, InvoiceConfig invoiceConfig, InvoiceDaoHelper invoiceDaoHelper, CBADao cbaDao, ParentInvoiceCommitmentPoster parentInvoiceCommitmentPoster, InternalCallContextFactory internalCallContextFactory)

Method Summary

Modifier and Type	Method and Description
void	changeInvoiceStatus(java.util.UUID invoiceId, InvoiceStatus newStatus, InternalCallContext context) Update invoice status
java.util.Map<java.util.UUID,java.math.BigDecimal>	computeItemAdjustments(java.lang.String invoiceId, java.util.Map<java.util.UUID,java.math.BigDecimal> invoiceItemIdsWithNullAmounts, InternalTenantContext context)
void	consumeExstingCBAOnAccountWithUnpaidInvoices(java.util.UUID accountId, InternalCallContext context)
void	createInvoice(InvoiceModelDao invoice, InvoiceDispatcher.FutureAccountNotifications callbackDateTimePerSubscriptions, InternalCallContext context)
java.util.List<InvoiceItemModelDao>	createInvoices(java.util.List<InvoiceModelDao> invoices, InternalCallContext context)
void	createParentChildInvoiceRelation(InvoiceParentChildModelDao invoiceRelation, InternalCallContext context) Save parent/child invoice relationship
InvoicePaymentModelDao	createRefund(java.util.UUID paymentId, java.math.BigDecimal requestedRefundAmount, boolean isInvoiceAdjusted, java.util.Map<java.util.UUID,java.math.BigDecimal> invoiceItemIdsWithNullAmounts, java.lang.String transactionExternalKey, InternalCallContext context) Create a refund.
void	deleteCBA(java.util.UUID accountId, java.util.UUID invoiceId, java.util.UUID invoiceItemId, InternalCallContext context) Delete a CBA item.
InvoiceItemModelDao	doCBAComplexity(InvoiceModelDao invoice, InternalCallContext context)
protected InvoiceApiException	generateAlreadyExistsException(InvoiceModelDao entity, InternalCallContext context)
java.math.BigDecimal	getAccountBalance(java.util.UUID accountId, InternalTenantContext context)
java.math.BigDecimal	getAccountCBA(java.util.UUID accountId, InternalTenantContext context)
java.util.UUID	getAccountIdFromInvoicePaymentId(java.util.UUID invoicePaymentId, InternalTenantContext context)
java.util.List<InvoiceModelDao>	getAllInvoicesByAccount(java.lang.Boolean includeVoidedInvoices, InternalTenantContext context)
InvoiceModelDao	getById(java.util.UUID invoiceId, InternalTenantContext context)
InvoiceModelDao	getByInvoiceItem(java.util.UUID invoiceItemId, InternalTenantContext context)
InvoiceModelDao	getByNumber(java.lang.Integer number, InternalTenantContext context)
InvoicePaymentModelDao	getChargebackById(java.util.UUID chargebackId, InternalTenantContext context)
java.util.List<InvoicePaymentModelDao>	getChargebacksByAccountId(java.util.UUID accountId, InternalTenantContext context)
java.util.List<InvoicePaymentModelDao>	getChargebacksByPaymentId(java.util.UUID paymentId, InternalTenantContext context)
java.util.List<InvoiceParentChildModelDao>	getChildInvoicesByParentInvoiceId(java.util.UUID parentInvoiceId, InternalCallContext context) Get parent/child invoice relationship by parent invoice id
InvoiceItemModelDao	getCreditById(java.util.UUID creditId, InternalTenantContext context) Retrieve a credit by id.
InvoiceItemModelDao	getExternalChargeById(java.util.UUID externalChargeId, InternalTenantContext context) Retrieve am external charge by id.
java.util.UUID	getInvoiceIdByPaymentId(java.util.UUID paymentId, InternalTenantContext context)
java.util.List<InvoiceItemModelDao>	getInvoiceItemsByParentInvoice(java.util.UUID parentInvoiceId, InternalTenantContext context) Retrieve invoice items details associated to Parent SUMMARY invoice item
InvoicePaymentModelDao	getInvoicePaymentByCookieId(java.lang.String cookieId, InternalTenantContext context)
java.util.List<InvoicePaymentModelDao>	getInvoicePaymentsByAccount(InternalTenantContext context)
java.util.List<InvoicePaymentModelDao>	getInvoicePaymentsByInvoice(java.util.UUID invoiceId, InternalTenantContext context)
java.util.List<InvoicePaymentModelDao>	getInvoicePaymentsByPaymentId(java.util.UUID paymentId, InternalTenantContext context)
java.util.List<InvoiceModelDao>	getInvoicesByAccount(java.lang.Boolean includeVoidedInvoices, InternalTenantContext context)
java.util.List<InvoiceModelDao>	getInvoicesByAccount(java.lang.Boolean includeVoidedInvoices, org.joda.time.LocalDate fromDate, InternalTenantContext context)
java.util.List<InvoiceModelDao>	getInvoicesBySubscription(java.util.UUID subscriptionId, InternalTenantContext context)
InvoiceModelDao	getParentDraftInvoice(java.util.UUID parentAccountId, InternalCallContext context) Retrieve parent invoice by the parent account id
java.math.BigDecimal	getRemainingAmountPaid(java.util.UUID invoicePaymentId, InternalTenantContext context)
java.util.List<InvoiceModelDao>	getUnpaidInvoicesByAccountId(java.util.UUID accountId, org.joda.time.LocalDate upToDate, InternalTenantContext context)
void	notifyOfPaymentCompletion(InvoicePaymentModelDao invoicePayment, InternalCallContext context)
void	notifyOfPaymentInit(InvoicePaymentModelDao invoicePayment, InternalCallContext context)
InvoicePaymentModelDao	postChargeback(java.util.UUID paymentId, java.lang.String chargebackTransactionExternalKey, java.math.BigDecimal amount, Currency currency, InternalCallContext context)
InvoicePaymentModelDao	postChargebackReversal(java.util.UUID paymentId, java.lang.String chargebackTransactionExternalKey, InternalCallContext context)
Pagination<InvoiceModelDao>	searchInvoices(java.lang.String searchKey, java.lang.Long offset, java.lang.Long limit, InternalTenantContext context)
void	setFutureAccountNotificationsForEmptyInvoice(java.util.UUID accountId, InvoiceDispatcher.FutureAccountNotifications callbackDateTimePerSubscriptions, InternalCallContext context)
void	transferChildCreditToParent(Account childAccount, InternalCallContext childAccountContext) Move a given child credit to the parent level
void	updateInvoiceItemAmount(java.util.UUID invoiceItemId, java.math.BigDecimal amount, InternalCallContext context) Update invoice item amount

Methods inherited from class org.killbill.billing.util.entity.dao.EntityDaoBase

checkEntityAlreadyExists, create, create, createAndRefresh, get, getAll, getByRecordId, getCount, getCreateEntitySqlDaoTransactionWrapper, getCreateEntitySqlDaoTransactionWrapper, getNaturalOrderingColumns, getRecordId, postBusEventFromTransaction, test

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.killbill.billing.util.entity.dao.EntityDao

create, get, getAll, getByRecordId, getCount, getRecordId, test

Constructor Detail

DefaultInvoiceDao

@Inject
public DefaultInvoiceDao(TagInternalApi tagInternalApi,
                                 org.skife.jdbi.v2.IDBI dbi,
                                 @Named(value="main-ro")
                                 org.skife.jdbi.v2.IDBI roDbi,
                                 NextBillingDatePoster nextBillingDatePoster,
                                 org.killbill.bus.api.PersistentBus eventBus,
                                 org.killbill.clock.Clock clock,
                                 CacheControllerDispatcher cacheControllerDispatcher,
                                 NonEntityDao nonEntityDao,
                                 InvoiceConfig invoiceConfig,
                                 InvoiceDaoHelper invoiceDaoHelper,
                                 CBADao cbaDao,
                                 ParentInvoiceCommitmentPoster parentInvoiceCommitmentPoster,
                                 InternalCallContextFactory internalCallContextFactory)

Method Detail

generateAlreadyExistsException

protected InvoiceApiException generateAlreadyExistsException(InvoiceModelDao entity,
                                                             InternalCallContext context)

Specified by:

generateAlreadyExistsException in class EntityDaoBase<InvoiceModelDao,Invoice,InvoiceApiException>

getInvoicesByAccount

public java.util.List<InvoiceModelDao> getInvoicesByAccount(java.lang.Boolean includeVoidedInvoices,
                                                            InternalTenantContext context)

Specified by:

getInvoicesByAccount in interface InvoiceDao

getAllInvoicesByAccount

public java.util.List<InvoiceModelDao> getAllInvoicesByAccount(java.lang.Boolean includeVoidedInvoices,
                                                               InternalTenantContext context)

Specified by:

getAllInvoicesByAccount in interface InvoiceDao

getInvoicesByAccount

public java.util.List<InvoiceModelDao> getInvoicesByAccount(java.lang.Boolean includeVoidedInvoices,
                                                            org.joda.time.LocalDate fromDate,
                                                            InternalTenantContext context)

Specified by:

getInvoicesByAccount in interface InvoiceDao

getById

public InvoiceModelDao getById(java.util.UUID invoiceId,
                               InternalTenantContext context)
                        throws InvoiceApiException

Specified by:

getById in interface EntityDao<InvoiceModelDao,Invoice,InvoiceApiException>

Overrides:

getById in class EntityDaoBase<InvoiceModelDao,Invoice,InvoiceApiException>

Throws:

InvoiceApiException

getByNumber

public InvoiceModelDao getByNumber(java.lang.Integer number,
                                   InternalTenantContext context)
                            throws InvoiceApiException

Specified by:

getByNumber in interface InvoiceDao

Throws:

InvoiceApiException

getByInvoiceItem

public InvoiceModelDao getByInvoiceItem(java.util.UUID invoiceItemId,
                                        InternalTenantContext context)
                                 throws InvoiceApiException

Specified by:

getByInvoiceItem in interface InvoiceDao

Throws:

InvoiceApiException

setFutureAccountNotificationsForEmptyInvoice

public void setFutureAccountNotificationsForEmptyInvoice(java.util.UUID accountId,
                                                         InvoiceDispatcher.FutureAccountNotifications callbackDateTimePerSubscriptions,
                                                         InternalCallContext context)

Specified by:

setFutureAccountNotificationsForEmptyInvoice in interface InvoiceDao

createInvoice

public void createInvoice(InvoiceModelDao invoice,
                          InvoiceDispatcher.FutureAccountNotifications callbackDateTimePerSubscriptions,
                          InternalCallContext context)

Specified by:

createInvoice in interface InvoiceDao

createInvoices

public java.util.List<InvoiceItemModelDao> createInvoices(java.util.List<InvoiceModelDao> invoices,
                                                          InternalCallContext context)

Specified by:

createInvoices in interface InvoiceDao

getInvoicesBySubscription

public java.util.List<InvoiceModelDao> getInvoicesBySubscription(java.util.UUID subscriptionId,
                                                                 InternalTenantContext context)

Specified by:

getInvoicesBySubscription in interface InvoiceDao

searchInvoices

public Pagination<InvoiceModelDao> searchInvoices(java.lang.String searchKey,
                                                  java.lang.Long offset,
                                                  java.lang.Long limit,
                                                  InternalTenantContext context)

Specified by:

searchInvoices in interface InvoiceDao

getAccountBalance

public java.math.BigDecimal getAccountBalance(java.util.UUID accountId,
                                              InternalTenantContext context)

Specified by:

getAccountBalance in interface InvoiceDao

getAccountCBA

public java.math.BigDecimal getAccountCBA(java.util.UUID accountId,
                                          InternalTenantContext context)

Specified by:

getAccountCBA in interface InvoiceDao

getUnpaidInvoicesByAccountId

public java.util.List<InvoiceModelDao> getUnpaidInvoicesByAccountId(java.util.UUID accountId,
                                                                    @Nullable
                                                                    org.joda.time.LocalDate upToDate,
                                                                    InternalTenantContext context)

Specified by:

getUnpaidInvoicesByAccountId in interface InvoiceDao

getInvoiceIdByPaymentId

public java.util.UUID getInvoiceIdByPaymentId(java.util.UUID paymentId,
                                              InternalTenantContext context)

Specified by:

getInvoiceIdByPaymentId in interface InvoiceDao

getInvoicePaymentsByPaymentId

public java.util.List<InvoicePaymentModelDao> getInvoicePaymentsByPaymentId(java.util.UUID paymentId,
                                                                            InternalTenantContext context)

Specified by:

getInvoicePaymentsByPaymentId in interface InvoiceDao

getInvoicePaymentsByAccount

public java.util.List<InvoicePaymentModelDao> getInvoicePaymentsByAccount(InternalTenantContext context)

Specified by:

getInvoicePaymentsByAccount in interface InvoiceDao

getInvoicePaymentsByInvoice

public java.util.List<InvoicePaymentModelDao> getInvoicePaymentsByInvoice(java.util.UUID invoiceId,
                                                                          InternalTenantContext context)

Specified by:

getInvoicePaymentsByInvoice in interface InvoiceDao

getInvoicePaymentByCookieId

public InvoicePaymentModelDao getInvoicePaymentByCookieId(java.lang.String cookieId,
                                                          InternalTenantContext context)

Specified by:

getInvoicePaymentByCookieId in interface InvoiceDao

createRefund

public InvoicePaymentModelDao createRefund(java.util.UUID paymentId,
                                           java.math.BigDecimal requestedRefundAmount,
                                           boolean isInvoiceAdjusted,
                                           java.util.Map<java.util.UUID,java.math.BigDecimal> invoiceItemIdsWithNullAmounts,
                                           java.lang.String transactionExternalKey,
                                           InternalCallContext context)
                                    throws InvoiceApiException

Description copied from interface: InvoiceDao

Create a refund.

Specified by:

createRefund in interface InvoiceDao

Parameters:

paymentId - payment associated with that refund

requestedRefundAmount - amount to refund

isInvoiceAdjusted - whether the refund should trigger an invoice or invoice item adjustment

invoiceItemIdsWithNullAmounts - invoice item ids and associated amounts to adjust

transactionExternalKey - transaction refund externalKey

context - the call callcontext

Returns:

the created invoice payment object associated with this refund

Throws:

InvoiceApiException

postChargeback

public InvoicePaymentModelDao postChargeback(java.util.UUID paymentId,
                                             java.lang.String chargebackTransactionExternalKey,
                                             java.math.BigDecimal amount,
                                             Currency currency,
                                             InternalCallContext context)
                                      throws InvoiceApiException

Specified by:

postChargeback in interface InvoiceDao

Throws:

InvoiceApiException

postChargebackReversal

public InvoicePaymentModelDao postChargebackReversal(java.util.UUID paymentId,
                                                     java.lang.String chargebackTransactionExternalKey,
                                                     InternalCallContext context)
                                              throws InvoiceApiException

Specified by:

postChargebackReversal in interface InvoiceDao

Throws:

InvoiceApiException

doCBAComplexity

public InvoiceItemModelDao doCBAComplexity(InvoiceModelDao invoice,
                                           InternalCallContext context)
                                    throws InvoiceApiException

Specified by:

doCBAComplexity in interface InvoiceDao

Throws:

InvoiceApiException

computeItemAdjustments

public java.util.Map<java.util.UUID,java.math.BigDecimal> computeItemAdjustments(java.lang.String invoiceId,
                                                                                 java.util.Map<java.util.UUID,java.math.BigDecimal> invoiceItemIdsWithNullAmounts,
                                                                                 InternalTenantContext context)
                                                                          throws InvoiceApiException

Specified by:

computeItemAdjustments in interface InvoiceDao

Throws:

InvoiceApiException

getRemainingAmountPaid

public java.math.BigDecimal getRemainingAmountPaid(java.util.UUID invoicePaymentId,
                                                   InternalTenantContext context)

Specified by:

getRemainingAmountPaid in interface InvoiceDao

getAccountIdFromInvoicePaymentId

public java.util.UUID getAccountIdFromInvoicePaymentId(java.util.UUID invoicePaymentId,
                                                       InternalTenantContext context)
                                                throws InvoiceApiException

Specified by:

getAccountIdFromInvoicePaymentId in interface InvoiceDao

Throws:

InvoiceApiException

getChargebacksByAccountId

public java.util.List<InvoicePaymentModelDao> getChargebacksByAccountId(java.util.UUID accountId,
                                                                        InternalTenantContext context)

Specified by:

getChargebacksByAccountId in interface InvoiceDao

getChargebacksByPaymentId

public java.util.List<InvoicePaymentModelDao> getChargebacksByPaymentId(java.util.UUID paymentId,
                                                                        InternalTenantContext context)

Specified by:

getChargebacksByPaymentId in interface InvoiceDao

getChargebackById

public InvoicePaymentModelDao getChargebackById(java.util.UUID chargebackId,
                                                InternalTenantContext context)
                                         throws InvoiceApiException

Specified by:

getChargebackById in interface InvoiceDao

Throws:

InvoiceApiException

getExternalChargeById

public InvoiceItemModelDao getExternalChargeById(java.util.UUID externalChargeId,
                                                 InternalTenantContext context)
                                          throws InvoiceApiException

Description copied from interface: InvoiceDao

Retrieve am external charge by id.

Specified by:

getExternalChargeById in interface InvoiceDao

Parameters:

externalChargeId - the external charge id

Returns:

the external charge invoice item

Throws:

InvoiceApiException

notifyOfPaymentInit

public void notifyOfPaymentInit(InvoicePaymentModelDao invoicePayment,
                                InternalCallContext context)

Specified by:

notifyOfPaymentInit in interface InvoiceDao

notifyOfPaymentCompletion

public void notifyOfPaymentCompletion(InvoicePaymentModelDao invoicePayment,
                                      InternalCallContext context)

Specified by:

notifyOfPaymentCompletion in interface InvoiceDao

getCreditById

public InvoiceItemModelDao getCreditById(java.util.UUID creditId,
                                         InternalTenantContext context)
                                  throws InvoiceApiException

Description copied from interface: InvoiceDao

Retrieve a credit by id.

Specified by:

getCreditById in interface InvoiceDao

Parameters:

creditId - the credit id

Returns:

the credit invoice item

Throws:

InvoiceApiException

deleteCBA

public void deleteCBA(java.util.UUID accountId,
                      java.util.UUID invoiceId,
                      java.util.UUID invoiceItemId,
                      InternalCallContext context)
               throws InvoiceApiException

Description copied from interface: InvoiceDao

Delete a CBA item.

Specified by:

deleteCBA in interface InvoiceDao

Parameters:

accountId - the account id

invoiceId - the invoice id

invoiceItemId - the invoice item id of the cba item to delete

Throws:

InvoiceApiException

consumeExstingCBAOnAccountWithUnpaidInvoices

public void consumeExstingCBAOnAccountWithUnpaidInvoices(java.util.UUID accountId,
                                                         InternalCallContext context)

Specified by:

consumeExstingCBAOnAccountWithUnpaidInvoices in interface InvoiceDao

Parameters:

accountId - the account for which we need to rebalance the CBA

context - the callcontext

changeInvoiceStatus

public void changeInvoiceStatus(java.util.UUID invoiceId,
                                InvoiceStatus newStatus,
                                InternalCallContext context)
                         throws InvoiceApiException

Description copied from interface: InvoiceDao

Update invoice status

Specified by:

changeInvoiceStatus in interface InvoiceDao

Parameters:

invoiceId - the invoice id

newStatus - the new invoice state

context - the tenant context

Throws:

InvoiceApiException - if any unexpected error occurs

createParentChildInvoiceRelation

public void createParentChildInvoiceRelation(InvoiceParentChildModelDao invoiceRelation,
                                             InternalCallContext context)
                                      throws InvoiceApiException

Description copied from interface: InvoiceDao

Save parent/child invoice relationship

Specified by:

createParentChildInvoiceRelation in interface InvoiceDao

Parameters:

invoiceRelation - the invoice relation object

context - the tenant context

Throws:

InvoiceApiException - if any unexpected error occurs

getChildInvoicesByParentInvoiceId

public java.util.List<InvoiceParentChildModelDao> getChildInvoicesByParentInvoiceId(java.util.UUID parentInvoiceId,
                                                                                    InternalCallContext context)
                                                                             throws InvoiceApiException

Description copied from interface: InvoiceDao

Get parent/child invoice relationship by parent invoice id

Specified by:

getChildInvoicesByParentInvoiceId in interface InvoiceDao

Parameters:

parentInvoiceId - the parent invoice id

context - the tenant context

Returns:

a list of parent-children relation

Throws:

InvoiceApiException - if any unexpected error occurs

getParentDraftInvoice

public InvoiceModelDao getParentDraftInvoice(java.util.UUID parentAccountId,
                                             InternalCallContext context)
                                      throws InvoiceApiException

Description copied from interface: InvoiceDao

Retrieve parent invoice by the parent account id

Specified by:

getParentDraftInvoice in interface InvoiceDao

Parameters:

parentAccountId - the parent account id

context - the tenant context

Returns:

a parent invoice in DRAFT status

Throws:

InvoiceApiException - if any unexpected error occurs

updateInvoiceItemAmount

public void updateInvoiceItemAmount(java.util.UUID invoiceItemId,
                                    java.math.BigDecimal amount,
                                    InternalCallContext context)
                             throws InvoiceApiException

Description copied from interface: InvoiceDao

Update invoice item amount

Specified by:

updateInvoiceItemAmount in interface InvoiceDao

Parameters:

invoiceItemId - the invoice item id

amount - the new amount value

context - the tenant context

Throws:

InvoiceApiException - if any unexpected error occurs

transferChildCreditToParent

public void transferChildCreditToParent(Account childAccount,
                                        InternalCallContext childAccountContext)
                                 throws InvoiceApiException

Description copied from interface: InvoiceDao

Move a given child credit to the parent level

Specified by:

transferChildCreditToParent in interface InvoiceDao

Parameters:

childAccount - the child account

childAccountContext - the tenant context for the child account id

Throws:

InvoiceApiException - if any unexpected error occurs

getInvoiceItemsByParentInvoice

public java.util.List<InvoiceItemModelDao> getInvoiceItemsByParentInvoice(java.util.UUID parentInvoiceId,
                                                                          InternalTenantContext context)
                                                                   throws InvoiceApiException

Description copied from interface: InvoiceDao

Retrieve invoice items details associated to Parent SUMMARY invoice item

Specified by:

getInvoiceItemsByParentInvoice in interface InvoiceDao

Parameters:

parentInvoiceId - the parent invoice id

context - the tenant context

Returns:

a list of invoice items associated with a parent invoice

Throws:

InvoiceApiException - if any unexpected error occurs