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

Class ContractsGrantsInvoiceCreateDocumentServiceImpl

java.lang.Object

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

All Implemented Interfaces:

ContractsGrantsInvoiceCreateDocumentService

@Transactional
public class ContractsGrantsInvoiceCreateDocumentServiceImpl
extends Object
implements ContractsGrantsInvoiceCreateDocumentService

This is the default implementation of the ContractsGrantsInvoiceDocumentCreateService interface.

See Also:

org.kuali.kfs.module.ar.batch.service.ContractsGrantsInvoiceDocumentCreateService

Field Summary

Fields

Modifier and Type	Field and Description
protected AccountingPeriodService	accountingPeriodService
protected AccountService	accountService
protected AccountsReceivableDocumentHeaderService	accountsReceivableDocumentHeaderService
protected AwardAccountObjectCodeTotalBilledDao	awardAccountObjectCodeTotalBilledDao
protected org.kuali.rice.krad.service.BusinessObjectService	businessObjectService
protected org.kuali.rice.core.api.config.property.ConfigurationService	configurationService
protected ContractsAndGrantsModuleBillingService	contractsAndGrantsModuleBillingService
protected ContractsGrantsBillingAwardVerificationService	contractsGrantsBillingAwardVerificationService
protected ContractsGrantsBillingUtilityService	contractsGrantsBillingUtilityService
protected ContractsGrantsInvoiceDocumentService	contractsGrantsInvoiceDocumentService
protected CostCategoryService	costCategoryService
protected CustomerService	customerService
protected org.kuali.rice.core.api.datetime.DateTimeService	dateTimeService
protected org.kuali.rice.krad.service.DocumentService	documentService
protected FinancialSystemDocumentService	financialSystemDocumentService
protected org.kuali.rice.krad.service.KualiModuleService	kualiModuleService
protected OptionsService	optionsService
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	parameterService
static String	REPORT_LINE_DIVIDER
protected UniversityDateService	universityDateService
protected VerifyBillingFrequencyService	verifyBillingFrequencyService
protected org.kuali.rice.krad.workflow.service.WorkflowDocumentService	workflowDocumentService

Constructor Summary

Constructors

Constructor and Description
ContractsGrantsInvoiceCreateDocumentServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.kuali.rice.core.api.util.type.KualiDecimal	addBalanceToAwardAccountBudgetAmount(Balance balance, org.kuali.rice.core.api.util.type.KualiDecimal awardAccountBudgetAmount, boolean firstFiscalPeriod) Adds the budget balance to the award account budget amount
protected org.kuali.rice.core.api.util.type.KualiDecimal	addBalanceToAwardAccountCumulativeAmount(ContractsGrantsInvoiceDocument document, Balance balance, ContractsAndGrantsBillingAward award, org.kuali.rice.core.api.util.type.KualiDecimal awardAccountCumulativeAmount, boolean firstFiscalPeriod) Sums the balance to the given awardAccountCumulativeAmount and returns that summed amount
protected InvoiceAccountDetail	buildInvoiceAccountDetailForAwardAccount(ContractsAndGrantsBillingAward award, ContractsAndGrantsBillingAwardAccount awardAccount, String documentNumber, InvoiceGeneralDetail invoiceGeneralDetail) Builds a new invoice account detail for a given award account
protected List<InvoiceAddressDetail>	buildInvoiceAddressDetailsFromAgency(ContractsAndGrantsBillingAgency agency, ContractsGrantsInvoiceDocument document) Builds a list of InvoiceAddressDetails based on the customer associated with an Agency
protected List<InvoiceBill>	buildInvoiceBills(List<Bill> bills, Date invoiceDate) Generates InvoiceBills for each of the given Bills
protected List<InvoiceMilestone>	buildInvoiceMilestones(List<Milestone> milestones, Date invoiceDate) Generates InvoiceMilestones for each of the given milestones
protected Map<String,org.kuali.rice.core.api.util.type.KualiDecimal>	calculateAmountsByCategory(Map<String,BigDecimal> percentagesByCategory, org.kuali.rice.core.api.util.type.KualiDecimal amount) Given a Map of category keys mapping percentage values and an amount, find what amount each percentage would be
protected org.kuali.rice.core.api.util.type.KualiDecimal	calculateBalanceAmountWithoutLastBilledPeriod(Date lastBilledDate, Balance glBalance) This method would make sure the amounts of the current period are not included.
protected org.kuali.rice.core.api.util.type.KualiDecimal	calculateMilestoneAmount(ContractsGrantsInvoiceDocument document)
protected BigDecimal	calculatePercentageByInvoiceDetailAccountObjectCodes(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes, org.kuali.rice.core.api.util.type.KualiDecimal total) Finds the percentage that the given total is of the sum of the current expenditures of the given invoiceDetailAccountObjectCodes
protected Map<String,BigDecimal>	calculatePercentagesByCategory(Map<String,List<InvoiceDetailAccountObjectCode>> invoiceDetailAccountObjectCodesByCategory, org.kuali.rice.core.api.util.type.KualiDecimal total) Calculates the percentage of the given total each list of invoice detail account object codes represents
protected org.kuali.rice.core.api.util.type.KualiDecimal	calculateTotalBillAmount(ContractsGrantsInvoiceDocument document)
protected org.kuali.rice.core.api.util.type.KualiDecimal	calculateTotalExpenditureAmount(ContractsGrantsInvoiceDocument document, List<ContractsGrantsLetterOfCreditReviewDetail> locReviewDetails)
protected org.kuali.rice.core.api.util.type.KualiDecimal	cleanAmount(org.kuali.rice.core.api.util.type.KualiDecimal amount) Null protects the addition in retrieveAccurateBalanceAmount
ContractsGrantsInvoiceDocument	createCGInvoiceDocumentByAwardInfo(ContractsAndGrantsBillingAward awd, List<ContractsAndGrantsBillingAwardAccount> accounts, String chartOfAccountsCode, String organizationCode, List<org.kuali.rice.krad.util.ErrorMessage> errorMessages, List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails, String locCreationType) This method creates a single CG Invoice Document
List<org.kuali.rice.krad.util.ErrorMessage>	createCGInvoiceDocumentsByAwards(Collection<ContractsAndGrantsBillingAward> awards, ArConstants.ContractsAndGrantsInvoiceDocumentCreationProcessType creationProcessTypeCode) This method is called by the manual CINV creation process create Contracts & Grants Invoice Documents by Awards.
List<org.kuali.rice.krad.util.ErrorMessage>	createCGInvoiceDocumentsByAwards(Collection<ContractsAndGrantsBillingAward> awards, List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails, String locCreationType) Looks for Contracts & Grants Invoice Document with a status of Saved, meaning they have been created and saved to "inbox", but This method is called by the C&G LOC Review document to generate contracts grants invoice documents
protected List<org.kuali.rice.krad.util.ErrorMessage>	createInvoices(Collection<ContractsAndGrantsBillingAward> awards, List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails, String locCreationType) This method iterates through awards and create cgInvoice documents
protected void	createInvoicesByAccounts(ContractsAndGrantsBillingAward awd, List<org.kuali.rice.krad.util.ErrorMessage> errorMessages, List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails, String locCreationType) Generates and saves Contracts & Grants Invoice Documents based on the award accounts of the passed in award
protected void	createInvoicesByAward(ContractsAndGrantsBillingAward awd, List<org.kuali.rice.krad.util.ErrorMessage> errorMessages, List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails, String locCreationType) Generates and saves a single Contracts & Grants Invoice Document based on the given award
protected void	createInvoicesByContractControlAccounts(ContractsAndGrantsBillingAward awd, List<org.kuali.rice.krad.util.ErrorMessage> errorMessages, List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails, String locCreationType) Generates and saves Contracts & Grants Invoice Documents based on the given award's contract control accounts
protected void	distributeAmountAmongAllAccountObjectCodes(ContractsGrantsInvoiceDocument document, ContractsAndGrantsBillingAwardAccount awdAcct, List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectsCodes, ContractsGrantsLetterOfCreditReviewDetail locReviewDetail) For letter of credit, this distributes the amount for matching LOC invoice detail account object codes (which is very probably all of invoice detail account object codes in the given list) evenly
protected List<InvoiceDetailAccountObjectCode>	filterInvoiceAccountObjectCodesByDocumentAndAccount(ContractsGrantsInvoiceDocument document, ContractsAndGrantsBillingAwardAccount awdAcct, List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectsCodes) Filters the given list of invoice detail account object codes by the given document and account
protected InvoiceDetailAccountObjectCode	findFirstPositiveCurrentExpenditureInvoiceDetailAccountObjectCode(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes) Given a list of invoice detail account object codes, return the first one with a positive currentExpenditure field
protected void	generateAndSaveContractsAndGrantsInvoiceDocument(ContractsAndGrantsBillingAward awd, List<ContractsAndGrantsBillingAwardAccount> validAwardAccounts, String coaCode, String orgCode, List<org.kuali.rice.krad.util.ErrorMessage> errorMessages, List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails, String locCreationType) Generates and then saves a Contracts & Grants Invoice Document
List<ContractsGrantsInvoiceDetail>	generateValuesForCategories(String documentNumber, List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes, Map<String,org.kuali.rice.core.api.util.type.KualiDecimal> budgetAmountsByCostCategory, List<AwardAccountObjectCodeTotalBilled> awardAccountObjectCodeTotalBilleds) 1.
AccountService	getAccountService()
AwardAccountObjectCodeTotalBilledDao	getAwardAccountObjectCodeTotalBilledDao()
protected org.kuali.rice.core.api.util.type.KualiDecimal	getBudgetBalanceAmount(Balance balance, boolean firstFiscalPeriod) Determines the balance amount (cg + annual) from the given budget balance
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
org.kuali.rice.core.api.config.property.ConfigurationService	getConfigurationService()
ContractsAndGrantsModuleBillingService	getContractsAndGrantsModuleBillingService()
ContractsGrantsBillingAwardVerificationService	getContractsGrantsBillingAwardVerificationService()
ContractsGrantsBillingUtilityService	getContractsGrantsBillingUtilityService()
ContractsGrantsInvoiceDocumentService	getContractsGrantsInvoiceDocumentService()
CostCategoryService	getCostCategoryService()
CustomerService	getCustomerService()
org.kuali.rice.core.api.datetime.DateTimeService	getDateTimeService()
FinancialSystemDocumentService	getFinancialSystemDocumentService()
protected Collection<ContractsGrantsInvoiceDocument>	getInProgressInvoicesForAward(ContractsAndGrantsBillingAward award) Looks up all the in progress contracts & grants invoices for the award
protected InvoiceDetailAccountObjectCode	getInvoiceDetailAccountObjectCodeByBalanceAndCategory(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes, Balance bal, String documentNumber, Long proposalNumber, CostCategory category) Looks up or constructs an InvoiceDetailAccountObjectCode based on a given balance and billing category
OptionsService	getOptionsService()
org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
UniversityDateService	getUniversityDateService()
protected List<ContractsAndGrantsBillingAwardAccount>	getValidAwardAccounts(List<ContractsAndGrantsBillingAwardAccount> awardAccounts, ContractsAndGrantsBillingAward award) This method returns the valid award accounts based on evaluation of billing frequency and invoice document status
protected Set<Account>	harvestAccountsFromContractsGrantsInvoices(Collection<ContractsGrantsInvoiceDocument> contractsGrantsInvoices) Pulls all the unique accounts from the source accounting lines on the given ContractsGrantsInvoiceDocument
protected boolean	hasBillableAccounts(ContractsAndGrantsBillingAward award)
protected boolean	includePeriod13InPeriod01Calculations() Determines if Period 13 should be included in Period 01 calculations for invoice details and invoice account details
protected boolean	isBalanceCostShare(Balance bal) Determines if a balance represents a cost share or not
protected boolean	isFirstFiscalPeriod() Determines if today, the document creation date, occurs within the first fiscal period
protected InvoiceDetailAccountObjectCode	lookupInvoiceDetailAccountObjectCode(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectsCodes, Balance bal, Long proposalNumber) Looks for a matching invoice detail account object code in the given list that matches the given balance and proposal number
protected Map<String,List<AwardAccountObjectCodeTotalBilled>>	mapAwardAccountObjectCodeTotalBilledsByCategoryCode(List<AwardAccountObjectCodeTotalBilled> awardAccountObjectCodeTotalBilleds) Converts a List of AwardAccountObjectCodeTotalBilled into a Map, keyed by the Cost Category which most closely matches them
protected Map<String,List<InvoiceDetailAccountObjectCode>>	mapInvoiceDetailAccountObjectCodesByCategoryCode(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes) Converts a List of InvoiceDetailAccountObjectCodes into a map where the key is the category code
protected void	performAwardValidation(Collection<ContractsAndGrantsBillingAward> awards, Map<ContractsAndGrantsBillingAward,List<String>> invalidGroup, List<ContractsAndGrantsBillingAward> qualifiedAwards) Perform all validation checks on the awards passed in to determine if CGB Invoice documents can be created for the given awards.
protected void	populateContractsGrantsInvoiceDocument(ContractsAndGrantsBillingAward award, ContractsGrantsInvoiceDocument document, List<ContractsGrantsLetterOfCreditReviewDetail> locReviewDetails, String locCreationType) This method helps in setting up basic values for Contracts & Grants Invoice Document
protected void	populateInvoiceDetailFromAward(InvoiceGeneralDetail invoiceGeneralDetail, ContractsAndGrantsBillingAward award) This method takes all the applicable attributes from the associated award object and sets those attributes into their corresponding invoice attributes.
protected void	populateInvoiceFromAward(ContractsAndGrantsBillingAward award, List<ContractsAndGrantsBillingAwardAccount> awardAccounts, ContractsGrantsInvoiceDocument document, List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails, String locCreationType) This method takes all the applicable attributes from the associated award object and sets those attributes into their corresponding invoice attributes.
protected void	redistributeAmountsToInvoiceAccountCategories(Map<String,List<InvoiceDetailAccountObjectCode>> redistributionAccountObjectCodesByCategory, Map<String,org.kuali.rice.core.api.util.type.KualiDecimal> amountsByCategory) Redistributes the given amounts mapped by category to each of the invoice detail account object codes mapped by category code
protected Collection<CostCategory>	retrieveAllBillingCategories()
protected List<Balance>	retrieveBalances(Integer fiscalYear, String chartOfAccountsCode, String accountNumber, List<String> balanceTypeCodeList) Retrieves balances used to populate amounts for an invoice account detail
protected List<AwardAccountObjectCodeTotalBilled>	retrieveBillingInformationForAwardAccount(ContractsAndGrantsBillingAwardAccount awdAcct) Retrieves all of the billing information performed against the given award account
protected List<String>	retrieveContractsGrantsInvoiceDocumentsToRoute(org.kuali.rice.kew.api.document.DocumentStatus statusCode, String initiatorPrincipalId) Returns a list of all saved but not yet routed Contracts & Grants Invoice Documents, using the KualiWorkflowInfo service.
Collection<String>	retrieveExpenseObjectTypes() Retrieve expense object types by the basic accounting category for expenses
protected ContractsGrantsLetterOfCreditReviewDetail	retrieveMatchingLetterOfCreditReviewDetail(ContractsAndGrantsBillingAwardAccount awardAccount, List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails) Finds a letter of credit review detail which matches the given award account, or null if one could not be found
Collection<ContractsAndGrantsBillingAward>	retrieveNonLOCAwards() Validates and parses the file identified by the given files name.
void	routeContractsGrantsInvoiceDocuments() This method retrieves all the Contracts & Grants Invoice Documents with a status of Saved and routes them to the next step in the routing path.
void	setAccountingPeriodService(AccountingPeriodService accountingPeriodService) Sets the accountingPeriodService attribute value.
void	setAccountService(AccountService accountService)
void	setAccountsReceivableDocumentHeaderService(AccountsReceivableDocumentHeaderService accountsReceivableDocumentHeaderService) Sets the accountsReceivableDocumentHeaderService attribute value.
void	setAwardAccountObjectCodeTotalBilledDao(AwardAccountObjectCodeTotalBilledDao awardAccountObjectCodeTotalBilledDao)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Sets the businessObjectService attribute value.
void	setConfigurationService(org.kuali.rice.core.api.config.property.ConfigurationService configurationService)
void	setContractsAndGrantsModuleBillingService(ContractsAndGrantsModuleBillingService contractsAndGrantsModuleBillingService)
void	setContractsGrantsBillingAwardVerificationService(ContractsGrantsBillingAwardVerificationService contractsGrantsBillingAwardVerificationService)
void	setContractsGrantsBillingUtilityService(ContractsGrantsBillingUtilityService contractsGrantsBillingUtilityService)
void	setContractsGrantsInvoiceDocumentService(ContractsGrantsInvoiceDocumentService contractsGrantsInvoiceDocumentService) Sets the contractsGrantsInvoiceDocumentService attribute value.
void	setCostCategoryService(CostCategoryService costCategoryService)
void	setCustomerService(CustomerService customerService)
void	setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService) Sets the documentService attribute value.
void	setFinancialSystemDocumentService(FinancialSystemDocumentService financialSystemDocumentService)
void	setKualiModuleService(org.kuali.rice.krad.service.KualiModuleService kualiModuleService) Sets the kualiModuleService attribute value.
void	setOptionsService(OptionsService optionsService)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)
void	setUniversityDateService(UniversityDateService universityDateService)
void	setVerifyBillingFrequencyService(VerifyBillingFrequencyService verifyBillingFrequencyService) Sets the verifyBillingFrequencyService attribute value.
void	setWorkflowDocumentService(org.kuali.rice.krad.workflow.service.WorkflowDocumentService workflowDocumentService) Sets the workflowDocumentService attribute value.
protected void	splitOutRedistribution(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes, org.kuali.rice.core.api.util.type.KualiDecimal amount) Splits an amount evenly over the given List of invoice detail account object codes
protected void	storeCreationErrors(List<org.kuali.rice.krad.util.ErrorMessage> errorMessages, String creationProcessTypeCode)
protected void	storeValidationErrors(Map<ContractsAndGrantsBillingAward,List<String>> invalidGroup, Collection<ContractsGrantsInvoiceDocumentErrorLog> contractsGrantsInvoiceDocumentErrorLogs, String creationProcessTypeCode)
protected InvoiceDetailAccountObjectCode	sumInvoiceDetailAccountObjectCodes(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes) Sums the current expenditures of the given invoice detail account object codes
protected void	takeAPennyLeaveAPennyCGBStyle(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes, org.kuali.rice.core.api.util.type.KualiDecimal amountToTarget) If the total of current expenditures within the list of InvoiceDetailAccountObjectCode business objects does not meet the amount to target, steal or give a penny from one of those business objects so that it does
protected void	updateCategoryActualAmountsByBalance(ContractsGrantsInvoiceDocument document, Balance balance, ContractsAndGrantsBillingAward award, List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes, boolean firstFiscalPeriod) Updates the appropriate amounts for the InvoiceDetailAccountObjectCode matching the given balance
protected void	updateCategoryBudgetAmountsByBalance(Balance balance, Map<String,org.kuali.rice.core.api.util.type.KualiDecimal> budgetAmountsByCostCategory, boolean firstFiscalPeriod) Updates the cost category budget amount (in the given Map, budgetAmountsByCostCategory) by the total amount of the balance
protected void	updateInvoiceDetailAccountObjectCodesByBilledAmount(ContractsAndGrantsBillingAwardAccount awdAcct, List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectsCodes) Updates all of the given invoice detail object codes by the billed amount for the given award account (and updates the current expenditures accordingly)
protected boolean	useTimeBasedBillingFrequency(String billingFrequencyCode) Given the billing frequency code, determines if the billing is time-based: monthly, quarterly, bi-annual, or annual
protected void	validateAward(List<String> errorList, ContractsAndGrantsBillingAward award) Perform validation for an award to determine if a CGB Invoice document can be created for the award.
Collection<ContractsAndGrantsBillingAward>	validateAwards(Collection<ContractsAndGrantsBillingAward> awards, Collection<ContractsGrantsInvoiceDocumentErrorLog> contractsGrantsInvoiceDocumentErrorLogs, String errOutputFile, String creationProcessTypeCode) This method validates awards and output an error file including unqualified awards with reason stated.
protected void	writeErrorEntryByAward(ContractsAndGrantsBillingAward award, List<String> validationCategory, PrintStream printStream)
protected void	writeErrorToFile(Map<ContractsAndGrantsBillingAward,List<String>> invalidGroup, String errOutputFile)
protected void	writeReportHeader(PrintStream printStream)
protected void	writeToReport(String proposalNumber, String accountNumber, String awardBeginningDate, String awardEndingDate, String awardTotalAmount, String cumulativeExpenses, PrintStream printStream)

Methods inherited from class java.lang.Object

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

Field Detail

accountService

protected AccountService accountService

accountingPeriodService

protected AccountingPeriodService accountingPeriodService

accountsReceivableDocumentHeaderService

protected AccountsReceivableDocumentHeaderService accountsReceivableDocumentHeaderService

awardAccountObjectCodeTotalBilledDao

protected AwardAccountObjectCodeTotalBilledDao awardAccountObjectCodeTotalBilledDao

businessObjectService

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

configurationService

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

contractsGrantsBillingAwardVerificationService

protected ContractsGrantsBillingAwardVerificationService contractsGrantsBillingAwardVerificationService

contractsGrantsBillingUtilityService

protected ContractsGrantsBillingUtilityService contractsGrantsBillingUtilityService

contractsAndGrantsModuleBillingService

protected ContractsAndGrantsModuleBillingService contractsAndGrantsModuleBillingService

contractsGrantsInvoiceDocumentService

protected ContractsGrantsInvoiceDocumentService contractsGrantsInvoiceDocumentService

costCategoryService

protected CostCategoryService costCategoryService

customerService

protected CustomerService customerService

dateTimeService

protected org.kuali.rice.core.api.datetime.DateTimeService dateTimeService

documentService

protected org.kuali.rice.krad.service.DocumentService documentService

financialSystemDocumentService

protected FinancialSystemDocumentService financialSystemDocumentService

kualiModuleService

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

parameterService

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

