org.kuali.kra.budget.parameters

Class BudgetPeriod

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.budget.core.BudgetAssociate

org.kuali.kra.budget.parameters.BudgetPeriod

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, BudgetAssociateInterface, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject

Direct Known Subclasses:

AwardBudgetPeriodExt

public class BudgetPeriod
extends BudgetAssociate

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

UPDATE_USER_LENGTH

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
BudgetPeriod()

Method Summary

Methods

Modifier and Type	Method and Description
int	calculateFiscalYear(Date fiscalYearStartDateTime)
Budget	getBudget() Gets the budget attribute.
BudgetLineItem	getBudgetLineItem(int index) Gets BudgetLineItem from budgetLineItems list at index.
List<BudgetLineItem>	getBudgetLineItems() Gets the budgetLineItems attribute.
BudgetModular	getBudgetModular()
String	getBudgetParentId() Gets the budgetParentId attribute.
Integer	getBudgetPeriod()
static Comparator<BudgetPeriod>	getBudgetPeriodDateComparator() Factory method for creating a BudgetPeriodDateComparator
Long	getBudgetPeriodId()
String	getComments()
BudgetDecimal	getCostSharingAmount()
String	getDateRange()
String	getDateRangeLabel()
BudgetDecimal	getDirectCostLimit() Gets the directCostLimit attribute.
Date	getEndDate()
BudgetDecimal	getExpenseTotal()
String	getInstitutionalProposalNumber()
Integer	getInstitutionalProposalVersion()
String	getLabel()
BudgetLineItem	getNewBudgetLineItem()
String	getNumberOfMonths()
Integer	getNumberOfParticipants()
Date	getOldEndDate()
Date	getOldStartDate()
protected ProposalBudgetNumberOfMonthsService	getProposalBudgetNumberOfMonthsService()
Date	getStartDate()
BudgetDecimal	getSumCostSharingAmountFromLineItems() Gets the sum of the CostSharing Amount for all line items.
BudgetDecimal	getSumDirectCostAmountFromLineItems() Gets the sum of the Direct Cost Amount for all line items.
BudgetDecimal	getSumIndirectCostAmountFromLineItems() Gets the sum of the Indirect Cost Amount for all line items.
BudgetDecimal	getSumTotalCostAmountFromLineItems() Gets the sum of the Total Cost Amount for all line items.
BudgetDecimal	getSumTotalCostSharingAmountFromLineItems() Gets the sum of the Total CostSharing Amount for all line items.
BudgetDecimal	getSumUnderreoveryAmountFromLineItems() Gets the sum of the Total Underreovery Amount for all line items.
BudgetDecimal	getTotalCost()
BudgetDecimal	getTotalCostLimit()
BudgetDecimal	getTotalDirectCost()
BudgetDecimal	getTotalIndirectCost()
BudgetDecimal	getUnderrecoveryAmount()
boolean	isReadOnly() This method determines whether
void	populateSummaryCalcAmounts()
void	setBudget(Budget budget) Sets the budget attribute value.
void	setBudgetLineItems(List<BudgetLineItem> budgetLineItems) Sets the budgetLineItems attribute value.
void	setBudgetModular(BudgetModular budgetModular)
void	setBudgetParentId(String budgetParentId) Sets the budgetParentId attribute value.
void	setBudgetPeriod(Integer budgetPeriod)
void	setBudgetPeriodId(Long budgetPeriodId)
void	setComments(String comments)
void	setCostSharingAmount(BudgetDecimal costSharingAmount)
void	setDirectCostLimit(BudgetDecimal directCostLimit) Sets the directCostLimit attribute value.
void	setEndDate(Date endDate)
void	setExpenseTotal(BudgetDecimal expenseTotal)
void	setInstitutionalProposalNumber(String institutionalProposalNumber)
void	setInstitutionalProposalVersion(Integer institutionalProposalVersion)
void	setNumberOfParticipants(Integer numberOfParticipants)
void	setOldEndDate(Date oldEndDate)
void	setOldStartDate(Date oldStartDate)
void	setStartDate(Date startDate)
void	setTotalCost(BudgetDecimal totalCost)
void	setTotalCostLimit(BudgetDecimal totalCostLimit)
void	setTotalDirectCost(BudgetDecimal totalDirectCost)
void	setTotalIndirectCost(BudgetDecimal totalIndirectCost)
void	setUnderrecoveryAmount(BudgetDecimal underrecoveryAmount)

Methods inherited from class org.kuali.kra.budget.core.BudgetAssociate

getBudgetId, setBudgetId

Methods inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

getAuthorPersonName, getKcPersonService, getUpdateTimestamp, getUpdateUser, isUpdateUserSet, postPersist, prePersist, preUpdate, setUpdateTimestamp, setUpdateUser, setUpdateUserSet

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postRemove, postUpdate, preRemove, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Constructor Detail

BudgetPeriod

public BudgetPeriod()

Method Detail

getBudgetPeriodDateComparator

public static Comparator<BudgetPeriod> getBudgetPeriodDateComparator()

Factory method for creating a BudgetPeriodDateComparator

Returns:

getBudgetPeriod

public Integer getBudgetPeriod()

getLabel

public String getLabel()

getDateRangeLabel

public String getDateRangeLabel()

setBudgetPeriod

public void setBudgetPeriod(Integer budgetPeriod)

getComments

public String getComments()

setComments

public void setComments(String comments)

getCostSharingAmount

public BudgetDecimal getCostSharingAmount()

setCostSharingAmount

public void setCostSharingAmount(BudgetDecimal costSharingAmount)

getEndDate

public Date getEndDate()

setEndDate

public void setEndDate(Date endDate)

getStartDate

public Date getStartDate()

setStartDate

public void setStartDate(Date startDate)

getTotalCost

public BudgetDecimal getTotalCost()

setTotalCost

public void setTotalCost(BudgetDecimal totalCost)

getTotalCostLimit

public BudgetDecimal getTotalCostLimit()

setTotalCostLimit

public void setTotalCostLimit(BudgetDecimal totalCostLimit)

getTotalDirectCost

public BudgetDecimal getTotalDirectCost()

setTotalDirectCost

public void setTotalDirectCost(BudgetDecimal totalDirectCost)

getTotalIndirectCost

public BudgetDecimal getTotalIndirectCost()

setTotalIndirectCost

public void setTotalIndirectCost(BudgetDecimal totalIndirectCost)

getUnderrecoveryAmount

public BudgetDecimal getUnderrecoveryAmount()

setUnderrecoveryAmount

public void setUnderrecoveryAmount(BudgetDecimal underrecoveryAmount)

getBudgetLineItem

public BudgetLineItem getBudgetLineItem(int index)

Gets BudgetLineItem from budgetLineItems list at index.

Parameters:

index -

Returns:

BudgetLineItem at index

getNewBudgetLineItem

public BudgetLineItem getNewBudgetLineItem()

getBudgetModular

public BudgetModular getBudgetModular()

setBudgetModular

public void setBudgetModular(BudgetModular budgetModular)

getBudgetLineItems

public List<BudgetLineItem> getBudgetLineItems()

Gets the budgetLineItems attribute.

Returns:

Returns the budgetLineItems.

setBudgetLineItems

public void setBudgetLineItems(List<BudgetLineItem> budgetLineItems)

Sets the budgetLineItems attribute value.

Parameters:

budgetLineItems - The budgetLineItems to set.

isReadOnly

public boolean isReadOnly()

This method determines whether

Returns:

getExpenseTotal

public BudgetDecimal getExpenseTotal()

setExpenseTotal

public void setExpenseTotal(BudgetDecimal expenseTotal)

calculateFiscalYear

public int calculateFiscalYear(Date fiscalYearStartDateTime)

getDateRange

public String getDateRange()

getOldEndDate

public Date getOldEndDate()

setOldEndDate

public void setOldEndDate(Date oldEndDate)

getOldStartDate

public Date getOldStartDate()

setOldStartDate

public void setOldStartDate(Date oldStartDate)

getBudgetPeriodId

public Long getBudgetPeriodId()

setBudgetPeriodId

public void setBudgetPeriodId(Long budgetPeriodId)

getSumUnderreoveryAmountFromLineItems

public final BudgetDecimal getSumUnderreoveryAmountFromLineItems()

Gets the sum of the Total Underreovery Amount for all line items.

Parameters:

lineItems - the budget line items

Returns:

the amount.

getSumCostSharingAmountFromLineItems

public final BudgetDecimal getSumCostSharingAmountFromLineItems()

Gets the sum of the CostSharing Amount for all line items.

Returns:

the amount

getSumTotalCostSharingAmountFromLineItems

public final BudgetDecimal getSumTotalCostSharingAmountFromLineItems()

Gets the sum of the Total CostSharing Amount for all line items.

Returns:

the amount

getSumDirectCostAmountFromLineItems

public final BudgetDecimal getSumDirectCostAmountFromLineItems()

Gets the sum of the Direct Cost Amount for all line items.

Returns:

the amount

getSumIndirectCostAmountFromLineItems

public final BudgetDecimal getSumIndirectCostAmountFromLineItems()

Gets the sum of the Indirect Cost Amount for all line items.

Returns:

the amount

getSumTotalCostAmountFromLineItems

public final BudgetDecimal getSumTotalCostAmountFromLineItems()

Gets the sum of the Total Cost Amount for all line items.

Returns:

the amount

getBudget

public Budget getBudget()

Gets the budget attribute.

Returns:

Returns the budget.

setBudget

public void setBudget(Budget budget)

Sets the budget attribute value.

Parameters:

budget - The budget to set.

setBudgetParentId

public void setBudgetParentId(String budgetParentId)

Sets the budgetParentId attribute value.

Parameters:

budgetParentId - The budgetParentId to set.

getBudgetParentId

public String getBudgetParentId()

Gets the budgetParentId attribute.

Returns:

Returns the budgetParentId.

getInstitutionalProposalNumber

public String getInstitutionalProposalNumber()

setInstitutionalProposalNumber

public void setInstitutionalProposalNumber(String institutionalProposalNumber)

getInstitutionalProposalVersion

public Integer getInstitutionalProposalVersion()

setInstitutionalProposalVersion

public void setInstitutionalProposalVersion(Integer institutionalProposalVersion)

getDirectCostLimit

public BudgetDecimal getDirectCostLimit()

Gets the directCostLimit attribute.

Returns:

Returns the directCostLimit.

setDirectCostLimit

public void setDirectCostLimit(BudgetDecimal directCostLimit)

Sets the directCostLimit attribute value.

Parameters:

directCostLimit - The directCostLimit to set.

populateSummaryCalcAmounts

public void populateSummaryCalcAmounts()

getNumberOfMonths

public String getNumberOfMonths()

getProposalBudgetNumberOfMonthsService

protected ProposalBudgetNumberOfMonthsService getProposalBudgetNumberOfMonthsService()

getNumberOfParticipants

public Integer getNumberOfParticipants()

setNumberOfParticipants

public void setNumberOfParticipants(Integer numberOfParticipants)