org.kuali.kra.budget.core

Interface BudgetService<T extends BudgetParent>

All Known Implementing Classes:

BudgetServiceImpl

public interface BudgetService<T extends BudgetParent>

Budget Service interface

Method Summary

Methods

Modifier and Type	Method and Description
BudgetDocument<T>	addBudgetVersion(BudgetParentDocument<T> document, String versionName) Service method for adding a BudgetVersionOverview to a ProposalDevelopmentDocument.
boolean	checkActivityTypeChange(BudgetParentDocument<T> pdDoc, Budget budget) This method check if activity type changed, then display confirmation message on 'open' budget version.
boolean	checkActivityTypeChange(Collection<BudgetRate> allPropRates, String proposalActivityTypeCode) This method checks if activity type changed, then display confirmation message on 'open' budget version.
BudgetDocument<T>	copyBudgetVersion(BudgetDocument<T> budgetDocument, boolean onlyOnePeriod) Returns a new finalized BudgetDocument with the data from the given BudgetDocument copied over.
String	getActivityTypeForBudget(BudgetDocument<T> budgetDocument)
List<ValidCeJobCode>	getApplicableCostElements(Long budgetId, String personSequenceNumber) This method returns the applicable Object Codes (Cost Elements) for a given Budget Person based on his Job Code
String	getApplicableCostElementsForAjaxCall(Long budgetId, String personSequenceNumber, String budgetCategoryTypeCode) This method returns the applicable Object Codes (Cost Elements) for a given Budget Person, converted to string separated by ",".
BudgetDecimal	getBaseSalaryByPeriod(Long budgetId, int budgetPeriod, KeyPersonInfo keyPerson)
String	getBudgetExpensePanelName(BudgetPeriod budgetPeriod, BudgetLineItem budgetLineItem) This method returns the Non-Personnel Panel Name (based on the variables).
List<String>	getExistingGroupNames(String budgetId, String budgetPeriod) This method returns the existing Personnel Line Item Group Names based on his Job Code
String	getExistingGroupNamesForAjaxCall(String budgetId, String budgetPeriod) This method returns the existing Personnel Line Item Group Names , converted to string separated by ",".
List<BudgetLineItem>	getMatchingLineItems(List<BudgetLineItem> lineItems, List<String> objectCodes)
String	getParticipantSupportCategoryCode()
Collection<BudgetRate>	getSavedBudgetRates(Budget budget) This method returns the saved Proposal Rates collection.
Collection<BudgetRate>	getSavedProposalRates(BudgetVersionOverview budgetToOpen)
boolean	isBudgetVersionNameValid(BudgetParentDocument<T> document, String versionName) Determine if the names of a BudgetVersionOverview instances in the given ProposalDevelopmentDocument instance is valid
String	populateBudgetPersonSalaryDetailsInPeriods(String budgetId, String personSequenceNumber, String personId)
void	populateNewBudgetLineItem(BudgetLineItem newBudgetLineItem, BudgetPeriod budgetPeriod)
void	updateDocumentDescription(BudgetVersionOverview budgetVersion)
boolean	validateBudgetAuditRule(BudgetParentDocument<T> parentDocument) This method to invoke audit rule check for budget if status is final only This is called by PD's turnon validation
boolean	validateBudgetAuditRuleBeforeSaveBudgetVersion(BudgetParentDocument<T> proposalDevelopmentDocument) This method to check the audit rule when try to save 'budgetversion' and with 'complete' status.
boolean	ValidInflationCeRate(BudgetLineItemBase budgetLineItem) check if this line item CE has inflation rate This method...

Method Detail

addBudgetVersion

BudgetDocument<T> addBudgetVersion(BudgetParentDocument<T> document,
                                 String versionName)
                                                        throws org.kuali.rice.kew.api.exception.WorkflowException

Service method for adding a BudgetVersionOverview to a ProposalDevelopmentDocument. If a BudgetVersionOverview instance with the versionName already exists in the ProposalDevelopmentDocument, then a hard error will occur. Try it and you'll see what I mean.

Parameters:

document - instance to add BudgetVersionOverview to

versionName - of the BudgetVersionOverview

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

updateDocumentDescription

void updateDocumentDescription(BudgetVersionOverview budgetVersion)

checkActivityTypeChange

boolean checkActivityTypeChange(BudgetParentDocument<T> pdDoc,
                              Budget budget)

This method check if activity type changed, then display confirmation message on 'open' budget version.

Parameters:

pdDoc -

budgetVersionNumbe -

Returns:

checkActivityTypeChange

boolean checkActivityTypeChange(Collection<BudgetRate> allPropRates,
                              String proposalActivityTypeCode)

This method checks if activity type changed, then display confirmation message on 'open' budget version.

Parameters:

allPropRates -

proposalActivityTypeCode -

Returns:

getSavedBudgetRates

Collection<BudgetRate> getSavedBudgetRates(Budget budget)

This method returns the saved Proposal Rates collection.

Parameters:

pdDoc -

budgetVersionNumbe -

Returns:

Collection

ValidInflationCeRate

boolean ValidInflationCeRate(BudgetLineItemBase budgetLineItem)

check if this line item CE has inflation rate This method...

Parameters:

budgetDocument -

budgetLineItem -

Returns:

getActivityTypeForBudget

String getActivityTypeForBudget(BudgetDocument<T> budgetDocument)

getApplicableCostElements

List<ValidCeJobCode> getApplicableCostElements(Long budgetId,
                                             String personSequenceNumber)

This method returns the applicable Object Codes (Cost Elements) for a given Budget Person based on his Job Code

Parameters:

proposalNumber -

budgetVersionNumber -

personSequenceNumber -

Returns:

List of Cost Elements

getApplicableCostElementsForAjaxCall

String getApplicableCostElementsForAjaxCall(Long budgetId,
                                          String personSequenceNumber,
                                          String budgetCategoryTypeCode)

This method returns the applicable Object Codes (Cost Elements) for a given Budget Person, converted to string separated by ",".

Parameters:

proposalNumber -

budgetVersionNumber -

personSequenceNumber -

Returns:

List of Cost Elements

getExistingGroupNames

List<String> getExistingGroupNames(String budgetId,
                                 String budgetPeriod)

This method returns the existing Personnel Line Item Group Names based on his Job Code

Parameters:

proposalNumber -

budgetVersionNumber -

budgetPeriod -

Returns:

List of existing Group Names

getExistingGroupNamesForAjaxCall

String getExistingGroupNamesForAjaxCall(String budgetId,
                                      String budgetPeriod)

This method returns the existing Personnel Line Item Group Names , converted to string separated by ",".

Parameters:

proposalNumber -

budgetVersionNumber -

budgetPeriod -

Returns:

List of existing Group Names

getBudgetExpensePanelName

String getBudgetExpensePanelName(BudgetPeriod budgetPeriod,
                               BudgetLineItem budgetLineItem)

This method returns the Non-Personnel Panel Name (based on the variables).

Parameters:

budgetPeriod -

budgetLineItem -

Returns:

Non-Personnel Panel Name for the passed in Line Item

getParticipantSupportCategoryCode

String getParticipantSupportCategoryCode()

getMatchingLineItems

List<BudgetLineItem> getMatchingLineItems(List<BudgetLineItem> lineItems,
                                        List<String> objectCodes)

getSavedProposalRates

Collection<BudgetRate> getSavedProposalRates(BudgetVersionOverview budgetToOpen)

validateBudgetAuditRuleBeforeSaveBudgetVersion

boolean validateBudgetAuditRuleBeforeSaveBudgetVersion(BudgetParentDocument<T> proposalDevelopmentDocument)
                                                       throws Exception

This method to check the audit rule when try to save 'budgetversion' and with 'complete' status.

Parameters:

proposalDevelopmentDocument -

Returns:

Throws:

Exception

isBudgetVersionNameValid

boolean isBudgetVersionNameValid(BudgetParentDocument<T> document,
                               String versionName)

Determine if the names of a BudgetVersionOverview instances in the given ProposalDevelopmentDocument instance is valid

Parameters:

document - ProposalDevelopmentDocument instance to get BudgetVersionOverview instances from

versionName - to check

Returns:

true for valid false otherwie

validateBudgetAuditRule

boolean validateBudgetAuditRule(BudgetParentDocument<T> parentDocument)
                                throws Exception

This method to invoke audit rule check for budget if status is final only This is called by PD's turnon validation

Parameters:

proposalDevelopmentDocument -

Returns:

Throws:

Exception

copyBudgetVersion

BudgetDocument<T> copyBudgetVersion(BudgetDocument<T> budgetDocument,
                                  boolean onlyOnePeriod)
                                                         throws org.kuali.rice.kew.api.exception.WorkflowException

Returns a new finalized BudgetDocument with the data from the given BudgetDocument copied over.

Parameters:

budgetDocument -

onlyOnePeriod -

Returns:

BudgetDocument

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

populateBudgetPersonSalaryDetailsInPeriods

String populateBudgetPersonSalaryDetailsInPeriods(String budgetId,
                                                String personSequenceNumber,
                                                String personId)

getBaseSalaryByPeriod

BudgetDecimal getBaseSalaryByPeriod(Long budgetId,
                                  int budgetPeriod,
                                  KeyPersonInfo keyPerson)

populateNewBudgetLineItem

void populateNewBudgetLineItem(BudgetLineItem newBudgetLineItem,
                             BudgetPeriod budgetPeriod)