verifyBillingFrequencyService

protected VerifyBillingFrequencyService verifyBillingFrequencyService

workflowDocumentService

protected org.kuali.rice.krad.workflow.service.WorkflowDocumentService workflowDocumentService

universityDateService

protected UniversityDateService universityDateService

optionsService

protected OptionsService optionsService

REPORT_LINE_DIVIDER

public static final String REPORT_LINE_DIVIDER

See Also:

Constant Field Values

Constructor Detail

ContractsGrantsInvoiceCreateDocumentServiceImpl

public ContractsGrantsInvoiceCreateDocumentServiceImpl()

Method Detail

createCGInvoiceDocumentsByAwards

public List<org.kuali.rice.krad.util.ErrorMessage> createCGInvoiceDocumentsByAwards(Collection<ContractsAndGrantsBillingAward> awards,
                                                                           ArConstants.ContractsAndGrantsInvoiceDocumentCreationProcessType creationProcessTypeCode)

Description copied from interface: ContractsGrantsInvoiceCreateDocumentService

This method is called by the manual CINV creation process create Contracts & Grants Invoice Documents by Awards.

Specified by:

createCGInvoiceDocumentsByAwards in interface ContractsGrantsInvoiceCreateDocumentService

Parameters:

awards - Collection of Awards used to create Contracts & Grants Invoice Documents

Returns:

List of error messages that can be displayed to the user (empty if successful)

See Also:

ContractsGrantsInvoiceCreateDocumentService.createCGInvoiceDocumentsByAwards(java.util.Collection, org.kuali.kfs.module.ar.ArConstants.ContractsAndGrantsInvoiceDocumentCreationProcessType)

createCGInvoiceDocumentsByAwards

public List<org.kuali.rice.krad.util.ErrorMessage> createCGInvoiceDocumentsByAwards(Collection<ContractsAndGrantsBillingAward> awards,
                                                                           List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails,
                                                                           String locCreationType)

Description copied from interface: ContractsGrantsInvoiceCreateDocumentService

Looks for Contracts & Grants Invoice Document with a status of Saved, meaning they have been created and saved to "inbox", but This method is called by the C&G LOC Review document to generate contracts grants invoice documents

Specified by:

createCGInvoiceDocumentsByAwards in interface ContractsGrantsInvoiceCreateDocumentService

Parameters:

awards - Collection of Awards used to create Contracts Grants Invoice Documents

accountDetails - the account details to create the awards

locCreationType - whether loc documents should be created by fund or fund group

Returns:

List of error messages that can be displayed to the user (empty if successful)

See Also:

ContractsGrantsInvoiceCreateDocumentService.createCGInvoiceDocumentsByAwards(java.util.Collection, java.util.List, java.lang.String)

createInvoices

protected List<org.kuali.rice.krad.util.ErrorMessage> createInvoices(Collection<ContractsAndGrantsBillingAward> awards,
                                                         List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails,
                                                         String locCreationType)

This method iterates through awards and create cgInvoice documents

Parameters:

awards - used to create cgInvoice documents

accountDetails - letter of credit details if we're creating via loc

locCreationType - letter of credit creation type if we're creating via loc

Returns:

List of error messages (if any)

createInvoicesByAward

protected void createInvoicesByAward(ContractsAndGrantsBillingAward awd,
                         List<org.kuali.rice.krad.util.ErrorMessage> errorMessages,
                         List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails,
                         String locCreationType)

Generates and saves a single Contracts & Grants Invoice Document based on the given award

Parameters:

awd - the award to generate a Contracts & Grants Invoice Document for

errLines - a holder for error messages

accountDetails - letter of credit details if we're creating via loc

locCreationType - letter of credit creation type if we're creating via loc

createInvoicesByContractControlAccounts

protected void createInvoicesByContractControlAccounts(ContractsAndGrantsBillingAward awd,
                                           List<org.kuali.rice.krad.util.ErrorMessage> errorMessages,
                                           List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails,
                                           String locCreationType)

Generates and saves Contracts & Grants Invoice Documents based on the given award's contract control accounts

Parameters:

awd - the award with contract control accounts to build Contracts & Grants Invoice Documents from

errLines - a holder for error messages

accountDetails - letter of credit details if we're creating via loc

locCreationType - letter of credit creation type if we're creating via loc

createInvoicesByAccounts

protected void createInvoicesByAccounts(ContractsAndGrantsBillingAward awd,
                            List<org.kuali.rice.krad.util.ErrorMessage> errorMessages,
                            List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails,
                            String locCreationType)

Generates and saves Contracts & Grants Invoice Documents based on the award accounts of the passed in award

Parameters:

awd - the award to build Contracts & Grants Invoice Documents from the award accounts on

errLines - a holder for error messages

accountDetails - letter of credit details if we're creating via loc

locCreationType - letter of credit creation type if we're creating via loc

generateAndSaveContractsAndGrantsInvoiceDocument

protected void generateAndSaveContractsAndGrantsInvoiceDocument(ContractsAndGrantsBillingAward awd,
                                                    List<ContractsAndGrantsBillingAwardAccount> validAwardAccounts,
                                                    String coaCode,
                                                    String orgCode,
                                                    List<org.kuali.rice.krad.util.ErrorMessage> errorMessages,
                                                    List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails,
                                                    String locCreationType)

Generates and then saves a Contracts & Grants Invoice Document

Parameters:

awd - the award for the document

validAwardAccounts - the award accounts which should appear on the document

coaCode - the chart code for the document

orgCode - the organization code for the document

errLines - a List of error messages, to be appended to if there are errors in document generation

accountDetails - letter of credit details if we're creating via loc

locCreationType - letter of credit creation type if we're creating via loc

createCGInvoiceDocumentByAwardInfo

public ContractsGrantsInvoiceDocument createCGInvoiceDocumentByAwardInfo(ContractsAndGrantsBillingAward awd,
                                                                List<ContractsAndGrantsBillingAwardAccount> accounts,
                                                                String chartOfAccountsCode,
                                                                String organizationCode,
                                                                List<org.kuali.rice.krad.util.ErrorMessage> errorMessages,
                                                                List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails,
                                                                String locCreationType)

Description copied from interface: ContractsGrantsInvoiceCreateDocumentService

This method creates a single CG Invoice Document

Specified by:

createCGInvoiceDocumentByAwardInfo in interface ContractsGrantsInvoiceCreateDocumentService

Parameters:

awd - Award used to create CG Invoice Document

accounts - of award accounts used to create CG Invoice Document

chartOfAccountsCode - chart code used to create CG Invoice Document

organizationCode - org code used to create CG Invoice Document

errorMessages - a List of error messages the process can append to

accountDetails - the account details to create the awards

locCreationType - whether loc documents should be created by fund or fund group

Returns:

ContractsGrantsInvoiceDocument

See Also:

ContractsGrantsInvoiceCreateDocumentService.createCGInvoiceDocumentByAwardInfo(org.kuali.kfs.integration.cg.ContractsAndGrantsBillingAward, java.util.List, java.lang.String, java.lang.String, java.util.List, java.util.List, java.lang.String)

populateInvoiceFromAward

protected void populateInvoiceFromAward(ContractsAndGrantsBillingAward award,
                            List<ContractsAndGrantsBillingAwardAccount> awardAccounts,
                            ContractsGrantsInvoiceDocument document,
                            List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails,
                            String locCreationType)

This method takes all the applicable attributes from the associated award object and sets those attributes into their corresponding invoice attributes.

Parameters:

award - The associated award that the invoice will be linked to.

