com.broadleafcommerce.accountcredit.profile.core.service

Interface CreditAccountService

All Known Implementing Classes:

CreditAccountServiceImpl

public interface CreditAccountService

Author:

Jerry Ocanas (jocanas)

Method Summary

Modifier and Type	Method and Description
CreditAccountEvent	clearAccountBalance(CreditAccount creditAccount) Zeros out a CreditAccount.
CreditAccountEvent	createCreditAccountEvent(CreditAccount creditAccount, CreditAccountEventEnum type, org.broadleafcommerce.common.money.Money amount) Returns a new CreditAccountEvent of the type passed in.
CreditAccountEvent	createCreditAccountEvent(CreditAccount creditAccount, CreditAccountEventEnum type, org.broadleafcommerce.common.money.Money amount, CreditAccountEventRequestDTO requestDTO) Returns a new CreditAccountEvent of the type passed in.
CreditAccountEvent	creditAccount(CreditAccount creditAccount, org.broadleafcommerce.common.money.Money amount, Date expirationDate) Credits the CreditAccount for the given amount.
CreditAccountEvent	debitAccount(CreditAccount creditAccount, org.broadleafcommerce.common.money.Money amount) Debits the CreditAccount for the given amount.
CreditAccountEvent	debitAccount(CreditAccount creditAccount, org.broadleafcommerce.common.money.Money amount, org.broadleafcommerce.core.order.domain.Order order) Debits the CreditAccount for the given amount.
CreditAccountEvent	getLastActivity(CreditAccount creditAccount) Gets the last activity registered on the CreditAccount.
CreditAccountEvent	getLastDebitEvent(CreditAccount creditAccount) Gets the last debit event registered on the CreditAccount.
boolean	isExpired(CreditAccount creditAccount) Returns true if there is an expiration date on the creditAccount.
CreditAccount	readAccountByAccountNumber(String accountNumber) Returns a Credit Account that matches the account number.
CreditAccount	readById(Long creditAccountID) Gets a CreditAccount by id
CreditAccountEvent	refundAccount(CreditAccount creditAccount, org.broadleafcommerce.common.money.Money amount) Refunds a CreditAccount for the given amount.
CreditAccount	registerAccountCreation(CreditAccount creditAccount, org.broadleafcommerce.common.money.Money amount, CreditAccountEventRequestDTO requestDTO) Registers the creation of a new CreditAccount by creating a CreditAccountEvent and CreditAccountEventDetail.
CreditAccountEvent	rollbackCredit(CreditAccount creditAccount, org.broadleafcommerce.common.money.Money amount) Used by a RollbackHandler to debit back an amount that had been refunded on a credit.
CreditAccountEvent	rollbackDebit(CreditAccount creditAccount, org.broadleafcommerce.common.money.Money amount) Used by a RollbackHandler to credit back an amount that had been deducted on a debit.
CreditAccountEvent	transferAccountBalance(CreditAccount sender, CreditAccount receiver, org.broadleafcommerce.common.money.Money amount) Transfers an amount from the Sender CreditAccount to the Receiver CreditAccount.
CreditAccountEvent	voidAccount(CreditAccount creditAccount, Date expirationDate) Voids a CreditAccount by setting an expiration date.

Method Detail

createCreditAccountEvent

CreditAccountEvent createCreditAccountEvent(CreditAccount creditAccount,
                                            CreditAccountEventEnum type,
                                            org.broadleafcommerce.common.money.Money amount)

Returns a new CreditAccountEvent of the type passed in.

Parameters:

type -

createCreditAccountEvent

CreditAccountEvent createCreditAccountEvent(CreditAccount creditAccount,
                                            CreditAccountEventEnum type,
                                            org.broadleafcommerce.common.money.Money amount,
                                            CreditAccountEventRequestDTO requestDTO)

Returns a new CreditAccountEvent of the type passed in.

Parameters:

type -

registerAccountCreation

CreditAccount registerAccountCreation(CreditAccount creditAccount,
                                      org.broadleafcommerce.common.money.Money amount,
                                      CreditAccountEventRequestDTO requestDTO)

Registers the creation of a new CreditAccount by creating a CreditAccountEvent and CreditAccountEventDetail.

Parameters:

creditAccount -

amount -

Returns:

creditAccount

CreditAccountEvent creditAccount(CreditAccount creditAccount,
                                 org.broadleafcommerce.common.money.Money amount,
                                 Date expirationDate)

Credits the CreditAccount for the given amount.

Parameters:

creditAccount -

amount -

expirationDate -

Returns:

debitAccount

CreditAccountEvent debitAccount(CreditAccount creditAccount,
                                org.broadleafcommerce.common.money.Money amount)

Debits the CreditAccount for the given amount.

Parameters:

creditAccount -

amount -

Returns:

debitAccount

CreditAccountEvent debitAccount(CreditAccount creditAccount,
                                org.broadleafcommerce.common.money.Money amount,
                                org.broadleafcommerce.core.order.domain.Order order)

Debits the CreditAccount for the given amount. It will link to a passed in order in the CreditAccountEvent.

Parameters:

creditAccount -

amount -

order -

Returns:

rollbackDebit

CreditAccountEvent rollbackDebit(CreditAccount creditAccount,
                                 org.broadleafcommerce.common.money.Money amount)

Used by a RollbackHandler to credit back an amount that had been deducted on a debit.

Parameters:

creditAccount -

amount -

Returns:

rollbackCredit

CreditAccountEvent rollbackCredit(CreditAccount creditAccount,
                                  org.broadleafcommerce.common.money.Money amount)

Used by a RollbackHandler to debit back an amount that had been refunded on a credit.

Parameters:

creditAccount -

amount -

Returns:

refundAccount

CreditAccountEvent refundAccount(CreditAccount creditAccount,
                                 org.broadleafcommerce.common.money.Money amount)

Refunds a CreditAccount for the given amount.

Parameters:

creditAccount -

amount -

Returns:

voidAccount

CreditAccountEvent voidAccount(CreditAccount creditAccount,
                               Date expirationDate)

Voids a CreditAccount by setting an expiration date.

Parameters:

creditAccount -

expirationDate -

Returns:

clearAccountBalance

CreditAccountEvent clearAccountBalance(CreditAccount creditAccount)

Zeros out a CreditAccount.

Parameters:

creditAccount -

Returns:

getLastActivity

CreditAccountEvent getLastActivity(CreditAccount creditAccount)

Gets the last activity registered on the CreditAccount.

Parameters:

creditAccount -

Returns:

getLastDebitEvent

CreditAccountEvent getLastDebitEvent(CreditAccount creditAccount)

Gets the last debit event registered on the CreditAccount.

Parameters:

creditAccount -

Returns:

transferAccountBalance

CreditAccountEvent transferAccountBalance(CreditAccount sender,
                                          CreditAccount receiver,
                                          org.broadleafcommerce.common.money.Money amount)

Transfers an amount from the Sender CreditAccount to the Receiver CreditAccount.

Parameters:

sender -

receiver -

amount -

Returns:

isExpired

boolean isExpired(CreditAccount creditAccount)

Returns true if there is an expiration date on the creditAccount.

Parameters:

creditAccount -

Returns:

readAccountByAccountNumber

CreditAccount readAccountByAccountNumber(String accountNumber)

Returns a Credit Account that matches the account number.

Parameters:

accountNumber -

Returns:

readById

CreditAccount readById(Long creditAccountID)

Gets a CreditAccount by id

Parameters:

creditAccountID -

Returns: