InstitutionalProposal (Kuali Coeus 5.1.1 API)

java.lang.Object
- org.kuali.rice.krad.bo.BusinessObjectBase
- - org.kuali.rice.krad.bo.PersistableBusinessObjectBase
  - - org.kuali.kra.bo.KraPersistableBusinessObjectBase
    - - org.kuali.kra.institutionalproposal.home.InstitutionalProposal

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, KeywordsManager<InstitutionalProposalScienceKeyword>, Negotiable, Sequenceable, SequenceAssociate<InstitutionalProposal>, SequenceOwner<InstitutionalProposal>, Sponsorable, 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
```
public class InstitutionalProposal
extends KraPersistableBusinessObjectBase
implements KeywordsManager<InstitutionalProposalScienceKeyword>, SequenceOwner<InstitutionalProposal>, Sponsorable, Negotiable
```
See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PROPOSAL_ID_PROPERTY_STRING`
`static String`	`PROPOSAL_NUMBER_PROPERTY_STRING`
`static String`	`PROPOSAL_NUMBER_TEST_DEFAULT_STRING`
`static String`	`PROPOSAL_SEQUENCE_STATUS_PROPERTY_STRING`

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

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase
extension, versionNumber

Fields inherited from interface org.kuali.kra.negotiations.bo.Negotiable
EMPTY_STRING

Constructor Summary

Constructors
Constructor and Description

InstitutionalProposal()

Constructors
Constructor and Description
`InstitutionalProposal()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`activateFundingProposals()`
`void`	`add(AwardFundingProposal afp)` Add an AwardFundingProposal The Award "owns" the relationship, so this method should not be called directly.
`void`	`add(InstitutionalProposalComment ipComment)`
`void`	`add(InstitutionalProposalCostShare institutionalProposalCostShare)` This method...
`void`	`add(InstitutionalProposalNotepad institutionalProposalNotepad)` This method...
`void`	`add(InstitutionalProposalPerson projectPerson)` This method adds a Project Person to the institutionalProposal
`void`	`add(InstitutionalProposalUnitContact institutionalProposalUnitContact)` Add an Institutional Proposal Unit or Central Administration contact
`void`	`add(InstitutionalProposalUnrecoveredFandA institutionalProposalUnrecoveredFandA)` This method...
`void`	`addKeyword(ScienceKeyword scienceKeyword)` Add selected science keyword to award science keywords list.
`void`	`addSpecialReview(InstitutionalProposalSpecialReview specialReview)`
`void`	`deactivateFundingProposals()`
`void`	`doProposalLogDataFeed(ProposalLog proposalLog)` Populate properties on this InstitutionalProposal with the respective properties from ProposalLog.
`List<AwardFundingProposal>`	`getActiveAwardFundingProposals()` Get the list of only Active AwardFundingProposals.
`ActivityType`	`getActivityType()`
`String`	`getActivityTypeCode()`
`ActivityType`	`getActivityTypeFromCode()` This method lazy inits ActivityType
`String`	`getAdminPersonName()` This method returns the admin person's name, if it exists, otherwise returns an empty string.
`String`	`getAssociatedDocumentId()` Returns the negotiable's document id.
`AwardFundingProposal`	`getAwardFundingProposal(int index)`
`List<AwardFundingProposal>`	`getAwardFundingProposals()`
`boolean`	`getAwardFundingProposalsExist()`
`AwardType`	`getAwardType()`
`Integer`	`getAwardTypeCode()`
`protected org.kuali.rice.krad.service.BusinessObjectService`	`getBusinessObjectService()`
`String`	`getCfdaNumber()`
`InstitutionalProposalComment`	`getCostShareComment()`
`String`	`getCostSharingIndicator()`
`Date`	`getCreateTimeStamp()` Gets the createTimeStamp attribute.
`String`	`getCurrentAccountNumber()`
`String`	`getCurrentAwardNumber()`
`Date`	`getDeadlineDate()`
`String`	`getDeadlineTime()`
`String`	`getDeadlineType()`
`String`	`getDefaultNewDescription()`
`InstitutionalProposalComment`	`getDeliveryComment()`
`String`	`getFiscalMonth()` Gets the fiscalMonth attribute.
`String`	`getFiscalYear()` Gets the fiscalYear attribute.
`FiscalYearMonthService`	`getFiscalYearMonthService()`
`InstitutionalProposalComment`	`getGeneralComment()`
`Integer`	`getGradStudHeadcount()`
`org.kuali.rice.core.api.util.type.KualiDecimal`	`getGradStudPersonMonths()`
`String`	`getIdcRateIndicator()`
`String`	`getInitialContractAdmin()`
`KcPerson`	`getInitialContractAdminUser()`
`InstitutionalProposalComment`	`getInstitutionalProposalCommentByType(String commentTypeCode, boolean createNew)`
`int`	`getInstitutionalProposalContactsCount()`
`List<InstitutionalProposalCostShare>`	`getInstitutionalProposalCostShares()` Gets the institutionalProposalCostShares attribute.
`List<InstitutionalProposalCustomData>`	`getInstitutionalProposalCustomDataList()` Gets the institutionalProposalCustomDataList attribute.
`InstitutionalProposalDocument`	`getInstitutionalProposalDocument()` Gets the institutionalProposalDocument attribute.
`List<InstitutionalProposalNotepad>`	`getInstitutionalProposalNotepads()` Gets the institutionalProposalNotepads attribute.
`List<InstitutionalProposalScienceKeyword>`	`getInstitutionalProposalScienceKeywords()` Gets the institutionalProposalScienceKeywords attribute.
`List<InstitutionalProposalUnitContact>`	`getInstitutionalProposalUnitContacts()`
`List<InstitutionalProposalUnrecoveredFandA>`	`getInstitutionalProposalUnrecoveredFandAs()` Gets the institutionalProposalUnrecoveredFandAs attribute.
`String`	`getInstProposalNumber()`
`IntellectualPropertyReview`	`getIntellectualPropertyReview()`
`String`	`getIpReviewActivityIndicator()`
`InstitutionalProposalScienceKeyword`	`getKeyword(int index)` It returns the ScienceKeyword object from keywords list
`List<InstitutionalProposalScienceKeyword>`	`getKeywords()` Gets the keywords attribute.
`protected org.kuali.rice.krad.service.BusinessObjectService`	`getKraBusinessObjectService()` This method returns a business object service
`Unit`	`getLeadUnit()`
`String`	`getLeadUnitName()` This method returns the lead unit's name, if it exists, otherwise returns an empty string.
`String`	`getLeadUnitNumber()` This method returns the lead unit's number, if it exists, otherwise returns an empty string.
`String`	`getLookupPersonNumber()`
`Unit`	`getLookupUnit()`
`String`	`getLookupUnitName()`
`String`	`getLookupUnitNumber()`
`String`	`getMailAccountNumber()`
`String`	`getMailBy()`
`String`	`getMailDescription()` Gets the mailDescription attribute.
`String`	`getMailType()`
`ProposalType`	`getNegotiableProposalType()` This method a proposal type if it is an institutional proposal or a proposal log.
`String`	`getNegotiableProposalTypeCode()` Get the proposal type code from this negotiable.
`String`	`getNewDescription()`
`NoticeOfOpportunity`	`getNoticeOfOpportunity()`
`String`	`getNoticeOfOpportunityCode()`
`String`	`getNsfCode()`
`NsfCode`	`getNsfCodeBo()`
`String`	`getNumberOfCopies()`
`String`	`getOpportunity()`
`KcPerson`	`getOspAdministrator()`
`Integer`	`getOwnerSequenceNumber()` This method returns its owner's sequence number.
`String`	`getPiEmployeeName()` This method returns the employee principle investigator's name, if it exists, otherwise returns an empty string.
`String`	`getPiName()` Returns the PI's name whether employee or non-employee.
`String`	`getPiNonEmployeeName()` This method returns the the non-employee (Rolodex) Principle Ivestigator's name, if it exists, otherwise returns an empty string.
`Sponsor`	`getPrimeSponsor()`
`String`	`getPrimeSponsorCode()` This method returns the prime sponsor's code, if it exists, otherwise returns an empty string.
`String`	`getPrimeSponsorName()` This method returns the prime sponsor's name, if it exists, otherwise returns an empty string.
`InstitutionalProposalPerson`	`getPrincipalInvestigator()`
`List<NegotiationPersonDTO>`	`getProjectPeople()` This method returns a list of KcPersons that include the PI, COI, and Key Personnel.
`List<InstitutionalProposalPerson>`	`getProjectPersons()` Gets the projectPersons attribute.
`List<InstitutionalProposalComment>`	`getProposalComments()`
`InstitutionalProposalCostShare`	`getProposalCostSharing()`
`Long`	`getProposalId()`
`ProposalIpReviewJoin`	`getProposalIpReviewJoin()`
`List<ProposalIpReviewJoin>`	`getProposalIpReviewJoins()`
`String`	`getProposalNumber()`
`InstitutionalProposalPersonCreditSplit`	`getProposalPerCreditSplit()`
`InstitutionalProposalScienceKeyword`	`getProposalScienceKeyword()`
`String`	`getProposalSequenceStatus()`
`ProposalStatus`	`getProposalStatus()`
`ProposalType`	`getProposalType()`
`Integer`	`getProposalTypeCode()`
`ProposalType`	`getProposalTypeFromCode()` This method lazy inits ProposalType
`ProposalUnitCreditSplit`	`getProposalUnitCreditSplit()`
`Date`	`getRequestedEndDateInitial()`
`Date`	`getRequestedEndDateTotal()`
`Date`	`getRequestedStartDateInitial()`
`Date`	`getRequestedStartDateTotal()`
`Rolodex`	`getRolodex()`
`Integer`	`getRolodexId()`
`String`	`getScienceCodeIndicator()`
`Integer`	`getSequenceNumber()` This gets the current version number.
`InstitutionalProposal`	`getSequenceOwner()` The SequenceOwner is returned; "this" should be returned if this associate is the sequence owner.
`boolean`	`getShowReturnLink()`
`InstitutionalProposalSpecialReview`	`getSpecialReview(int index)`
`String`	`getSpecialReviewIndicator()`
`List<InstitutionalProposalSpecialReview>`	`getSpecialReviews()` Gets the specialReviews attribute.
`Sponsor`	`getSponsor()` This method violates our policy of not calling a service in a getter.
`String`	`getSponsorAwardNumber()` This method returns the sponsor award number, if it exists, otherwise returns an empty string.
`String`	`getSponsorCode()` This method returns the sponsor's code, if it exists, otherwise returns an empty string.
`String`	`getSponsorName()` This method returns the sponsor's name, if it exists, otherwise returns an empty string.
`String`	`getSponsorProposalNumber()`
`Integer`	`getStatusCode()`
`String`	`getSubAwardOrganizationName()` This method returns the sub award organization name, if it exists, otherwise returns an empty string.
`String`	`getSubAwardRequisitionerId()` This method returns the Requisitioner's ID if it is a subaward, otherwise returns an empty string.
`String`	`getSubAwardRequisitionerName()` This method returns the Requisitioner's Name if it is a subaward, otherwise returns an empty string.
`String`	`getSubAwardRequisitionerUnitName()` This method returns the Requisitioner's Unit Name if it is a subaward, otherwise returns an empty string.
`String`	`getSubAwardRequisitionerUnitNumber()` This method returns the Requisitioner's Unit Number if it is a subaward, otherwise returns an empty string.
`boolean`	`getSubcontractFlag()`
`InstitutionalProposalComment`	`getSummaryComment()`
`String`	`getTitle()` This method returns the BO's title, if it exists, otherwise returns an empty string.
`org.kuali.rice.core.api.util.type.KualiDecimal`	`getTotalCost()` This method
`org.kuali.rice.core.api.util.type.KualiDecimal`	`getTotalCostShareAmount()` This method calls getTotalAmount to calculate the total of all Commitment Amounts.
`org.kuali.rice.core.api.util.type.KualiDecimal`	`getTotalDirectCostInitial()`
`org.kuali.rice.core.api.util.type.KualiDecimal`	`getTotalDirectCostTotal()`
`org.kuali.rice.core.api.util.type.KualiDecimal`	`getTotalIndirectCostInitial()`
`org.kuali.rice.core.api.util.type.KualiDecimal`	`getTotalIndirectCostTotal()`
`org.kuali.rice.core.api.util.type.KualiDecimal`	`getTotalInitialCost()` This method
`int`	`getTotalUnitCount()` This method returns the combined number of units for all project personnel.
`org.kuali.rice.core.api.util.type.KualiDecimal`	`getTotalUnrecoveredFandAAmount()` This method calls getTotalAmount to calculate the total of all Unrecovered FandAs.
`boolean`	`getTypeOfAccount()`
`String`	`getUnitNumber()` This method finds the lead unit number, if any
`UnitService`	`getUnitService()`
`InstitutionalProposalComment`	`getUnrecoveredFandAComment()`
`String`	`getVersionNameField()` For Award, this would be "awardNumber", for Committee "committeeName", for Protocol "protocolNumber", etc.
`void`	`incrementSequenceNumber()` This increments sequence number on an owner of a sequence.
`protected void`	`initializeCollections()`
`boolean`	`isActiveVersion()`
`boolean`	`isAllowUpdateTimestampToBeReset()`
`boolean`	`isCancelled()`
`boolean`	`isFundedByAward(String awardNumber, Integer awardSequence)` Is this Proposal funded by the given Award number and version?
`boolean`	`isSponsorNihMultiplePi()`
`protected void`	`postLoad()`
`protected void`	`postPersist()`
`void`	`remove(AwardFundingProposal afp)` This method removes an AwardFundingProposal Since Award "owns" the relationship, this method should not be called except from Award
`void`	`resetPersistenceState()` This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity.
`void`	`setActivityType(ActivityType activityType)`
`void`	`setActivityTypeCode(String activityTypeCode)`
`void`	`setAllowUpdateTimestampToBeReset(boolean allowUpdateTimestampToBeReset)` Setting this value to false will prevent the update timestamp field from being upddate just once.
`void`	`setAwardFundingProposals(List<AwardFundingProposal> awardFundingProposals)`
`void`	`setAwardType(AwardType awardType)`
`void`	`setAwardTypeCode(Integer awardTypeCode)`
`void`	`setCfdaNumber(String cfdaNumber)`
`void`	`setCostSharingIndicator(String costSharingIndicator)`
`void`	`setCreateTimeStamp(Date createTimeStamp)` Sets the createTimeStamp attribute value.
`void`	`setCurrentAccountNumber(String currentAccountNumber)`
`void`	`setCurrentAwardNumber(String currentAwardNumber)`
`void`	`setDeadlineDate(Date deadlineDate)`
`void`	`setDeadlineTime(String deadlineTime)`
`void`	`setDeadlineType(String deadlineType)`
`void`	`setDefaultInitialContractAdmin()`
`void`	`setFiscalMonth(String fiscalMonth)` Sets the fiscalMonth attribute value.
`void`	`setFiscalYear(String fiscalYear)` Sets the fiscalYear attribute value.
`void`	`setGradStudHeadcount(Integer gradStudHeadcount)`
`void`	`setGradStudPersonMonths(org.kuali.rice.core.api.util.type.KualiDecimal gradStudPersonMonths)`
`void`	`setIdcRateIndicator(String idcRateIndicator)`
`void`	`setInitialContractAdmin(String initialContractAdmin)`
`void`	`setInstitutionalProposalCostShares(List<InstitutionalProposalCostShare> institutionalProposalCostShares)` Sets the institutionalProposalCostShares attribute value.
`void`	`setInstitutionalProposalCustomDataList(List<InstitutionalProposalCustomData> institutionalProposalCustomDataList)` Sets the institutionalProposalCustomDataList attribute value.
`void`	`setInstitutionalProposalDocument(InstitutionalProposalDocument institutionalProposalDocument)` Sets the institutionalProposalDocument attribute value.
`void`	`setInstitutionalProposalNotepads(List<InstitutionalProposalNotepad> institutionalProposalNotepads)` Sets the institutionalProposalNotepads attribute value.
`void`	`setInstitutionalProposalScienceKeywords(List<InstitutionalProposalScienceKeyword> institutionalProposalScienceKeywords)` Sets the institutionalProposalScienceKeywords attribute value.
`void`	`setInstitutionalProposalUnitContacts(List<InstitutionalProposalUnitContact> institutionalProposalUnitContacts)`
`void`	`setInstitutionalProposalUnrecoveredFandAs(List<InstitutionalProposalUnrecoveredFandA> institutionalProposalUnrecoveredFandAs)` Sets the institutionalProposalUnrecoveredFandAs attribute value.
`void`	`setInstProposalNumber(String instProposalNumber)`
`void`	`setIntellectualPropertyReview(IntellectualPropertyReview intellectualPropertyReview)`
`void`	`setIpReviewActivityIndicator(String ipReviewActivityIndicator)`
`void`	`setKeywords(List<InstitutionalProposalScienceKeyword> institutionalProposalScienceKeywords)` Sets the keywords attribute value.
`void`	`setLeadUnit(Unit leadUnit)` Sets the leadUnit attribute value.
`void`	`setLeadUnitNumber(String unitNumber)` This method...
`void`	`setLookupPersonNumber(String lookupPersonNumber)`
`void`	`setLookupUnit(Unit lookupUnit)`
`void`	`setLookupUnitName(String lookupUnitName)`
`void`	`setLookupUnitNumber(String lookupUnitNumber)`
`void`	`setMailAccountNumber(String mailAccountNumber)`
`void`	`setMailBy(String mailBy)`
`void`	`setMailDescription(String mailDescription)` Sets the mailDescription attribute value.
`void`	`setMailType(String mailType)`
`void`	`setNewDescription(String newDescription)`
`void`	`setNoticeOfOpportunity(NoticeOfOpportunity noticeOfOpportunity)`
`void`	`setNoticeOfOpportunityCode(String noticeOfOpportunityCode)`
`void`	`setNsfCode(String nsfCode)`
`void`	`setNsfCodeBo(NsfCode nsfCodeBo)`
`void`	`setNumberOfCopies(String numberOfCopies)`
`void`	`setOpportunity(String opportunity)`
`void`	`setPrimeSponsor(Sponsor primeSponsor)`
`void`	`setPrimeSponsorCode(String primeSponsorCode)`
`void`	`setPrincipalInvestigator(InstitutionalProposalPerson proposalPerson)`
`void`	`setProjectPersons(List<InstitutionalProposalPerson> projectPersons)` Sets the projectPersons attribute value.
`void`	`setProposalComments(List<InstitutionalProposalComment> proposalComments)`
`void`	`setProposalCostSharing(InstitutionalProposalCostShare proposalCostSharing)`
`void`	`setProposalId(Long proposalId)`
`void`	`setProposalIpReviewJoin(ProposalIpReviewJoin proposalIpReviewJoin)`
`void`	`setProposalIpReviewJoins(List<ProposalIpReviewJoin> proposalIpReviewJoins)`
`void`	`setProposalNumber(String proposalNumber)`
`void`	`setProposalPerCreditSplit(InstitutionalProposalPersonCreditSplit proposalPerCreditSplit)`
`void`	`setProposalScienceKeyword(InstitutionalProposalScienceKeyword proposalScienceKeyword)`
`void`	`setProposalSequenceStatus(String proposalSequenceStatus)`
`void`	`setProposalStatus(ProposalStatus proposalStatus)`
`void`	`setProposalType(ProposalType proposalType)`
`void`	`setProposalTypeCode(Integer proposalTypeCode)`
`void`	`setProposalUnitCreditSplit(ProposalUnitCreditSplit proposalUnitCreditSplit)`
`void`	`setRequestedEndDateInitial(Date requestedEndDateInitial)`
`void`	`setRequestedEndDateTotal(Date requestedEndDateTotal)`
`void`	`setRequestedStartDateInitial(Date requestedStartDateInitial)`
`void`	`setRequestedStartDateTotal(Date requestedStartDateTotal)`
`void`	`setRolodex(Rolodex rolodex)`
`void`	`setRolodexId(Integer rolodexId)`
`void`	`setScienceCodeIndicator(String scienceCodeIndicator)`
`void`	`setSequenceNumber(Integer sequenceNumber)`
`void`	`setSequenceOwner(InstitutionalProposal newOwner)` This sets the sequence owner on the associate.
`void`	`setShowReturnLink(boolean val)`
`void`	`setSpecialReviewIndicator(String specialReviewIndicator)`
`void`	`setSpecialReviews(List<InstitutionalProposalSpecialReview> specialReviews)` Sets the specialReviews attribute value.
`void`	`setSponsor(Sponsor sponsor)`
`void`	`setSponsorCode(String sponsorCode)`
`void`	`setSponsorNihMultiplePi(boolean sponsorNihMultiplePi)`
`void`	`setSponsorProposalNumber(String sponsorProposalNumber)`
`void`	`setStatusCode(Integer statusCode)`
`void`	`setSubcontractFlag(boolean subcontractFlag)`
`void`	`setTitle(String title)`
`void`	`setTotalDirectCostInitial(org.kuali.rice.core.api.util.type.KualiDecimal totalDirectCostInitial)`
`void`	`setTotalDirectCostTotal(org.kuali.rice.core.api.util.type.KualiDecimal totalDirectCostTotal)`
`void`	`setTotalIndirectCostInitial(org.kuali.rice.core.api.util.type.KualiDecimal totalIndirectCostInitial)`
`void`	`setTotalIndirectCostTotal(org.kuali.rice.core.api.util.type.KualiDecimal totalIndirectCostTotal)`
`void`	`setTypeOfAccount(boolean typeOfAccount)`
`void`	`setUnitNumber(String unitNumber)` Sets the unitNumber attribute value.
`void`	`setUpdateTimestamp(Timestamp updateTimestamp)`
`protected void`	`updateProposalIpReviewJoin()`

Methods inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase
getAuthorPersonName, getKcPersonService, getUpdateTimestamp, getUpdateUser, isUpdateUserSet, prePersist, preUpdate, 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, 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.krad.bo.PersistableBusinessObject
buildListOfDeletionAwareLists, getExtension, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject
refresh

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

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned
getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique
getObjectId

- Field Detail
  - PROPOSAL_ID_PROPERTY_STRING
```
public static final String PROPOSAL_ID_PROPERTY_STRING
```
    See Also:
    Constant Field Values
  - PROPOSAL_NUMBER_PROPERTY_STRING
```
public static final String PROPOSAL_NUMBER_PROPERTY_STRING
```
    See Also:
    Constant Field Values
  - PROPOSAL_SEQUENCE_STATUS_PROPERTY_STRING
```
public static final String PROPOSAL_SEQUENCE_STATUS_PROPERTY_STRING
```
    See Also:
    Constant Field Values
  - PROPOSAL_NUMBER_TEST_DEFAULT_STRING
```
public static final String PROPOSAL_NUMBER_TEST_DEFAULT_STRING
```
    See Also:
    Constant Field Values
- Constructor Detail
  - InstitutionalProposal
```
public InstitutionalProposal()
```
- Method Detail
  - initializeCollections
```
protected void initializeCollections()
```
  - setDefaultInitialContractAdmin
```
public void setDefaultInitialContractAdmin()
```
  - deactivateFundingProposals
```
public void deactivateFundingProposals()
```
  - activateFundingProposals
```
public void activateFundingProposals()
```
  - isActiveVersion
```
public boolean isActiveVersion()
```
  - isCancelled
```
public boolean isCancelled()
```
  - isFundedByAward
```
public boolean isFundedByAward(String awardNumber,
                      Integer awardSequence)
```
    Is this Proposal funded by the given Award number and version?
    
    Parameters:
    awardNumber - String
    awardSequence - Integer
    
    Returns:
    boolean
  - getKraBusinessObjectService
```
protected org.kuali.rice.krad.service.BusinessObjectService getKraBusinessObjectService()
```
    This method returns a business object service
    
    Returns:
  - getInstitutionalProposalDocument
```
public InstitutionalProposalDocument getInstitutionalProposalDocument()
```
    Gets the institutionalProposalDocument attribute.
    
    Returns:
    Returns the institutionalProposalDocument.
  - setInstitutionalProposalDocument
```
public void setInstitutionalProposalDocument(InstitutionalProposalDocument institutionalProposalDocument)
```
    Sets the institutionalProposalDocument attribute value.
    
    Parameters:
    institutionalProposalDocument - The institutionalProposalDocument to set.
  - add
```
public void add(AwardFundingProposal afp)
```
    Add an AwardFundingProposal The Award "owns" the relationship, so this method should not be called directly. Instead, this method will be called when an InstitutionalProposal is linked to an Award from Award maintenance.
    
    Parameters:
    afp -
  - add
```
public void add(InstitutionalProposalNotepad institutionalProposalNotepad)
```
    This method...
    
    Parameters:
    institutionaProposalNotepad -
  - add
```
public void add(InstitutionalProposalCostShare institutionalProposalCostShare)
```
    This method...
    
    Parameters:
    institutionalProposalCostShare -
  - add
```
public void add(InstitutionalProposalUnrecoveredFandA institutionalProposalUnrecoveredFandA)
```
    This method...
    
    Parameters:
    institutionalProposalUnrecoveredFandA -
  - getTotalInitialCost
```
public org.kuali.rice.core.api.util.type.KualiDecimal getTotalInitialCost()
```
    This method
    
    Returns:
  - getTotalCost
```
public org.kuali.rice.core.api.util.type.KualiDecimal getTotalCost()
```
    This method
    
    Returns:
  - getTotalCostShareAmount
```
public org.kuali.rice.core.api.util.type.KualiDecimal getTotalCostShareAmount()
```
    This method calls getTotalAmount to calculate the total of all Commitment Amounts.
    
    Returns:
  - getTotalUnrecoveredFandAAmount
```
public org.kuali.rice.core.api.util.type.KualiDecimal getTotalUnrecoveredFandAAmount()
```
    This method calls getTotalAmount to calculate the total of all Unrecovered FandAs.
    
    Returns:
  - getSpecialReviews
```
public List<InstitutionalProposalSpecialReview> getSpecialReviews()
```
    Gets the specialReviews attribute.
    
    Returns:
    Returns the specialReviews.
  - setSpecialReviews
```
public void setSpecialReviews(List<InstitutionalProposalSpecialReview> specialReviews)
```
    Sets the specialReviews attribute value.
    
    Parameters:
    specialReviews - The specialReviews to set.
  - getInstitutionalProposalCustomDataList
```
public List<InstitutionalProposalCustomData> getInstitutionalProposalCustomDataList()
```
    Gets the institutionalProposalCustomDataList attribute.
    
    Returns:
    Returns the institutionalProposalCustomDataList.
  - getInstitutionalProposalNotepads
```
public List<InstitutionalProposalNotepad> getInstitutionalProposalNotepads()
```
    Gets the institutionalProposalNotepads attribute.
    
    Returns:
    Returns the institutionalProposalNotepads.
  - setInstitutionalProposalNotepads
```
public void setInstitutionalProposalNotepads(List<InstitutionalProposalNotepad> institutionalProposalNotepads)
```
    Sets the institutionalProposalNotepads attribute value.
    
    Parameters:
    institutionalProposalNotepads - The institutionalProposalNotepads to set.
  - setInstitutionalProposalCustomDataList
```
public void setInstitutionalProposalCustomDataList(List<InstitutionalProposalCustomData> institutionalProposalCustomDataList)
```
    Sets the institutionalProposalCustomDataList attribute value.
    
    Parameters:
    institutionalProposalCustomDataList - The institutionalProposalCustomDataList to set.
  - getInstitutionalProposalScienceKeywords
```
public List<InstitutionalProposalScienceKeyword> getInstitutionalProposalScienceKeywords()
```
    Gets the institutionalProposalScienceKeywords attribute.
    
    Returns:
    Returns the institutionalProposalScienceKeywords.
  - setInstitutionalProposalScienceKeywords
```
public void setInstitutionalProposalScienceKeywords(List<InstitutionalProposalScienceKeyword> institutionalProposalScienceKeywords)
```
    Sets the institutionalProposalScienceKeywords attribute value.
    
    Parameters:
    institutionalProposalScienceKeywords - The institutionalProposalScienceKeywords to set.
  - add
```
public void add(InstitutionalProposalPerson projectPerson)
```
    This method adds a Project Person to the institutionalProposal
    
    Parameters:
    projectPerson -
  - add
```
public void add(InstitutionalProposalUnitContact institutionalProposalUnitContact)
```
    Add an Institutional Proposal Unit or Central Administration contact
    
    Parameters:
    awardUnitContact -
  - getOspAdministrator
```
public KcPerson getOspAdministrator()
```
    Returns:
  - setInstitutionalProposalUnitContacts
```
public void setInstitutionalProposalUnitContacts(List<InstitutionalProposalUnitContact> institutionalProposalUnitContacts)
```
    Parameters:
    institutionalProposalUnitContacts -
  - getInstitutionalProposalUnitContacts
```
public List<InstitutionalProposalUnitContact> getInstitutionalProposalUnitContacts()
```
    Returns:
  - getInstitutionalProposalContactsCount
```
public int getInstitutionalProposalContactsCount()
```
    Returns:
  - getProposalId
```
public Long getProposalId()
```
  - setProposalId
```
public void setProposalId(Long proposalId)
```
  - getProposalNumber
```
public String getProposalNumber()
```
  - setProposalNumber
```
public void setProposalNumber(String proposalNumber)
```
  - getSponsorProposalNumber
```
public String getSponsorProposalNumber()
```
  - setSponsorProposalNumber
```
public void setSponsorProposalNumber(String sponsorProposalNumber)
```
  - getSequenceNumber
```
public Integer getSequenceNumber()
```
    Description copied from interface: Sequenceable
    
    This gets the current version number.
    
    Specified by:
    
    getSequenceNumber in interface Sequenceable
    
    Returns:
    the sequence number
  - setSequenceNumber
```
public void setSequenceNumber(Integer sequenceNumber)
```
  - getProposalTypeCode
```
public Integer getProposalTypeCode()
```
  - setProposalTypeCode
```
public void setProposalTypeCode(Integer proposalTypeCode)
```
  - getCurrentAccountNumber
```
public String getCurrentAccountNumber()
```
  - setCurrentAccountNumber
```
public void setCurrentAccountNumber(String currentAccountNumber)
```
  - getTitle
```
public String getTitle()
```
    Description copied from interface: Negotiable
    
    This method returns the BO's title, if it exists, otherwise returns an empty string.
    
    Specified by:
    
    getTitle in interface Negotiable
    
    Returns:
  - setTitle
```
public void setTitle(String title)
```
  - getSponsorCode
```
public String getSponsorCode()
```
    Description copied from interface: Negotiable
    
    This method returns the sponsor's code, if it exists, otherwise returns an empty string.
    
    Specified by:
    
    getSponsorCode in interface Negotiable
    
    Specified by:
    
    getSponsorCode in interface Sponsorable
    
    Returns:
  - setSponsorCode
```
public void setSponsorCode(String sponsorCode)
```
    Specified by:
    
    setSponsorCode in interface Sponsorable
  - getRolodexId
```
public Integer getRolodexId()
```
  - setRolodexId
```
public void setRolodexId(Integer rolodexId)
```
  - getNoticeOfOpportunityCode
```
public String getNoticeOfOpportunityCode()
```
  - setNoticeOfOpportunityCode
```
public void setNoticeOfOpportunityCode(String noticeOfOpportunityCode)
```
  - getGradStudHeadcount
```
public Integer getGradStudHeadcount()
```
  - setGradStudHeadcount
```
public void setGradStudHeadcount(Integer gradStudHeadcount)
```
  - getGradStudPersonMonths
```
public org.kuali.rice.core.api.util.type.KualiDecimal getGradStudPersonMonths()
```
  - setGradStudPersonMonths
```
public void setGradStudPersonMonths(org.kuali.rice.core.api.util.type.KualiDecimal gradStudPersonMonths)
```
  - getTypeOfAccount
```
public boolean getTypeOfAccount()
```
  - setTypeOfAccount
```
public void setTypeOfAccount(boolean typeOfAccount)
```
  - getActivityTypeCode
```
public String getActivityTypeCode()
```
  - setActivityTypeCode
```
public void setActivityTypeCode(String activityTypeCode)
```
  - setLeadUnit
```
public void setLeadUnit(Unit leadUnit)
```
    Sets the leadUnit attribute value.
    
    Parameters:
    leadUnit - The leadUnit to set.
  - getRequestedStartDateInitial
```
public Date getRequestedStartDateInitial()
```
  - setRequestedStartDateInitial
```
public void setRequestedStartDateInitial(Date requestedStartDateInitial)
```
  - getRequestedStartDateTotal
```
public Date getRequestedStartDateTotal()
```
  - setRequestedStartDateTotal
```
public void setRequestedStartDateTotal(Date requestedStartDateTotal)
```
  - getRequestedEndDateInitial
```
public Date getRequestedEndDateInitial()
```
  - setRequestedEndDateInitial
```
public void setRequestedEndDateInitial(Date requestedEndDateInitial)
```
  - getRequestedEndDateTotal
```
public Date getRequestedEndDateTotal()
```
  - setRequestedEndDateTotal
```
public void setRequestedEndDateTotal(Date requestedEndDateTotal)
```
  - getTotalDirectCostInitial
```
public org.kuali.rice.core.api.util.type.KualiDecimal getTotalDirectCostInitial()
```
  - setTotalDirectCostInitial
```
public void setTotalDirectCostInitial(org.kuali.rice.core.api.util.type.KualiDecimal totalDirectCostInitial)
```
  - getTotalDirectCostTotal
```
public org.kuali.rice.core.api.util.type.KualiDecimal getTotalDirectCostTotal()
```
  - setTotalDirectCostTotal
```
public void setTotalDirectCostTotal(org.kuali.rice.core.api.util.type.KualiDecimal totalDirectCostTotal)
```
  - getTotalIndirectCostInitial
```
public org.kuali.rice.core.api.util.type.KualiDecimal getTotalIndirectCostInitial()
```
  - setTotalIndirectCostInitial
```
public void setTotalIndirectCostInitial(org.kuali.rice.core.api.util.type.KualiDecimal totalIndirectCostInitial)
```
  - getTotalIndirectCostTotal
```
public org.kuali.rice.core.api.util.type.KualiDecimal getTotalIndirectCostTotal()
```
  - setTotalIndirectCostTotal
```
public void setTotalIndirectCostTotal(org.kuali.rice.core.api.util.type.KualiDecimal totalIndirectCostTotal)
```
  - getNumberOfCopies
```
public String getNumberOfCopies()
```
  - setNumberOfCopies
```
public void setNumberOfCopies(String numberOfCopies)
```
  - getDeadlineDate
```
public Date getDeadlineDate()
```
  - setDeadlineDate
```
public void setDeadlineDate(Date deadlineDate)
```
  - getDeadlineTime
```
public String getDeadlineTime()
```
  - setDeadlineTime
```
public void setDeadlineTime(String deadlineTime)
```
  - getDeadlineType
```
public String getDeadlineType()
```
  - setDeadlineType
```
public void setDeadlineType(String deadlineType)
```
  - getMailBy
```
public String getMailBy()
```
  - setMailBy
```
public void setMailBy(String mailBy)
```
  - getMailType
```
public String getMailType()
```
  - setMailType
```
public void setMailType(String mailType)
```
  - getLeadUnit
```
public Unit getLeadUnit()
```
  - getMailAccountNumber
```
public String getMailAccountNumber()
```
  - setMailAccountNumber
```
public void setMailAccountNumber(String mailAccountNumber)
```
  - getMailDescription
```
public String getMailDescription()
```
    Gets the mailDescription attribute.
    
    Returns:
    Returns the mailDescription.
  - setMailDescription
```
public void setMailDescription(String mailDescription)
```
    Sets the mailDescription attribute value.
    
    Parameters:
    mailDescription - The mailDescription to set.
  - getSubcontractFlag
```
public boolean getSubcontractFlag()
```
  - setSubcontractFlag
```
public void setSubcontractFlag(boolean subcontractFlag)
```
  - getCostSharingIndicator
```
public String getCostSharingIndicator()
```
  - setCostSharingIndicator
```
public void setCostSharingIndicator(String costSharingIndicator)
```
  - getIdcRateIndicator
```
public String getIdcRateIndicator()
```
  - setIdcRateIndicator
```
public void setIdcRateIndicator(String idcRateIndicator)
```
  - getSpecialReviewIndicator
```
public String getSpecialReviewIndicator()
```
  - setSpecialReviewIndicator
```
public void setSpecialReviewIndicator(String specialReviewIndicator)
```
  - getStatusCode
```
public Integer getStatusCode()
```
  - setStatusCode
```
public void setStatusCode(Integer statusCode)
```
  - getScienceCodeIndicator
```
public String getScienceCodeIndicator()
```
  - setScienceCodeIndicator
```
public void setScienceCodeIndicator(String scienceCodeIndicator)
```
  - getNsfCode
```
public String getNsfCode()
```
  - setNsfCode
```
public void setNsfCode(String nsfCode)
```
  - getPrimeSponsorCode
```
public String getPrimeSponsorCode()
```
    Description copied from interface: Negotiable
    
    This method returns the prime sponsor's code, if it exists, otherwise returns an empty string.
    
    Specified by:
    
    getPrimeSponsorCode in interface Negotiable
    
    Returns:
  - setPrimeSponsorCode
```
public void setPrimeSponsorCode(String primeSponsorCode)
```
  - getInitialContractAdmin
```
public String getInitialContractAdmin()
```
  - setInitialContractAdmin
```
public void setInitialContractAdmin(String initialContractAdmin)
```
  - getIpReviewActivityIndicator
```
public String getIpReviewActivityIndicator()
```
  - setIpReviewActivityIndicator
```
public void setIpReviewActivityIndicator(String ipReviewActivityIndicator)
```
  - getCurrentAwardNumber
```
public String getCurrentAwardNumber()
```
  - setCurrentAwardNumber
```
public void setCurrentAwardNumber(String currentAwardNumber)
```
  - getCfdaNumber
```
public String getCfdaNumber()
```
  - setCfdaNumber
```
public void setCfdaNumber(String cfdaNumber)
```
  - getOpportunity
```
public String getOpportunity()
```
  - setOpportunity
```
public void setOpportunity(String opportunity)
```
  - getAwardTypeCode
```
public Integer getAwardTypeCode()
```
  - setAwardTypeCode
```
public void setAwardTypeCode(Integer awardTypeCode)
```
  - getProposalStatus
```
public ProposalStatus getProposalStatus()
```
  - setProposalStatus
```
public void setProposalStatus(ProposalStatus proposalStatus)
```
  - getNoticeOfOpportunity
```
public NoticeOfOpportunity getNoticeOfOpportunity()
```
  - setNoticeOfOpportunity
```
public void setNoticeOfOpportunity(NoticeOfOpportunity noticeOfOpportunity)
```
  - getProposalType
```
public ProposalType getProposalType()
```
  - setProposalType
```
public void setProposalType(ProposalType proposalType)
```
  - getRolodex
```
public Rolodex getRolodex()
```
  - setRolodex
```
public void setRolodex(Rolodex rolodex)
```
  - getSponsor
```
public Sponsor getSponsor()
```
    This method violates our policy of not calling a service in a getter. This will only call the service once to set a sponsor when a sponsor code exists, but no sponsor was fetched Seems like a persistence design issue to me. Why wouldn't Sponsor:Award be a 1:M relationship handled automagically by the persistence framework?
    
    Returns:
  - setSponsor
```
public void setSponsor(Sponsor sponsor)
```
  - getPrimeSponsor
```
public Sponsor getPrimeSponsor()
```
  - setPrimeSponsor
```
public void setPrimeSponsor(Sponsor primeSponsor)
```
  - getPrincipalInvestigator
```
public InstitutionalProposalPerson getPrincipalInvestigator()
```
  - setPrincipalInvestigator
```
public void setPrincipalInvestigator(InstitutionalProposalPerson proposalPerson)
```
  - getSponsorName
```
public String getSponsorName()
```
    Description copied from interface: Negotiable
    
    This method returns the sponsor's name, if it exists, otherwise returns an empty string.
    
    Specified by:
    
    getSponsorName in interface Negotiable
    
    Returns:
  - getActivityType
```
public ActivityType getActivityType()
```
  - setActivityType
```
public void setActivityType(ActivityType activityType)
```
  - getAwardType
```
public AwardType getAwardType()
```
  - getAwardFundingProposals
```
public List<AwardFundingProposal> getAwardFundingProposals()
```
    Returns:
    Returns the awards.
  - getAwardFundingProposal
```
public AwardFundingProposal getAwardFundingProposal(int index)
```
  - getAwardFundingProposalsExist
```
public boolean getAwardFundingProposalsExist()
```
  - getActiveAwardFundingProposals
```
public List<AwardFundingProposal> getActiveAwardFundingProposals()
```
    Get the list of only Active AwardFundingProposals.
    
    Returns:
    List the list.
  - setAwardType
```
public void setAwardType(AwardType awardType)
```
  - getFiscalMonth
```
public String getFiscalMonth()
```
    Gets the fiscalMonth attribute.
    
    Returns:
    Returns the fiscalMonth.
  - setFiscalMonth
```
public void setFiscalMonth(String fiscalMonth)
```
    Sets the fiscalMonth attribute value.
    
    Parameters:
    fiscalMonth - The fiscalMonth to set.
  - getFiscalYear
```
public String getFiscalYear()
```
    Gets the fiscalYear attribute.
    
    Returns:
    Returns the fiscalYear.
  - setFiscalYear
```
public void setFiscalYear(String fiscalYear)
```
    Sets the fiscalYear attribute value.
    
    Parameters:
    fiscalYear - The fiscalYear to set.
  - getUnitNumber
```
public String getUnitNumber()
```
    This method finds the lead unit number, if any
    
    Returns:
  - setUnitNumber
```
public void setUnitNumber(String unitNumber)
```
    Sets the unitNumber attribute value.
    
    Parameters:
    unitNumber - The unitNumber to set.
  - getLeadUnitNumber
```
public String getLeadUnitNumber()
```
    Description copied from interface: Negotiable
    
    This method returns the lead unit's number, if it exists, otherwise returns an empty string.
    
    Specified by:
    
    getLeadUnitNumber in interface Negotiable
    
    Returns:
  - setLeadUnitNumber
```
public void setLeadUnitNumber(String unitNumber)
```
    This method...
    
    Parameters:
    unitNumber -
  - setAwardFundingProposals
```
public void setAwardFundingProposals(List<AwardFundingProposal> awardFundingProposals)
```
    Parameters:
    awards - The awards to set.
  - getProposalScienceKeyword
```
public InstitutionalProposalScienceKeyword getProposalScienceKeyword()
```
  - setProposalScienceKeyword
```
public void setProposalScienceKeyword(InstitutionalProposalScienceKeyword proposalScienceKeyword)
```
  - getProposalCostSharing
```
public InstitutionalProposalCostShare getProposalCostSharing()
```
  - setProposalCostSharing
```
public void setProposalCostSharing(InstitutionalProposalCostShare proposalCostSharing)
```
  - getProjectPersons
```
public List<InstitutionalProposalPerson> getProjectPersons()
```
    Gets the projectPersons attribute.
    
    Returns:
    Returns the projectPersons.
  - setProjectPersons
```
public void setProjectPersons(List<InstitutionalProposalPerson> projectPersons)
```
    Sets the projectPersons attribute value.
    
    Parameters:
    projectPersons - The projectPersons to set.
  - getProposalPerCreditSplit
```
public InstitutionalProposalPersonCreditSplit getProposalPerCreditSplit()
```
  - setProposalPerCreditSplit
```
public void setProposalPerCreditSplit(InstitutionalProposalPersonCreditSplit proposalPerCreditSplit)
```
  - getProposalUnitCreditSplit
```
public ProposalUnitCreditSplit getProposalUnitCreditSplit()
```
  - setProposalUnitCreditSplit
```
public void setProposalUnitCreditSplit(ProposalUnitCreditSplit proposalUnitCreditSplit)
```
  - getProposalComments
```
public List<InstitutionalProposalComment> getProposalComments()
```
  - setProposalComments
```
public void setProposalComments(List<InstitutionalProposalComment> proposalComments)
```
  - getIntellectualPropertyReview
```
public IntellectualPropertyReview getIntellectualPropertyReview()
```
  - setIntellectualPropertyReview
```
public void setIntellectualPropertyReview(IntellectualPropertyReview intellectualPropertyReview)
```
  - getProposalIpReviewJoins
```
public List<ProposalIpReviewJoin> getProposalIpReviewJoins()
```
  - setProposalIpReviewJoins
```
public void setProposalIpReviewJoins(List<ProposalIpReviewJoin> proposalIpReviewJoins)
```
  - getProposalIpReviewJoin
```
public ProposalIpReviewJoin getProposalIpReviewJoin()
```
  - setProposalIpReviewJoin
```
public void setProposalIpReviewJoin(ProposalIpReviewJoin proposalIpReviewJoin)
```
  - getInstitutionalProposalCostShares
```
public List<InstitutionalProposalCostShare> getInstitutionalProposalCostShares()
```
    Gets the institutionalProposalCostShares attribute.
    
    Returns:
    Returns the institutionalProposalCostShares.
  - setInstitutionalProposalCostShares
```
public void setInstitutionalProposalCostShares(List<InstitutionalProposalCostShare> institutionalProposalCostShares)
```
    Sets the institutionalProposalCostShares attribute value.
    
    Parameters:
    institutionalProposalCostShares - The institutionalProposalCostShares to set.
  - getInstitutionalProposalUnrecoveredFandAs
```
public List<InstitutionalProposalUnrecoveredFandA> getInstitutionalProposalUnrecoveredFandAs()
```
    Gets the institutionalProposalUnrecoveredFandAs attribute.
    
    Returns:
    Returns the institutionalProposalUnrecoveredFandAs.
  - setInstitutionalProposalUnrecoveredFandAs
```
public void setInstitutionalProposalUnrecoveredFandAs(List<InstitutionalProposalUnrecoveredFandA> institutionalProposalUnrecoveredFandAs)
```
    Sets the institutionalProposalUnrecoveredFandAs attribute value.
    
    Parameters:
    institutionalProposalUnrecoveredFandAs - The institutionalProposalUnrecoveredFandAs to set.
  - getCreateTimeStamp
```
public Date getCreateTimeStamp()
```
    Gets the createTimeStamp attribute.
    
    Returns:
    Returns the createTimeStamp.
  - setCreateTimeStamp
```
public void setCreateTimeStamp(Date createTimeStamp)
```
    Sets the createTimeStamp attribute value.
    
    Parameters:
    createTimeStamp - The createTimeStamp to set.
  - getDefaultNewDescription
```
public String getDefaultNewDescription()
```
  - getNewDescription
```
public String getNewDescription()
```
  - setNewDescription
```
public void setNewDescription(String newDescription)
```
  - getProposalSequenceStatus
```
public String getProposalSequenceStatus()
```
  - setProposalSequenceStatus
```
public void setProposalSequenceStatus(String proposalSequenceStatus)
```
  - addSpecialReview
```
public void addSpecialReview(InstitutionalProposalSpecialReview specialReview)
```
  - getSpecialReview
```
public InstitutionalProposalSpecialReview getSpecialReview(int index)
```
  - getKeywords
```
public List<InstitutionalProposalScienceKeyword> getKeywords()
```
    Gets the keywords attribute.
    
    Specified by:
    
    getKeywords in interface KeywordsManager<InstitutionalProposalScienceKeyword>
    
    Returns:
    Returns the keywords.
  - setKeywords
```
public void setKeywords(List<InstitutionalProposalScienceKeyword> institutionalProposalScienceKeywords)
```
    Sets the keywords attribute value.
    
    Parameters:
    keywords - The keywords to set.
  - addKeyword
```
public void addKeyword(ScienceKeyword scienceKeyword)
```
    Add selected science keyword to award science keywords list.
    
    Specified by:
    
    addKeyword in interface KeywordsManager<InstitutionalProposalScienceKeyword>
    
    See Also:
    KeywordsManager.addKeyword(org.kuali.kra.bo.ScienceKeyword)
  - getKeyword
```
public InstitutionalProposalScienceKeyword getKeyword(int index)
```
    It returns the ScienceKeyword object from keywords list
    
    Specified by:
    
    getKeyword in interface KeywordsManager<InstitutionalProposalScienceKeyword>
    
    Returns:
    See Also:
    KeywordsManager.getKeyword(int)
  - getOwnerSequenceNumber
```
public Integer getOwnerSequenceNumber()
```
    Description copied from interface: SequenceOwner
    
    This method returns its owner's sequence number. If this is the top level owner; i.e. Protocol or Award, it should return null
    
    Specified by:
    
    getOwnerSequenceNumber in interface SequenceOwner<InstitutionalProposal>
    
    Returns:
    the owner's sequence number
    See Also:
    SequenceOwner.getOwnerSequenceNumber()
  - incrementSequenceNumber
```
public void incrementSequenceNumber()
```
    Description copied from interface: SequenceOwner
    
    This increments sequence number on an owner of a sequence.
    
    Specified by:
    
    incrementSequenceNumber in interface SequenceOwner<InstitutionalProposal>
    
    See Also:
    SequenceOwner.incrementSequenceNumber()
  - getSequenceOwner
```
public InstitutionalProposal getSequenceOwner()
```
    Description copied from interface: SequenceAssociate
    
    The SequenceOwner is returned; "this" should be returned if this associate is the sequence owner.
    
    Specified by:
    
    getSequenceOwner in interface SequenceAssociate<InstitutionalProposal>
    
    Returns:
    the SequenceOwner
    See Also:
    SequenceAssociate.getSequenceOwner()
  - setSequenceOwner
```
public void setSequenceOwner(InstitutionalProposal newOwner)
```
    Description copied from interface: SequenceAssociate
    
    This sets the sequence owner on the associate. Should no-op if this associate has no sequence owner
    
    Specified by:
    
    setSequenceOwner in interface SequenceAssociate<InstitutionalProposal>
    
    See Also:
    SequenceAssociate.setSequenceOwner(org.kuali.kra.SequenceOwner)
  - remove
```
public void remove(AwardFundingProposal afp)
```
    This method removes an AwardFundingProposal Since Award "owns" the relationship, this method should not be called except from Award
    
    Parameters:
    afp -
  - resetPersistenceState
```
public void resetPersistenceState()
```
    Description copied from interface: Sequenceable
    
    This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity. During sequencing, the VersioningService needs to be able to signal that a Sequenceable has changed state from an persisted entity to a new, unpersisted one. Otherwise, versioning operations would result earlier SequenceOwners losing the association with older versions of associates. This behavior comes into play whenever an associated object is versioned. Typically, implementers will set primary key fields to null to trigger an INSERT during save.
    
    Specified by:
    
    resetPersistenceState in interface Sequenceable
    
    See Also:
    Sequenceable.resetPersistenceState()
  - getVersionNameField
```
public String getVersionNameField()
```
    Description copied from interface: SequenceOwner
    
    For Award, this would be "awardNumber", for Committee "committeeName", for Protocol "protocolNumber", etc.
    
    Specified by:
    
    getVersionNameField in interface SequenceOwner<InstitutionalProposal>
    
    Returns:
    the field name that versions are "grouped" by
    See Also:
    org.kuali.kra.SequenceOwner#getName()
  - postPersist
```
protected void postPersist()
```
    Description copied from class: KraPersistableBusinessObjectBase
    
    Overrides:
    
    postPersist in class KraPersistableBusinessObjectBase
    
    See Also:
    org.kuali.core.bo.PersistableBusinessObjectBase#beforeInsert()
  - postLoad
```
protected void postLoad()
```
    Overrides:
    
    postLoad in class org.kuali.rice.krad.bo.PersistableBusinessObjectBase
    
    See Also:
    org.kuali.core.bo.PersistableBusinessObjectBase#afterLookup()
  - updateProposalIpReviewJoin
```
protected void updateProposalIpReviewJoin()
```
  - getActivityTypeFromCode
```
public ActivityType getActivityTypeFromCode()
```
    This method lazy inits ActivityType
    
    Returns:
  - getProposalTypeFromCode
```
public ProposalType getProposalTypeFromCode()
```
    This method lazy inits ProposalType
    
    Returns:
  - doProposalLogDataFeed
```
public void doProposalLogDataFeed(ProposalLog proposalLog)
```
    Populate properties on this InstitutionalProposal with the respective properties from ProposalLog.
    
    Parameters:
    proposalLog - ProposalLog
  - getUnitService
```
public UnitService getUnitService()
```
  - getBusinessObjectService
```
protected org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()
```
  - getNsfCodeBo
```
public NsfCode getNsfCodeBo()
```
  - setNsfCodeBo
```
public void setNsfCodeBo(NsfCode nsfCodeBo)
```
  - getInitialContractAdminUser
```
public KcPerson getInitialContractAdminUser()
```
  - getSummaryComment
```
public InstitutionalProposalComment getSummaryComment()
```
  - getDeliveryComment
```
public InstitutionalProposalComment getDeliveryComment()
```
  - getCostShareComment
```
public InstitutionalProposalComment getCostShareComment()
```
  - getUnrecoveredFandAComment
```
public InstitutionalProposalComment getUnrecoveredFandAComment()
```
  - getGeneralComment
```
public InstitutionalProposalComment getGeneralComment()
```
  - getInstitutionalProposalCommentByType
```
public InstitutionalProposalComment getInstitutionalProposalCommentByType(String commentTypeCode,
                                                                 boolean createNew)
```
  - add
```
public void add(InstitutionalProposalComment ipComment)
```
  - setLookupUnit
```
public void setLookupUnit(Unit lookupUnit)
```
  - getLookupUnit
```
public Unit getLookupUnit()
```
  - setLookupUnitName
```
public void setLookupUnitName(String lookupUnitName)
```
  - getLookupUnitName
```
public String getLookupUnitName()
```
  - setLookupUnitNumber
```
public void setLookupUnitNumber(String lookupUnitNumber)
```
  - getLookupUnitNumber
```
public String getLookupUnitNumber()
```
  - setLookupPersonNumber
```
public void setLookupPersonNumber(String lookupPersonNumber)
```
  - getLookupPersonNumber
```
public String getLookupPersonNumber()
```
  - setShowReturnLink
```
public void setShowReturnLink(boolean val)
```
  - getShowReturnLink
```
public boolean getShowReturnLink()
```
  - getInstProposalNumber
```
public String getInstProposalNumber()
```
  - setInstProposalNumber
```
public void setInstProposalNumber(String instProposalNumber)
```
  - getTotalUnitCount
```
public int getTotalUnitCount()
```
    This method returns the combined number of units for all project personnel.
    
    Returns:
  - isSponsorNihMultiplePi
```
public boolean isSponsorNihMultiplePi()
```
    Specified by:
    
    isSponsorNihMultiplePi in interface Sponsorable
    
    Returns:
  - setSponsorNihMultiplePi
```
public void setSponsorNihMultiplePi(boolean sponsorNihMultiplePi)
```
  - getLeadUnitName
```
public String getLeadUnitName()
```
    Description copied from interface: Negotiable
    
    This method returns the lead unit's name, if it exists, otherwise returns an empty string.
    
    Specified by:
    
    getLeadUnitName in interface Negotiable
    
    Returns:
  - getPiName
```
public String getPiName()
```
    Description copied from interface: Negotiable
    
    Returns the PI's name whether employee or non-employee.
    
    Specified by:
    
    getPiName in interface Negotiable
    
    Returns:
  - getPiEmployeeName
```
public String getPiEmployeeName()
```
    Description copied from interface: Negotiable
    
    This method returns the employee principle investigator's name, if it exists, otherwise returns an empty string.
    
    Specified by:
    
    getPiEmployeeName in interface Negotiable
    
    Returns:
  - getPiNonEmployeeName
```
public String getPiNonEmployeeName()
```
    Description copied from interface: Negotiable
    
    This method returns the the non-employee (Rolodex) Principle Ivestigator's name, if it exists, otherwise returns an empty string.
    
    Specified by:
    
    getPiNonEmployeeName in interface Negotiable
    
    Returns:
  - getAdminPersonName
```
public String getAdminPersonName()
```
    Description copied from interface: Negotiable
    
    This method returns the admin person's name, if it exists, otherwise returns an empty string.
    
    Specified by:
    
    getAdminPersonName in interface Negotiable
    
    Returns:
  - getPrimeSponsorName
```
public String getPrimeSponsorName()
```
    Description copied from interface: Negotiable
    
    This method returns the prime sponsor's name, if it exists, otherwise returns an empty string.
    
    Specified by:
    
    getPrimeSponsorName in interface Negotiable
    
    Returns:
  - getSponsorAwardNumber
```
public String getSponsorAwardNumber()
```
    Description copied from interface: Negotiable
    
    This method returns the sponsor award number, if it exists, otherwise returns an empty string.
    
    Specified by:
    
    getSponsorAwardNumber in interface Negotiable
    
    Returns:
  - getSubAwardOrganizationName
```
public String getSubAwardOrganizationName()
```
    Description copied from interface: Negotiable
    
    This method returns the sub award organization name, if it exists, otherwise returns an empty string.
    
    Specified by:
    
    getSubAwardOrganizationName in interface Negotiable
    
    Returns:
  - getProjectPeople
```
public List<NegotiationPersonDTO> getProjectPeople()
```
    Description copied from interface: Negotiable
    
    This method returns a list of KcPersons that include the PI, COI, and Key Personnel.
    
    Specified by:
    
    getProjectPeople in interface Negotiable
    
    Returns:
  - getAssociatedDocumentId
```
public String getAssociatedDocumentId()
```
    Description copied from interface: Negotiable
    
    Returns the negotiable's document id.
    
    Specified by:
    
    getAssociatedDocumentId in interface Negotiable
    
    Returns:
  - getNegotiableProposalTypeCode
```
public String getNegotiableProposalTypeCode()
```
    Description copied from interface: Negotiable
    
    Get the proposal type code from this negotiable. Renamed to negotiableproposaltypecode as PropertyUtils appears to get a descriptor for the interface instead of the BO itself in some cases and this can cause the property to seem unwritable.
    
    Specified by:
    
    getNegotiableProposalTypeCode in interface Negotiable
    
    Returns:
  - getNegotiableProposalType
```
public ProposalType getNegotiableProposalType()
```
    Description copied from interface: Negotiable
    
    This method a proposal type if it is an institutional proposal or a proposal log.
    
    Specified by:
    
    getNegotiableProposalType in interface Negotiable
    
    Returns:
  - getSubAwardRequisitionerName
```
public String getSubAwardRequisitionerName()
```
    Description copied from interface: Negotiable
    
    This method returns the Requisitioner's Name if it is a subaward, otherwise returns an empty string.
    
    Specified by:
    
    getSubAwardRequisitionerName in interface Negotiable
    
    Returns:
  - getSubAwardRequisitionerUnitNumber
```
public String getSubAwardRequisitionerUnitNumber()
```
    Description copied from interface: Negotiable
    
    This method returns the Requisitioner's Unit Number if it is a subaward, otherwise returns an empty string.
    
    Specified by:
    
    getSubAwardRequisitionerUnitNumber in interface Negotiable
    
    Returns:
  - getSubAwardRequisitionerUnitName
```
public String getSubAwardRequisitionerUnitName()
```
    Description copied from interface: Negotiable
    
    This method returns the Requisitioner's Unit Name if it is a subaward, otherwise returns an empty string.
    
    Specified by:
    
    getSubAwardRequisitionerUnitName in interface Negotiable
    
    Returns:
  - getSubAwardRequisitionerId
```
public String getSubAwardRequisitionerId()
```
    Description copied from interface: Negotiable
    
    This method returns the Requisitioner's ID if it is a subaward, otherwise returns an empty string.
    
    Specified by:
    
    getSubAwardRequisitionerId in interface Negotiable
    
    Returns:
  - getFiscalYearMonthService
```
public FiscalYearMonthService getFiscalYearMonthService()
```
  - isAllowUpdateTimestampToBeReset
```
public boolean isAllowUpdateTimestampToBeReset()
```
  - setAllowUpdateTimestampToBeReset
```
public void setAllowUpdateTimestampToBeReset(boolean allowUpdateTimestampToBeReset)
```
    Setting this value to false will prevent the update timestamp field from being upddate just once. After that, the update timestamp field will update as regular.
    
    Parameters:
    allowUpdateTimestampToBeReset -
  - setUpdateTimestamp
```
public void setUpdateTimestamp(Timestamp updateTimestamp)
```
    Overrides:
    
    setUpdateTimestamp in class KraPersistableBusinessObjectBase

Class InstitutionalProposal

Field Summary

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

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

Fields inherited from interface org.kuali.kra.negotiations.bo.Negotiable

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.kuali.rice.krad.bo.PersistableBusinessObject

Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject

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

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

Field Detail

PROPOSAL_ID_PROPERTY_STRING

PROPOSAL_NUMBER_PROPERTY_STRING

PROPOSAL_SEQUENCE_STATUS_PROPERTY_STRING

PROPOSAL_NUMBER_TEST_DEFAULT_STRING

Constructor Detail

InstitutionalProposal

Method Detail

initializeCollections

setDefaultInitialContractAdmin

deactivateFundingProposals

activateFundingProposals

isActiveVersion

isCancelled

isFundedByAward

getKraBusinessObjectService

getInstitutionalProposalDocument

setInstitutionalProposalDocument

add

add

add

add

getTotalInitialCost

getTotalCost

getTotalCostShareAmount

getTotalUnrecoveredFandAAmount

getSpecialReviews

setSpecialReviews

getInstitutionalProposalCustomDataList

getInstitutionalProposalNotepads

setInstitutionalProposalNotepads

setInstitutionalProposalCustomDataList

getInstitutionalProposalScienceKeywords

setInstitutionalProposalScienceKeywords

add

add

getOspAdministrator

setInstitutionalProposalUnitContacts

getInstitutionalProposalUnitContacts

getInstitutionalProposalContactsCount

getProposalId

setProposalId

getProposalNumber

setProposalNumber

getSponsorProposalNumber

setSponsorProposalNumber

getSequenceNumber

setSequenceNumber

getProposalTypeCode

setProposalTypeCode

getCurrentAccountNumber

setCurrentAccountNumber

getTitle

setTitle

getSponsorCode

setSponsorCode

getRolodexId

setRolodexId

getNoticeOfOpportunityCode

setNoticeOfOpportunityCode

getGradStudHeadcount

setGradStudHeadcount

getGradStudPersonMonths

setGradStudPersonMonths