awardAccounts -

document -

accountDetails - letter of credit details if we're creating via loc

locCreationType - letter of credit creation type if we're creating via loc

retrieveMatchingLetterOfCreditReviewDetail

protected ContractsGrantsLetterOfCreditReviewDetail retrieveMatchingLetterOfCreditReviewDetail(ContractsAndGrantsBillingAwardAccount awardAccount,
                                                                                   List<ContractsGrantsLetterOfCreditReviewDetail> accountDetails)

Finds a letter of credit review detail which matches the given award account, or null if one could not be found

Parameters:

awardAccount - the award account to find a matching contracts grants letter of credit review detail for

accountDetails - a List of contracts grants letter of credit review details

Returns:

the matching contracts grants review detail, or null if one could not be found

updateCategoryActualAmountsByBalance

protected void updateCategoryActualAmountsByBalance(ContractsGrantsInvoiceDocument document,
                                        Balance balance,
                                        ContractsAndGrantsBillingAward award,
                                        List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes,
                                        boolean firstFiscalPeriod)

Updates the appropriate amounts for the InvoiceDetailAccountObjectCode matching the given balance

Parameters:

document - the CINV document we're generating

balance - the balance to update amounts by

award - the award on the CINV document we're generating

invoiceDetailAccountObjectsCodes - the List of invoiceDetailObjectCodes to update one of

firstFiscalPeriod - whether we're generating the CINV document in the fiscal fiscal period or not

addBalanceToAwardAccountCumulativeAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal addBalanceToAwardAccountCumulativeAmount(ContractsGrantsInvoiceDocument document,
                                                                                      Balance balance,
                                                                                      ContractsAndGrantsBillingAward award,
                                                                                      org.kuali.rice.core.api.util.type.KualiDecimal awardAccountCumulativeAmount,
                                                                                      boolean firstFiscalPeriod)

Sums the balance to the given awardAccountCumulativeAmount and returns that summed amount

Parameters:

document - the CINV document we're generating

balance - the balance to update amounts by

award - the award on the CINV document we're generating

awardAccountCumulativeAmount - the beginning cumulative expense amount for the award account of the balance

firstFiscalPeriod - whether we're generating the CINV document in the fiscal fiscal period or not

Returns:

the updated cumulative amount on the award account

updateCategoryBudgetAmountsByBalance

protected void updateCategoryBudgetAmountsByBalance(Balance balance,
                                        Map<String,org.kuali.rice.core.api.util.type.KualiDecimal> budgetAmountsByCostCategory,
                                        boolean firstFiscalPeriod)

Updates the cost category budget amount (in the given Map, budgetAmountsByCostCategory) by the total amount of the balance

Parameters:

balance - the balance to update the budget amounts by

budgetAmountsByCostCategory - the Map of budget amounts sorted by cost category

firstFiscalPeriod - whether this CINV is being generated in the first fiscal period or not

addBalanceToAwardAccountBudgetAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal addBalanceToAwardAccountBudgetAmount(Balance balance,
                                                                                  org.kuali.rice.core.api.util.type.KualiDecimal awardAccountBudgetAmount,
                                                                                  boolean firstFiscalPeriod)

Adds the budget balance to the award account budget amount

Parameters:

balance - the balance to update the budget amounts by

awardAccountBudgetAmount - the beginning award account budget amount

firstFiscalPeriod - whether this CINV is being generated in the first fiscal period or not

Returns:

the updated award account budget amount

getBudgetBalanceAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal getBudgetBalanceAmount(Balance balance,
                                                                    boolean firstFiscalPeriod)

Determines the balance amount (cg + annual) from the given budget balance

Parameters:

balance - balance to find amount from

firstFiscalPeriod - whether the CINV is being created in the first fiscal period or not

Returns:

the total amount from the balance

buildInvoiceAccountDetailForAwardAccount

protected InvoiceAccountDetail buildInvoiceAccountDetailForAwardAccount(ContractsAndGrantsBillingAward award,
                                                            ContractsAndGrantsBillingAwardAccount awardAccount,
                                                            String documentNumber,
                                                            InvoiceGeneralDetail invoiceGeneralDetail)

Builds a new invoice account detail for a given award account

Parameters:

award - the award associated with the award account

awardAccount - the award account to build the invoice account detail for

documentNumber - the number of the document we're currently building

invoiceGeneralDetail - the invoice general detail for the the document we're currently building

Returns:

the built invoice account detail

buildInvoiceBills

protected List<InvoiceBill> buildInvoiceBills(List<Bill> bills,
                                  Date invoiceDate)

Generates InvoiceBills for each of the given Bills

Parameters:

bills - the bulls to associate with a contracts & grants billing invoice

invoiceDate - the date of the invoice we're building

Returns:

the List of generated InvoiceBill objects

buildInvoiceMilestones

protected List<InvoiceMilestone> buildInvoiceMilestones(List<Milestone> milestones,
                                            Date invoiceDate)

Generates InvoiceMilestones for each of the given milestones

Parameters:

milestones - the milestones to associate with a contracts & grants billing invoice

invoiceDate - the date of the invoice we're building

Returns:

the List of InvoiceMilestones

buildInvoiceAddressDetailsFromAgency

protected List<InvoiceAddressDetail> buildInvoiceAddressDetailsFromAgency(ContractsAndGrantsBillingAgency agency,
                                                              ContractsGrantsInvoiceDocument document)

Builds a list of InvoiceAddressDetails based on the customer associated with an Agency

Parameters:

agency - the agency associated with the proposal we're building a CINV document for

documentNumber - the document number of the CINV document we're creating

Returns:

a List of the generated invoice address details

generateValuesForCategories

public List<ContractsGrantsInvoiceDetail> generateValuesForCategories(String documentNumber,
                                                             List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes,
                                                             Map<String,org.kuali.rice.core.api.util.type.KualiDecimal> budgetAmountsByCostCategory,
                                                             List<AwardAccountObjectCodeTotalBilled> awardAccountObjectCodeTotalBilleds)

1. This method is responsible to populate categories column for the ContractsGrantsInvoice Document. 2. The categories are retrieved from the Maintenance document as a collection and then a logic with conditions to handle ranges of Object Codes. 3. Once the object codes are retrieved and categories are set the performAccountingCalculations method of InvoiceDetail BO will do all the accounting calculations.

Parameters:

documentNumber - the number of the document we want to add invoice details to

invoiceDetailAccountObjectCodes - the List of InvoiceDetailAccountObjectCodes containing amounts to sum into our invoice details

budgetAmountsByCostCategory - the budget amounts, sorted by cost category

awardAccountObjectCodeTotalBilleds - the business objects containg what has been billed from the document's award accounts already

mapInvoiceDetailAccountObjectCodesByCategoryCode

protected Map<String,List<InvoiceDetailAccountObjectCode>> mapInvoiceDetailAccountObjectCodesByCategoryCode(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes)

Converts a List of InvoiceDetailAccountObjectCodes into a map where the key is the category code

Parameters:

invoiceDetailAccountObjectCodes - a List of InvoiceDetailAccountObjectCodes

Returns:

that List converted to a Map, keyed by category code

mapAwardAccountObjectCodeTotalBilledsByCategoryCode

protected Map<String,List<AwardAccountObjectCodeTotalBilled>> mapAwardAccountObjectCodeTotalBilledsByCategoryCode(List<AwardAccountObjectCodeTotalBilled> awardAccountObjectCodeTotalBilleds)

Converts a List of AwardAccountObjectCodeTotalBilled into a Map, keyed by the Cost Category which most closely matches them

Parameters:

awardAccountObjectCodeTotalBilleds - the List of AwardAccountObjectCodeTotalBilled business objects to Map

Returns:

the Mapped AwardAccountObjectCodeTotalBilled records

populateInvoiceDetailFromAward

protected void populateInvoiceDetailFromAward(InvoiceGeneralDetail invoiceGeneralDetail,
                                  ContractsAndGrantsBillingAward award)

This method takes all the applicable attributes from the associated award object and sets those attributes into their corresponding invoice attributes.

Parameters:

invoiceGeneralDetail - the invoice detail to populate

award - The associated award that the invoice will be linked to.

distributeAmountAmongAllAccountObjectCodes

protected void distributeAmountAmongAllAccountObjectCodes(ContractsGrantsInvoiceDocument document,
                                              ContractsAndGrantsBillingAwardAccount awdAcct,
                                              List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectsCodes,
                                              ContractsGrantsLetterOfCreditReviewDetail locReviewDetail)

For letter of credit, this distributes the amount for matching LOC invoice detail account object codes (which is very probably all of invoice detail account object codes in the given list) evenly

Parameters:

document - the CINV document we're creating

awdAcct - the C&G Award Account

invoiceDetailAccountObjectsCodes - the List of invoice detail account object codes we're attempting to generate

locReviewDetail - the contracts grants letter of credit review detail which is related to the given award account

filterInvoiceAccountObjectCodesByDocumentAndAccount

protected List<InvoiceDetailAccountObjectCode> filterInvoiceAccountObjectCodesByDocumentAndAccount(ContractsGrantsInvoiceDocument document,
                                                                                       ContractsAndGrantsBillingAwardAccount awdAcct,
                                                                                       List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectsCodes)

Filters the given list of invoice detail account object codes by the given document and account

Parameters:

document - the document which owns the invoice detail account object codes

awdAcct - the award account to find invoice detail account object codes for

invoiceDetailAccountObjectsCodes - the original list of invoice detail account object codes

Returns:

a list of invoice detail account object codes associated with the given document and the given account

sumInvoiceDetailAccountObjectCodes

protected InvoiceDetailAccountObjectCode sumInvoiceDetailAccountObjectCodes(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes)

Sums the current expenditures of the given invoice detail account object codes

Parameters:

invoiceDetailAccountObjectCodes - invoice detail account object codes to total the current expenditures of

Returns:

the total of the current expenditures

calculatePercentagesByCategory

protected Map<String,BigDecimal> calculatePercentagesByCategory(Map<String,List<InvoiceDetailAccountObjectCode>> invoiceDetailAccountObjectCodesByCategory,
                                                    org.kuali.rice.core.api.util.type.KualiDecimal total)

Calculates the percentage of the given total each list of invoice detail account object codes represents

Parameters:

invoiceDetailAccountObjectCodesByCategory - a Map of invoice detail account object codes mapped by category

total - the total of all of the invoice detail account object codes

Returns:

A Map keyed by category where the value is the percentage of the total that category represents

calculatePercentageByInvoiceDetailAccountObjectCodes

protected BigDecimal calculatePercentageByInvoiceDetailAccountObjectCodes(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes,
                                                              org.kuali.rice.core.api.util.type.KualiDecimal total)

Finds the percentage that the given total is of the sum of the current expenditures of the given invoiceDetailAccountObjectCodes

Parameters:

invoiceDetailAccountObjectCodes - a List of invoice detail account object codes to sum

total - the total of all of the invoice detail account object codes for that account

Returns:

the percentage of the total of the given List of invoice detail account object code current expenditures are of the given total

calculateAmountsByCategory

protected Map<String,org.kuali.rice.core.api.util.type.KualiDecimal> calculateAmountsByCategory(Map<String,BigDecimal> percentagesByCategory,
                                                                                    org.kuali.rice.core.api.util.type.KualiDecimal amount)

Given a Map of category keys mapping percentage values and an amount, find what amount each percentage would be

Parameters:

percentagesByCategory - a map of category code keys mapping percentage values

amount - the amount to split by percentages

Returns:

a Map of amounts keyed by category codes

redistributeAmountsToInvoiceAccountCategories

protected void redistributeAmountsToInvoiceAccountCategories(Map<String,List<InvoiceDetailAccountObjectCode>> redistributionAccountObjectCodesByCategory,
                                                 Map<String,org.kuali.rice.core.api.util.type.KualiDecimal> amountsByCategory)

Redistributes the given amounts mapped by category to each of the invoice detail account object codes mapped by category code

Parameters:

redistributionAccountObjectCodesByCategory - invoice detail account object codes mapped by category code

amountsByCategory - amounts mapped by category code

takeAPennyLeaveAPennyCGBStyle

protected void takeAPennyLeaveAPennyCGBStyle(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes,
                                 org.kuali.rice.core.api.util.type.KualiDecimal amountToTarget)

If the total of current expenditures within the list of InvoiceDetailAccountObjectCode business objects does not meet the amount to target, steal or give a penny from one of those business objects so that it does

Parameters:

invoiceDetailAccountObjectCodes - a List of InvoiceDetailAccountObjectCode business objects

amountToTarget - the amount which the sum of those objects should equal

findFirstPositiveCurrentExpenditureInvoiceDetailAccountObjectCode

protected InvoiceDetailAccountObjectCode findFirstPositiveCurrentExpenditureInvoiceDetailAccountObjectCode(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes)

Given a list of invoice detail account object codes, return the first one with a positive currentExpenditure field

Parameters:

invoiceDetailAccountObjectCodes - the list of InvoiceDetailAccountObjectCodes to find the first one with a positive currentExpenditure

Returns:

the first invoice detail account object code with a positive currentExpenditure or null if nothing could be found

splitOutRedistribution

protected void splitOutRedistribution(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes,
                          org.kuali.rice.core.api.util.type.KualiDecimal amount)

Splits an amount evenly over the given List of invoice detail account object codes

Parameters:

invoiceDetailAccountObjectCodes - a List of invoice detail account object codes to divvy an amount equally among

amount - the amount to divvy

updateInvoiceDetailAccountObjectCodesByBilledAmount

protected void updateInvoiceDetailAccountObjectCodesByBilledAmount(ContractsAndGrantsBillingAwardAccount awdAcct,
                                                       List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectsCodes)

Updates all of the given invoice detail object codes by the billed amount for the given award account (and updates the current expenditures accordingly)

Parameters:

awdAcct - the award account to find billing information for

invoiceDetailAccountObjectsCodes - the List of invoice detail account object code business objects to update

retrieveBillingInformationForAwardAccount

protected List<AwardAccountObjectCodeTotalBilled> retrieveBillingInformationForAwardAccount(ContractsAndGrantsBillingAwardAccount awdAcct)

Retrieves all of the billing information performed against the given award account

Parameters:

awdAcct - a C&G award account

Returns:

the List of billing information

isFirstFiscalPeriod

protected boolean isFirstFiscalPeriod()

Determines if today, the document creation date, occurs within the first fiscal period

Returns:

true if it is the first fiscal period, false otherwise

retrieveAllBillingCategories

protected Collection<CostCategory> retrieveAllBillingCategories()

Returns:

a Collection of all active Contracts & Grants billing categories

getInvoiceDetailAccountObjectCodeByBalanceAndCategory

protected InvoiceDetailAccountObjectCode getInvoiceDetailAccountObjectCodeByBalanceAndCategory(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectCodes,
                                                                                   Balance bal,
                                                                                   String documentNumber,
                                                                                   Long proposalNumber,
                                                                                   CostCategory category)

Looks up or constructs an InvoiceDetailAccountObjectCode based on a given balance and billing category

Parameters:

invoiceDetailAccountObjectCodes - the list of invoice detail account object codes to find a matching Invoice Detail Account Object Code in

bal - the balance to get the account object code from

documentNumber - the document number of the CINV doc being created

proposalNumber - the proposal number associated with the award on the CINV document we're currently building

costCategory - the cost category associated with the balance

Returns:

the retrieved or constructed (if nothing was found in the database) InvoiceDetailAccountObjectCode object

lookupInvoiceDetailAccountObjectCode

protected InvoiceDetailAccountObjectCode lookupInvoiceDetailAccountObjectCode(List<InvoiceDetailAccountObjectCode> invoiceDetailAccountObjectsCodes,
                                                                  Balance bal,
                                                                  Long proposalNumber)

Looks for a matching invoice detail account object code in the given list that matches the given balance and proposal number

Parameters:

invoiceDetailAccountObjectsCodes - a List of invoice detail account object codes to look up values from

bal - the balance to match

proposalNumber - the proposal number to match

Returns:

the matching invoice detail account object code record, or null if no matching record can be found

isBalanceCostShare

protected boolean isBalanceCostShare(Balance bal)

Determines if a balance represents a cost share or not

Parameters:

bal - the balance to check

Returns:

true if the balance is a cost share, false otherwise

useTimeBasedBillingFrequency

protected boolean useTimeBasedBillingFrequency(String billingFrequencyCode)

Given the billing frequency code, determines if the billing is time-based: monthly, quarterly, bi-annual, or annual

Parameters:

billingFrequencyCode - the billing frequency code

Returns:

true if time-based billing is used, false if

retrieveBalances

protected List<Balance> retrieveBalances(Integer fiscalYear,
                             String chartOfAccountsCode,
                             String accountNumber,
                             List<String> balanceTypeCodeList)

Retrieves balances used to populate amounts for an invoice account detail

Parameters:

fiscalYear - the fiscal year of the balances to find

chartOfAccountsCode - the chart of accounts code of balances to find

accountNumber - the account number of balances to find

balanceTypeCodeList - the balance type codes of balances to find

Returns:

a List of retrieved balances

includePeriod13InPeriod01Calculations

protected boolean includePeriod13InPeriod01Calculations()

Determines if Period 13 should be included in Period 01 calculations for invoice details and invoice account details

Returns:

true if period 13 should be included, false otherwise

populateContractsGrantsInvoiceDocument

protected void populateContractsGrantsInvoiceDocument(ContractsAndGrantsBillingAward award,
                                          ContractsGrantsInvoiceDocument document,
                                          List<ContractsGrantsLetterOfCreditReviewDetail> locReviewDetails,
                                          String locCreationType)

This method helps in setting up basic values for Contracts & Grants Invoice Document

calculateMilestoneAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal calculateMilestoneAmount(ContractsGrantsInvoiceDocument document)

calculateTotalBillAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal calculateTotalBillAmount(ContractsGrantsInvoiceDocument document)

calculateTotalExpenditureAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal calculateTotalExpenditureAmount(ContractsGrantsInvoiceDocument document,
                                                                             List<ContractsGrantsLetterOfCreditReviewDetail> locReviewDetails)

calculateBalanceAmountWithoutLastBilledPeriod

protected org.kuali.rice.core.api.util.type.KualiDecimal calculateBalanceAmountWithoutLastBilledPeriod(Date lastBilledDate,
                                                                                           Balance glBalance)

This method would make sure the amounts of the current period are not included. So it calculates the cumulative and subtracts the current period values. This would be done for Billing Frequencies - Monthly, Quarterly, Semi-Annual and Annual.

Parameters:

glBalance -

Returns:

balanceAmount

cleanAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal cleanAmount(org.kuali.rice.core.api.util.type.KualiDecimal amount)

Null protects the addition in retrieveAccurateBalanceAmount

Parameters:

amount - the amount to return

Returns:

zero if the amount was null, the given amount otherwise

retrieveNonLOCAwards

public Collection<ContractsAndGrantsBillingAward> retrieveNonLOCAwards()

Description copied from interface: ContractsGrantsInvoiceCreateDocumentService

Validates and parses the file identified by the given files name. If successful, parsed entries are stored.

Specified by:

retrieveNonLOCAwards in interface ContractsGrantsInvoiceCreateDocumentService

Returns:

True if the file load and store was successful, false otherwise.

See Also:

ContractsGrantsInvoiceCreateDocumentService.retrieveNonLOCAwards()

validateAwards

public Collection<ContractsAndGrantsBillingAward> validateAwards(Collection<ContractsAndGrantsBillingAward> awards,
                                                        Collection<ContractsGrantsInvoiceDocumentErrorLog> contractsGrantsInvoiceDocumentErrorLogs,
                                                        String errOutputFile,
                                                        String creationProcessTypeCode)

Description copied from interface: ContractsGrantsInvoiceCreateDocumentService

This method validates awards and output an error file including unqualified awards with reason stated.

Specified by:

validateAwards in interface ContractsGrantsInvoiceCreateDocumentService

Parameters:

awards - Collection of awards to validation

contractsGrantsInvoiceDocumentErrorLogs - Collection of Error Log records for unqualified awards with reason stated.

errOutputFile - The name of the file recording unqualified awards with reason stated (null to skip writing to a file).

creationProcessTypeCode - type of process (Batch, LOC or Manual) calling this method

Returns:

Collection of qualified Awards - awards that are qualified to be used to create Contracts & Grants Invoice Documents

See Also:

org.kuali.kfs.module.ar.batch.service.ContractsGrantsInvoiceCreateDocumentService#validateAwards(java.util.Collection, java.util.Collection)

performAwardValidation

protected void performAwardValidation(Collection<ContractsAndGrantsBillingAward> awards,
                          Map<ContractsAndGrantsBillingAward,List<String>> invalidGroup,
                          List<ContractsAndGrantsBillingAward> qualifiedAwards)

Perform all validation checks on the awards passed in to determine if CGB Invoice documents can be created for the given awards.

Parameters:

awards - to be validated

invalidGroup - Map of errors per award that failed validation

qualifiedAwards - List of awards that are valid to create CGB Invoice docs from

validateAward

protected void validateAward(List<String> errorList,
                 ContractsAndGrantsBillingAward award)

Perform validation for an award to determine if a CGB Invoice document can be created for the award.

Parameters:

errorList - list of validation errors per award

award - to perform validation upon

writeErrorToFile

protected void writeErrorToFile(Map<ContractsAndGrantsBillingAward,List<String>> invalidGroup,
                    String errOutputFile)

storeValidationErrors

protected void storeValidationErrors(Map<ContractsAndGrantsBillingAward,List<String>> invalidGroup,
                         Collection<ContractsGrantsInvoiceDocumentErrorLog> contractsGrantsInvoiceDocumentErrorLogs,
                         String creationProcessTypeCode)

storeCreationErrors

protected void storeCreationErrors(List<org.kuali.rice.krad.util.ErrorMessage> errorMessages,
                       String creationProcessTypeCode)

routeContractsGrantsInvoiceDocuments

public void routeContractsGrantsInvoiceDocuments()

This method retrieves all the Contracts & Grants Invoice Documents with a status of Saved and routes them to the next step in the routing path.

Specified by:

routeContractsGrantsInvoiceDocuments in interface ContractsGrantsInvoiceCreateDocumentService

See Also:

org.kuali.kfs.module.ar.batch.service.ContractsGrantsInvoiceDocumentCreateService#routeContractsGrantsInvoiceDocuments()

retrieveContractsGrantsInvoiceDocumentsToRoute

protected List<String> retrieveContractsGrantsInvoiceDocumentsToRoute(org.kuali.rice.kew.api.document.DocumentStatus statusCode,
                                                          String initiatorPrincipalId)

Returns a list of all saved but not yet routed Contracts & Grants Invoice Documents, using the KualiWorkflowInfo service.

Returns:

a list of Contracts & Grants Invoice Documents to route

writeErrorEntryByAward

protected void writeErrorEntryByAward(ContractsAndGrantsBillingAward award,
                          List<String> validationCategory,
                          PrintStream printStream)
                               throws IOException

Throws:

IOException

writeToReport

protected void writeToReport(String proposalNumber,
                 String accountNumber,
                 String awardBeginningDate,
                 String awardEndingDate,
                 String awardTotalAmount,
                 String cumulativeExpenses,
                 PrintStream printStream)
                      throws IOException

Throws:

IOException

writeReportHeader

protected void writeReportHeader(PrintStream printStream)
                          throws IOException

Parameters:

printStream -

Throws:

IOException

hasBillableAccounts

protected boolean hasBillableAccounts(ContractsAndGrantsBillingAward award)

getValidAwardAccounts

protected List<ContractsAndGrantsBillingAwardAccount> getValidAwardAccounts(List<ContractsAndGrantsBillingAwardAccount> awardAccounts,
                                                                ContractsAndGrantsBillingAward award)

This method returns the valid award accounts based on evaluation of billing frequency and invoice document status

Parameters:

awardAccounts -

Returns:

valid awardAccounts

harvestAccountsFromContractsGrantsInvoices

protected Set<Account> harvestAccountsFromContractsGrantsInvoices(Collection<ContractsGrantsInvoiceDocument> contractsGrantsInvoices)

Pulls all the unique accounts from the source accounting lines on the given ContractsGrantsInvoiceDocument

Parameters:

contractsGrantsInvoices - the invoices to pull unique accounts from

Returns:

a Set of the unique accounts

getInProgressInvoicesForAward

protected Collection<ContractsGrantsInvoiceDocument> getInProgressInvoicesForAward(ContractsAndGrantsBillingAward award)

Looks up all the in progress contracts & grants invoices for the award

Parameters:

award - the award to look up contracts & grants invoices for

Returns:

a Collection matching in progress/pending Contracts & Grants Invoice documents

retrieveExpenseObjectTypes

public Collection<String> retrieveExpenseObjectTypes()

Retrieve expense object types by the basic accounting category for expenses

Specified by:

retrieveExpenseObjectTypes in interface ContractsGrantsInvoiceCreateDocumentService

Returns:

The collection of object type codes used to create CG Invoice Documents

See Also:

ContractsGrantsInvoiceCreateDocumentService.retrieveExpenseObjectTypes()

getAccountService

public AccountService getAccountService()

setAccountService

public void setAccountService(AccountService accountService)

setAccountingPeriodService

public void setAccountingPeriodService(AccountingPeriodService accountingPeriodService)

Sets the accountingPeriodService attribute value.

Parameters:

accountingPeriodService - The accountingPeriodService to set.

setVerifyBillingFrequencyService

public void setVerifyBillingFrequencyService(VerifyBillingFrequencyService verifyBillingFrequencyService)

Sets the verifyBillingFrequencyService attribute value.

Parameters:

verifyBillingFrequencyService - The verifyBillingFrequencyService to set.

getBusinessObjectService

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

setBusinessObjectService

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

Sets the businessObjectService attribute value.

Parameters:

businessObjectService - The businessObjectService to set.

setWorkflowDocumentService

public void setWorkflowDocumentService(org.kuali.rice.krad.workflow.service.WorkflowDocumentService workflowDocumentService)

Sets the workflowDocumentService attribute value.

Parameters:

workflowDocumentService - The workflowDocumentService to set.

setDocumentService

public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)

Sets the documentService attribute value.

Parameters:

documentService - The documentService to set.

setAccountsReceivableDocumentHeaderService

public void setAccountsReceivableDocumentHeaderService(AccountsReceivableDocumentHeaderService accountsReceivableDocumentHeaderService)

Sets the accountsReceivableDocumentHeaderService attribute value.

Parameters:

accountsReceivableDocumentHeaderService - The accountsReceivableDocumentHeaderService to set.

setContractsGrantsInvoiceDocumentService

public void setContractsGrantsInvoiceDocumentService(ContractsGrantsInvoiceDocumentService contractsGrantsInvoiceDocumentService)

Sets the contractsGrantsInvoiceDocumentService attribute value.

Parameters:

contractsGrantsInvoiceDocumentService - The contractsGrantsInvoiceDocumentService to set.

getContractsGrantsInvoiceDocumentService

public ContractsGrantsInvoiceDocumentService getContractsGrantsInvoiceDocumentService()

getDateTimeService

public org.kuali.rice.core.api.datetime.DateTimeService getDateTimeService()

setDateTimeService

public void setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)

setKualiModuleService

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

Sets the kualiModuleService attribute value.

Parameters:

kualiModuleService - The kualiModuleService to set.

getConfigurationService

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

setConfigurationService

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

getContractsGrantsBillingUtilityService

public ContractsGrantsBillingUtilityService getContractsGrantsBillingUtilityService()

setContractsGrantsBillingUtilityService

public void setContractsGrantsBillingUtilityService(ContractsGrantsBillingUtilityService contractsGrantsBillingUtilityService)

getContractsAndGrantsModuleBillingService

public ContractsAndGrantsModuleBillingService getContractsAndGrantsModuleBillingService()

setContractsAndGrantsModuleBillingService

public void setContractsAndGrantsModuleBillingService(ContractsAndGrantsModuleBillingService contractsAndGrantsModuleBillingService)

getFinancialSystemDocumentService

public FinancialSystemDocumentService getFinancialSystemDocumentService()

setFinancialSystemDocumentService

public void setFinancialSystemDocumentService(FinancialSystemDocumentService financialSystemDocumentService)

getUniversityDateService

public UniversityDateService getUniversityDateService()

setUniversityDateService

public void setUniversityDateService(UniversityDateService universityDateService)

getAwardAccountObjectCodeTotalBilledDao

public AwardAccountObjectCodeTotalBilledDao getAwardAccountObjectCodeTotalBilledDao()

setAwardAccountObjectCodeTotalBilledDao

public void setAwardAccountObjectCodeTotalBilledDao(AwardAccountObjectCodeTotalBilledDao awardAccountObjectCodeTotalBilledDao)

getCustomerService

public CustomerService getCustomerService()

setCustomerService

public void setCustomerService(CustomerService customerService)

getParameterService

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

setParameterService

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

getContractsGrantsBillingAwardVerificationService

public ContractsGrantsBillingAwardVerificationService getContractsGrantsBillingAwardVerificationService()

setContractsGrantsBillingAwardVerificationService

public void setContractsGrantsBillingAwardVerificationService(ContractsGrantsBillingAwardVerificationService contractsGrantsBillingAwardVerificationService)

getCostCategoryService

public CostCategoryService getCostCategoryService()

setCostCategoryService

public void setCostCategoryService(CostCategoryService costCategoryService)

getOptionsService

public OptionsService getOptionsService()

setOptionsService

public void setOptionsService(OptionsService optionsService)