org.kuali.kfs.module.ar.service.impl

Class AccountsReceivableModuleBillingServiceImpl

java.lang.Object

org.kuali.kfs.module.ar.service.impl.AccountsReceivableModuleBillingServiceImpl

All Implemented Interfaces:

AccountsReceivableModuleBillingService

public class AccountsReceivableModuleBillingServiceImpl
extends Object
implements AccountsReceivableModuleBillingService

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kuali.rice.krad.service.BusinessObjectService	businessObjectService
protected org.kuali.rice.core.api.config.property.ConfigurationService	configurationService
protected ContractsGrantsInvoiceDocumentService	contractsGrantsInvoiceDocumentService
protected org.kuali.rice.krad.service.KualiModuleService	kualiModuleService
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	parameterService

Constructor Summary

Constructors

Constructor and Description
AccountsReceivableModuleBillingServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
org.kuali.rice.core.api.util.type.KualiDecimal	calculateTotalPaymentsToDateByAward(Long proposalNumber) This method calculates total payments to date by Award using ContractsGrantsInvoiceDocumentService
List<String>	checkAwardContractControlAccounts(ContractsAndGrantsBillingAward award) This method checks the Contract Control account set for Award Account based on award's invoicing option.
org.kuali.rice.core.api.util.type.KualiDecimal	getAwardBilledToDateAmount(ContractsAndGrantsBillingAward award) If milestone or pre-determined billing billing frequency on the award, adds up the milestones or the bills which have been billed; otherwise looks at the amount billed so far against the award based on the AwardAccountObjectCodeTotalBilled table
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
org.kuali.rice.core.api.config.property.ConfigurationService	getConfigurationService()
ContractsGrantsInvoiceDocumentService	getContractsGrantsInvoiceDocumentService()
String	getContractsGrantsInvoiceDocumentType() Gets the Contracts & Grants Invoice Document Type
String	getDefaultBillingFrequency() Gets the Default Billing Frequency code
String	getDefaultDunningCampaignCode() Gets the Default Dunning Campaign code
String	getDefaultInvoicingOption() Gets the Default Invoicing Option code
org.kuali.rice.krad.service.KualiModuleService	getKualiModuleService()
Date	getLastBilledDate(ContractsAndGrantsBillingAward award) Calculate the lastBilledDate for the Award based on it's AwardAccounts
AccountsReceivableMilestoneSchedule	getMilestoneSchedule() This method returns a new instance of the MilestoneSchedule class.
org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
AccountsReceivablePredeterminedBillingSchedule	getPredeterminedBillingSchedule() This method returns a new instance of the PredeterminedBillingSchedule class.
boolean	hasActiveBills(Long proposalNumber) Checks to see if the award corresponding to the passed in proposalNumber has active Bills associated with it.
boolean	hasActiveMilestones(Long proposalNumber) Checks to see if the award corresponding to the passed in proposalNumber has active Milestones associated with it.
boolean	hasMilestoneSchedule(Long proposalNumber) Checks to see if the award corresponding to the passed in proposalNumber has a MilestoneSchedule associated with it.
boolean	hasPredeterminedBillingSchedule(Long proposalNumber) Checks to see if the award corresponding to the passed in proposalNumber has a PredeterminedBillingSchedule associated with it.
boolean	isContractsGrantsBillingEnhancementActive() Determines whether the CG and Billing Enhancements are on from the system parameters
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setConfigurationService(org.kuali.rice.core.api.config.property.ConfigurationService configurationService)
void	setContractsGrantsInvoiceDocumentService(ContractsGrantsInvoiceDocumentService contractsGrantsInvoiceDocumentService)
void	setKualiModuleService(org.kuali.rice.krad.service.KualiModuleService kualiModuleService)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

Methods inherited from class java.lang.Object

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

Field Detail

businessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService businessObjectService

contractsGrantsInvoiceDocumentService

protected ContractsGrantsInvoiceDocumentService contractsGrantsInvoiceDocumentService

kualiModuleService

protected org.kuali.rice.krad.service.KualiModuleService kualiModuleService

configurationService

protected org.kuali.rice.core.api.config.property.ConfigurationService configurationService

parameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService

Constructor Detail

AccountsReceivableModuleBillingServiceImpl

public AccountsReceivableModuleBillingServiceImpl()

Method Detail

getAwardBilledToDateAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getAwardBilledToDateAmount(ContractsAndGrantsBillingAward award)

If milestone or pre-determined billing billing frequency on the award, adds up the milestones or the bills which have been billed; otherwise looks at the amount billed so far against the award based on the AwardAccountObjectCodeTotalBilled table

Specified by:

getAwardBilledToDateAmount in interface AccountsReceivableModuleBillingService

Parameters:

award - the award to find the total billed to date for

Returns:

the total amount billed to date on the award

See Also:

org.kuali.kfs.integration.ar.AccountsReceivableModuleBillingService#getAwardBilledToDateAmountForAward(org.kuali.kfs.integration.cg.ContractsAndGrantsBillingAward)

calculateTotalPaymentsToDateByAward

public org.kuali.rice.core.api.util.type.KualiDecimal calculateTotalPaymentsToDateByAward(Long proposalNumber)

Description copied from interface: AccountsReceivableModuleBillingService

This method calculates total payments to date by Award using ContractsGrantsInvoiceDocumentService

Specified by:

calculateTotalPaymentsToDateByAward in interface AccountsReceivableModuleBillingService

Parameters:

proposalNumber -

Returns:

See Also:

This method calculates total payments to date by Award using ContractsGrantsInvoiceDocumentService

getMilestoneSchedule

public AccountsReceivableMilestoneSchedule getMilestoneSchedule()

Description copied from interface: AccountsReceivableModuleBillingService

This method returns a new instance of the MilestoneSchedule class.

Specified by:

getMilestoneSchedule in interface AccountsReceivableModuleBillingService

Returns:

new MilestoneSchedule instance

getPredeterminedBillingSchedule

public AccountsReceivablePredeterminedBillingSchedule getPredeterminedBillingSchedule()

Description copied from interface: AccountsReceivableModuleBillingService

This method returns a new instance of the PredeterminedBillingSchedule class.

Specified by:

getPredeterminedBillingSchedule in interface AccountsReceivableModuleBillingService

Returns:

new PredeterminedBillingSchedule instance

getLastBilledDate

public Date getLastBilledDate(ContractsAndGrantsBillingAward award)

Description copied from interface: AccountsReceivableModuleBillingService

Calculate the lastBilledDate for the Award based on it's AwardAccounts

Specified by:

getLastBilledDate in interface AccountsReceivableModuleBillingService

Parameters:

award - the Award used to calculate lastBilledDate

Returns:

the lastBilledDate

See Also:

org.kuali.kfs.integration.ar.AccountsReceivableModuleService#getLastBilledDate(java.lang.Long)

checkAwardContractControlAccounts

public List<String> checkAwardContractControlAccounts(ContractsAndGrantsBillingAward award)

Description copied from interface: AccountsReceivableModuleBillingService

This method checks the Contract Control account set for Award Account based on award's invoicing option.

Specified by:

checkAwardContractControlAccounts in interface AccountsReceivableModuleBillingService

Returns:

errorString

hasPredeterminedBillingSchedule

public boolean hasPredeterminedBillingSchedule(Long proposalNumber)

Description copied from interface: AccountsReceivableModuleBillingService

Checks to see if the award corresponding to the passed in proposalNumber has a PredeterminedBillingSchedule associated with it.

Specified by:

hasPredeterminedBillingSchedule in interface AccountsReceivableModuleBillingService

Parameters:

proposalNumber - proposalNumber for the Award use as key to look for PredeterminedBillingSchedule

Returns:

true if there is an active PredeterminedBillingSchedule for this proposalNumber, false otherwise

hasMilestoneSchedule

public boolean hasMilestoneSchedule(Long proposalNumber)

Description copied from interface: AccountsReceivableModuleBillingService

Checks to see if the award corresponding to the passed in proposalNumber has a MilestoneSchedule associated with it.

Specified by:

hasMilestoneSchedule in interface AccountsReceivableModuleBillingService

Parameters:

proposalNumber - proposalNumber for the Award use as key to look for MilestoneSchedule

Returns:

true if there is an active MilestoneSchedule for this proposalNumber, false otherwise

hasActiveBills

public boolean hasActiveBills(Long proposalNumber)

Description copied from interface: AccountsReceivableModuleBillingService

Checks to see if the award corresponding to the passed in proposalNumber has active Bills associated with it.

Specified by:

hasActiveBills in interface AccountsReceivableModuleBillingService

Parameters:

proposalNumber - proposalNumber for the Award use as key to look for PredeterminedBillingSchedule

Returns:

true if there is at least one active Bill for this proposalNumber, false otherwise

hasActiveMilestones

public boolean hasActiveMilestones(Long proposalNumber)

Description copied from interface: AccountsReceivableModuleBillingService

Checks to see if the award corresponding to the passed in proposalNumber has active Milestones associated with it.

Specified by:

hasActiveMilestones in interface AccountsReceivableModuleBillingService

Parameters:

proposalNumber - proposalNumber for the Award use as key to look for MilestoneSchedule

Returns:

true if there is at least one active Milestone for this proposalNumber, false otherwise

getContractsGrantsInvoiceDocumentType

public String getContractsGrantsInvoiceDocumentType()

Description copied from interface: AccountsReceivableModuleBillingService

Gets the Contracts & Grants Invoice Document Type

Specified by:

getContractsGrantsInvoiceDocumentType in interface AccountsReceivableModuleBillingService

Returns:

Contracts & Grants Invoice Document Type

isContractsGrantsBillingEnhancementActive

public boolean isContractsGrantsBillingEnhancementActive()

Description copied from interface: AccountsReceivableModuleBillingService

Determines whether the CG and Billing Enhancements are on from the system parameters

Specified by:

isContractsGrantsBillingEnhancementActive in interface AccountsReceivableModuleBillingService

Returns:

true if Contracts & Grants Billing enhancement is enabled

getDefaultDunningCampaignCode

public String getDefaultDunningCampaignCode()

Description copied from interface: AccountsReceivableModuleBillingService

Gets the Default Dunning Campaign code

Specified by:

getDefaultDunningCampaignCode in interface AccountsReceivableModuleBillingService

Returns:

Default Dunning Campaign code

getDefaultBillingFrequency

public String getDefaultBillingFrequency()

Description copied from interface: AccountsReceivableModuleBillingService

Gets the Default Billing Frequency code

Specified by:

getDefaultBillingFrequency in interface AccountsReceivableModuleBillingService

Returns:

Default Billing Frequency code

getDefaultInvoicingOption

public String getDefaultInvoicingOption()

Description copied from interface: AccountsReceivableModuleBillingService

Gets the Default Invoicing Option code

Specified by:

getDefaultInvoicingOption in interface AccountsReceivableModuleBillingService

Returns:

Default Invoicing Option code

getBusinessObjectService

public org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

getContractsGrantsInvoiceDocumentService

public ContractsGrantsInvoiceDocumentService getContractsGrantsInvoiceDocumentService()

setContractsGrantsInvoiceDocumentService

public void setContractsGrantsInvoiceDocumentService(ContractsGrantsInvoiceDocumentService contractsGrantsInvoiceDocumentService)

getKualiModuleService

public org.kuali.rice.krad.service.KualiModuleService getKualiModuleService()

setKualiModuleService

public void setKualiModuleService(org.kuali.rice.krad.service.KualiModuleService kualiModuleService)

getConfigurationService

public org.kuali.rice.core.api.config.property.ConfigurationService getConfigurationService()

setConfigurationService

public void setConfigurationService(org.kuali.rice.core.api.config.property.ConfigurationService configurationService)

getParameterService

public org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)