SubAward (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.subaward.bo.SubAward

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, Permissionable, Negotiable, Sequenceable, SequenceAssociate<SubAward>, SequenceOwner<SubAward>, 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 SubAward
extends KraPersistableBusinessObjectBase
implements Permissionable, SequenceOwner<SubAward>, Negotiable
```
This class is using for SubAward...

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String NOTIFICATION_TYPE_SUBMIT
- 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.common.permissions.Permissionable
  AWARD_BUDGET_KEY, AWARD_KEY, COI_DISCLOSURE_KEY, COMMITTEE_KEY, COMMITTEE_SCHEDULE_KEY, IACUC_PROTOCOL_KEY, IACUC_PROTOCOL_ONLINE_REVIEW_KEY, NEGOTIATION_KEY, PROPOSAL_BUDGET_KEY, PROPOSAL_KEY, PROTOCOL_KEY, PROTOCOL_ONLINE_REVIEW_KEY, SPONSOR_HIREARCHY_KEY, SUBAWARD_KEY, TIME_AND_MONEY_KEY
- Fields inherited from interface org.kuali.kra.negotiations.bo.Negotiable
  EMPTY_STRING

Fields
Modifier and Type	Field and Description
`static String`	`NOTIFICATION_TYPE_SUBMIT`

Constructor Summary

Constructors
Constructor and Description

SubAward()
.

Constructors
Constructor and Description
`SubAward()` .

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAccountNumber()` .
`String`	`getAdminPersonName()` This method returns the admin person's name, if it exists, otherwise returns an empty string.
`String`	`getArchiveLocation()` .
`String`	`getAssociatedDocumentId()` Returns the negotiable's document id.
`String`	`getAwardNumber()` .
`Date`	`getCloseoutDate()` .
`String`	`getCloseoutIndicator()` .
`String`	`getComments()` .
`String`	`getDocIdStatus()` .
`String`	`getDocumentKey()` This method returns unique key for implementing document.
`String`	`getDocumentNumberForPermission()` This method returns the appropriate document number for implementing documents For award it would be awardNumber and for PDD it would be proposal Number.
`String`	`getDocumentRoleTypeCode()`
`Date`	`getEndDate()` .
`String`	`getFundingSourceIndicator()` .
`protected Map<String,Object>`	`getIdentifierMap(String identifierField, Object identifierValue)` .
`KcPerson`	`getKcPerson()` .
`String`	`getLastUpdate()` .
`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`	`getNamespace()`
`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.
`boolean`	`getNewVersion()` .
`Organization`	`getOrganization()` .
`String`	`getOrganizationId()` .
`String`	`getOrganizationName()` .
`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.
`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.
`List<NegotiationPersonDTO>`	`getProjectPeople()` This method returns a list of KcPersons that include the PI, COI, and Key Personnel.
`String`	`getPurchaseOrderNum()` .
`KcPerson`	`getRequisitioner()`
`String`	`getRequisitionerId()` .
`String`	`getRequisitionerName()` .
`String`	`getRequisitionerUnit()` .
`String`	`getRequisitionerUnitName()` .
`String`	`getRequisitionerUserName()` .
`List<String>`	`getRoleNames()` This method gets all the role names for particular document.
`Rolodex`	`getRolodex()` .
`String`	`getRolodexFirstName()`
`Integer`	`getSequenceNumber()` .
`SubAward`	`getSequenceOwner()` The SequenceOwner is returned; "this" should be returned if this associate is the sequence owner.
`Integer`	`getSiteInvestigator()` .
`String`	`getSiteInvestigatorId()` .
`String`	`getSiteInvestigatorName()` .
`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.
`Date`	`getStartDate()` .
`Integer`	`getStatusCode()` .
`String`	`getStatusDescription()` .
`SubAwardAmountInfo`	`getSubAwardAmountInfo()` .
`List<SubAwardAmountInfo>`	`getSubAwardAmountInfoList()` .
`List<SubAwardAmountReleased>`	`getSubAwardAmountReleasedList()` .
`SubAwardCloseout`	`getSubAwardCloseout()` .
`List<SubAwardCloseout>`	`getSubAwardCloseoutList()` .
`String`	`getSubAwardCode()` .
`SubAwardContact`	`getSubAwardContact()` .
`List<SubAwardContact>`	`getSubAwardContactsList()` .
`List<SubAwardCustomData>`	`getSubAwardCustomDataList()` .
`SubAwardDocument`	`getSubAwardDocument()` .
`SubAwardFundingSource`	`getSubAwardFundingSource()` .
`List<SubAwardFundingSource>`	`getSubAwardFundingSourceList()` .
`Long`	`getSubAwardId()` .
`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.
`String`	`getSubAwardSequenceStatus()` .
`SubAwardStatus`	`getSubAwardStatus()` .
`AwardType`	`getSubAwardType()` .
`Integer`	`getSubAwardTypeCode()` .
`String`	`getTitle()` .
`org.kuali.rice.core.api.util.type.KualiDecimal`	`getTotalAmountReleased()` .
`org.kuali.rice.core.api.util.type.KualiDecimal`	`getTotalAnticipatedAmount()` .
`org.kuali.rice.core.api.util.type.KualiDecimal`	`getTotalAvailableAmount()` .
`org.kuali.rice.core.api.util.type.KualiDecimal`	`getTotalObligatedAmount()` .
`Unit`	`getUnit()` .
`String`	`getVendorNumber()` .
`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`	`initialize()`
`protected void`	`initializeCollections()` .
`boolean`	`isDefaultOpen()`
`boolean`	`isEditSubAward()` .
`void`	`populateAdditionalQualifiedRoleAttributes(Map<String,String> qualifiedRoleAttributes)` Allows a permissionable to set additional qualified role attributes that may be needed by kim services to resolve the role members.
`void`	`resetPersistenceState()` This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity.
`void`	`setAccountNumber(String accountNumber)` .
`void`	`setArchiveLocation(String archiveLocation)` .
`void`	`setAwardNumber(String awardNumber)` .
`void`	`setCloseoutDate(Date closeoutDate)` .
`void`	`setCloseoutIndicator(String closeoutIndicator)` .
`void`	`setComments(String comments)` .
`void`	`setDefaultOpen(boolean defaultOpen)`
`void`	`setDocIdStatus(String docIdStatus)` .
`void`	`setEditSubAward(boolean editSubAward)` .
`void`	`setEndDate(Date endDate)` .
`void`	`setFundingSourceIndicator(String fundingSourceIndicator)` .
`void`	`setKcPerson(KcPerson kcPerson)` .
`void`	`setLastUpdate(String lastUpdate)` .
`void`	`setNewVersion(boolean newVersion)` .
`void`	`setOrganization(Organization organization)` .
`void`	`setOrganizationId(String organizationId)` .
`void`	`setOrganizationName(String organizationName)` .
`void`	`setPurchaseOrderNum(String purchaseOrderNum)` .
`void`	`setRequisitionerId(String requisitionerId)` .
`void`	`setRequisitionerName(String requisitionerName)` .
`void`	`setRequisitionerUnit(String requisitionerUnit)` .
`void`	`setRequisitionerUnitName(String requisitionerUnitName)` .
`void`	`setRequisitionerUserName(String requisitionerUserName)` .
`void`	`setRolodex(Rolodex rolodex)` .
`void`	`setRolodexFirstName(String rolodexFirstName)`
`void`	`setSequenceNumber(Integer sequenceNumber)` .
`void`	`setSequenceOwner(SubAward newlyVersionedOwner)` This sets the sequence owner on the associate.
`void`	`setSiteInvestigator(Integer siteInvestigator)` .
`void`	`setSiteInvestigatorId(String siteInvestigatorId)` .
`void`	`setSiteInvestigatorName(String siteInvestigatorName)` .
`void`	`setStartDate(Date startDate)` .
`void`	`setStatusCode(Integer statusCode)` .
`void`	`setSubAwardAmountInfo(SubAwardAmountInfo subAwardAmountInfo)` .
`void`	`setSubAwardAmountInfoList(List<SubAwardAmountInfo> subAwardAmountInfoList)` .
`void`	`setSubAwardCloseout(SubAwardCloseout subAwardCloseout)` .
`void`	`setSubAwardCloseoutList(List<SubAwardCloseout> subAwardCloseoutList)` .
`void`	`setSubAwardCode(String subAwardCode)` .
`void`	`setSubAwardContact(SubAwardContact subAwardContact)` .
`void`	`setSubAwardContactsList(List<SubAwardContact> subAwardContactsList)` .
`void`	`setSubAwardCustomDataList(List<SubAwardCustomData> subAwardCustomDataList)` .
`void`	`setSubAwardDocument(SubAwardDocument subAwardDocument)` .
`void`	`setSubAwardFundingSource(SubAwardFundingSource subAwardFundingSource)` .
`void`	`setSubAwardFundingSourceList(List<SubAwardFundingSource> subAwardFundingSourceList)` .
`void`	`setSubAwardId(Long subAwardId)` .
`void`	`setSubAwardSequenceStatus(String subAwardSequenceStatus)` .
`void`	`setSubAwardStatus(SubAwardStatus subAwardStatus)`
`void`	`setSubAwardType(AwardType subAwardType)`
`void`	`setSubAwardTypeCode(Integer subAwardTypeCode)` .
`void`	`setTitle(String title)` .
`void`	`setTotalAmountReleased(org.kuali.rice.core.api.util.type.KualiDecimal totalAmountReleased)` .
`void`	`setTotalAnticipatedAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalAnticipatedAmount)` .
`void`	`setTotalAvailableAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalAvailableAmount)` .
`void`	`setTotalObligatedAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalObligatedAmount)` .
`void`	`setUnit(Unit unit)` .
`void`	`setVendorNumber(String vendorNumber)` .

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

- Field Detail
  - NOTIFICATION_TYPE_SUBMIT
```
public static final String NOTIFICATION_TYPE_SUBMIT
```
    See Also:
    Constant Field Values
- Constructor Detail
  - SubAward
```
public SubAward()
```
    . This creates subAwardConstructor
- Method Detail
  - getRolodex
```
public Rolodex getRolodex()
```
    . This is the Getter Method for rolodex
    
    Returns:
    Returns the rolodex.
  - setRolodex
```
public void setRolodex(Rolodex rolodex)
```
    . This is the Setter Method for rolodex
    
    Parameters:
    rolodex - The rolodex to set.
  - getKcPerson
```
public KcPerson getKcPerson()
```
    . This is the Getter Method for kcPerson
    
    Returns:
    Returns the kcPerson.
  - setKcPerson
```
public void setKcPerson(KcPerson kcPerson)
```
    . This is the Setter Method for kcPerson
    
    Parameters:
    kcPerson - The kcPerson to set.
  - getSubAwardSequenceStatus
```
public String getSubAwardSequenceStatus()
```
    . This is the Getter Method for subAwardSequenceStatus
    
    Returns:
    Returns the subAwardSequenceStatus.
  - setSubAwardSequenceStatus
```
public void setSubAwardSequenceStatus(String subAwardSequenceStatus)
```
    . This is the Setter Method for subAwardSequenceStatus
    
    Parameters:
    subAwardSequenceStatus - The subAwardSequenceStatus to set.
  - getRolodexFirstName
```
public String getRolodexFirstName()
```
  - setRolodexFirstName
```
public void setRolodexFirstName(String rolodexFirstName)
```
  - getOrganization
```
public Organization getOrganization()
```
    . This is the Getter Method for organization
    
    Returns:
    Returns the organization.
  - setOrganization
```
public void setOrganization(Organization organization)
```
    . This is the Setter Method for organization
    
    Parameters:
    organization - The organization to set.
  - getUnit
```
public Unit getUnit()
```
    . This is the Getter Method for unit
    
    Returns:
    Returns the unit.
  - setUnit
```
public void setUnit(Unit unit)
```
    . This is the Setter Method for unit
    
    Parameters:
    unit - The unit to set.
  - getOrganizationName
```
public String getOrganizationName()
```
    . This is the Getter Method for OrganizationName
    
    Returns:
    Returns organizationName.
  - setOrganizationName
```
public void setOrganizationName(String organizationName)
```
    . This is the Setter Method for Organizationname
    
    Parameters:
    organizationName - The organizationName to set.
  - getRequisitionerName
```
public String getRequisitionerName()
```
    . This is the Getter Method for requisitionerName
    
    Returns:
    Returns the requisitionerName.
  - setRequisitionerName
```
public void setRequisitionerName(String requisitionerName)
```
    . This is the Setter Method for requisitionerName
    
    Parameters:
    requisitionerName - The requisitionerName to set.
  - getRequisitionerUnitName
```
public String getRequisitionerUnitName()
```
    . This is the Getter Method for requisitionerUnitName
    
    Returns:
    Returns the requisitionerUnitName.
  - setRequisitionerUnitName
```
public void setRequisitionerUnitName(String requisitionerUnitName)
```
    . This is the Setter Method for requisitionerUnitName
    
    Parameters:
    requisitionerUnitName - The requisitionerUnitName to set.
  - getRequisitionerUserName
```
public String getRequisitionerUserName()
```
    . This is the Getter Method for requisitionerUserName
    
    Returns:
    Returns the requisitionerUserName.
  - setRequisitionerUserName
```
public void setRequisitionerUserName(String requisitionerUserName)
```
    . This is the Setter Method for requisitionerUserName
    
    Parameters:
    requisitionerUserName - The requisitionerUserName to set.
  - getRequisitioner
```
public KcPerson getRequisitioner()
```
  - getSiteInvestigatorName
```
public String getSiteInvestigatorName()
```
    . This is the Getter Method for siteInvestigatorName
    
    Returns:
    Returns the siteInvestigatorName.
  - setSiteInvestigatorName
```
public void setSiteInvestigatorName(String siteInvestigatorName)
```
    . This is the Setter Method for siteInvestigatorName
    
    Parameters:
    siteInvestigatorName - The siteInvestigatorName to set.
  - initialize
```
protected void initialize()
```
  - getSubAwardId
```
public Long getSubAwardId()
```
    . This is the Getter Method for subAwardId
    
    Returns:
    Returns the subAwardId.
  - setSubAwardId
```
public void setSubAwardId(Long subAwardId)
```
    . This is the Setter Method for subAwardId
    
    Parameters:
    subAwardId - The subAwardId to set.
  - getSubAwardCode
```
public String getSubAwardCode()
```
    . This is the Getter Method for subAwardCode
    
    Returns:
    Returns the subAwardCode.
  - setSubAwardCode
```
public void setSubAwardCode(String subAwardCode)
```
    . This is the Setter Method for subAwardCode
    
    Parameters:
    subAwardCode - The subAwardCode to set.
  - getSequenceNumber
```
public Integer getSequenceNumber()
```
    . This is the Getter Method for sequenceNumber
    
    Specified by:
    
    getSequenceNumber in interface Sequenceable
    
    Returns:
    Returns the sequenceNumber.
  - setSequenceNumber
```
public void setSequenceNumber(Integer sequenceNumber)
```
    . This is the Setter Method for sequenceNumber
    
    Parameters:
    sequenceNumber - The sequenceNumber to set.
  - getOrganizationId
```
public String getOrganizationId()
```
    . This is the Getter Method for OrganizationId
    
    Returns:
    Returns the OrganizationId.
  - setOrganizationId
```
public void setOrganizationId(String organizationId)
```
    . This is the Setter Method for organizationId
    
    Parameters:
    organizationId - The organizationId to set.
  - getStartDate
```
public Date getStartDate()
```
    . This is the Getter Method for startDate
    
    Returns:
    Returns the startDate.
  - setStartDate
```
public void setStartDate(Date startDate)
```
    . This is the Setter Method for startDate
    
    Parameters:
    startDate - The startDate to set.
  - getEndDate
```
public Date getEndDate()
```
    . This is the Getter Method for endDate
    
    Returns:
    Returns the endDate.
  - setEndDate
```
public void setEndDate(Date endDate)
```
    . This is the Setter Method for endDate
    
    Parameters:
    endDate - The endDate to set.
  - getSubAwardTypeCode
```
public Integer getSubAwardTypeCode()
```
    . This is the Getter Method for subAwardTypeCode
    
    Returns:
    Returns the subAwardTypeCode.
  - setSubAwardTypeCode
```
public void setSubAwardTypeCode(Integer subAwardTypeCode)
```
    . This is the Setter Method for subAwardTypeCode
    
    Parameters:
    subAwardTypeCode - The subAwardTypeCode to set.
  - getPurchaseOrderNum
```
public String getPurchaseOrderNum()
```
    . This is the Getter Method for purchaseOrderNum
    
    Returns:
    Returns the purchaseOrderNum.
  - setPurchaseOrderNum
```
public void setPurchaseOrderNum(String purchaseOrderNum)
```
    . This is the Setter Method for purchaseOrderNum
    
    Parameters:
    purchaseOrderNum - The purchaseOrderNum to set.
  - getTitle
```
public String getTitle()
```
    . This is the Getter Method for title
    
    Specified by:
    
    getTitle in interface Negotiable
    
    Returns:
    Returns the title.
  - setTitle
```
public void setTitle(String title)
```
    . This is the Setter Method for title
    
    Parameters:
    title - The title to set.
  - getStatusCode
```
public Integer getStatusCode()
```
    . This is the Getter Method for statusCode
    
    Returns:
    Returns the statusCode.
  - setStatusCode
```
public void setStatusCode(Integer statusCode)
```
    . This is the Setter Method for statusCode
    
    Parameters:
    statusCode - The statusCode to set.
  - getAccountNumber
```
public String getAccountNumber()
```
    . This is the Getter Method for accountNumber
    
    Returns:
    Returns the accountNumber.
  - setAccountNumber
```
public void setAccountNumber(String accountNumber)
```
    . This is the Setter Method for accountNumber
    
    Parameters:
    accountNumber - The accountNumber to set.
  - getVendorNumber
```
public String getVendorNumber()
```
    . This is the Getter Method for vendorNumber
    
    Returns:
    Returns the vendorNumber.
  - setVendorNumber
```
public void setVendorNumber(String vendorNumber)
```
    . This is the Setter Method for vendorNumber
    
    Parameters:
    vendorNumber - The vendorNumber to set.
  - getRequisitionerId
```
public String getRequisitionerId()
```
    . This is the Getter Method for requisitionerId
    
    Returns:
    Returns the requisitionerId.
  - setRequisitionerId
```
public void setRequisitionerId(String requisitionerId)
```
    . This is the Setter Method for requisitionerId
    
    Parameters:
    requisitionerId - The requisitionerId to set.
  - getRequisitionerUnit
```
public String getRequisitionerUnit()
```
    . This is the Getter Method for RequisitionerUnit
    
    Returns:
    Returns the requisitionerUnit.
  - setRequisitionerUnit
```
public void setRequisitionerUnit(String requisitionerUnit)
```
    . This is the Setter Method for requisitionerUnit
    
    Parameters:
    requisitionerUnit - The requisitionerUnit to set.
  - getArchiveLocation
```
public String getArchiveLocation()
```
    . This is the Getter Method for archiveLocation
    
    Returns:
    Returns the archiveLocation.
  - setArchiveLocation
```
public void setArchiveLocation(String archiveLocation)
```
    . This is the Setter Method for archiveLocation
    
    Parameters:
    archiveLocation - The archiveLocation to set.
  - getCloseoutDate
```
public Date getCloseoutDate()
```
    . This is the Getter Method for closeoutDate
    
    Returns:
    Returns the closeoutDate.
  - setCloseoutDate
```
public void setCloseoutDate(Date closeoutDate)
```
    . This is the Setter Method for closeoutDate
    
    Parameters:
    closeoutDate - The closeoutDate to set.
  - getCloseoutIndicator
```
public String getCloseoutIndicator()
```
    . This is the Getter Method for closeoutIndicator
    
    Returns:
    Returns the closeoutIndicator.
  - setCloseoutIndicator
```
public void setCloseoutIndicator(String closeoutIndicator)
```
    . This is the Setter Method for closeoutIndicator
    
    Parameters:
    closeoutIndicator - The closeoutIndicator to set.
  - getFundingSourceIndicator
```
public String getFundingSourceIndicator()
```
    . This is the Getter Method for fundingSourceIndicator
    
    Returns:
    Returns the fundingSourceIndicator.
  - setFundingSourceIndicator
```
public void setFundingSourceIndicator(String fundingSourceIndicator)
```
    . This is the Setter Method for fundingSourceIndicator
    
    Parameters:
    fundingSourceIndicator - The fundingSourceIndicator to set.
  - getComments
```
public String getComments()
```
    . This is the Getter Method for comments
    
    Returns:
    Returns the comments.
  - setComments
```
public void setComments(String comments)
```
    . This is the Setter Method for comments
    
    Parameters:
    comments - The comments to set.
  - getSiteInvestigator
```
public Integer getSiteInvestigator()
```
    . This is the Getter Method for siteinvestigator
    
    Returns:
    Returns the siteInvestigator.
  - setSiteInvestigator
```
public void setSiteInvestigator(Integer siteInvestigator)
```
    . This is the Setter Method for siteInvestigator
    
    Parameters:
    siteInvestigator - The siteInvestigator to set.
  - getSubAwardFundingSource
```
public SubAwardFundingSource getSubAwardFundingSource()
```
    . This is the Getter Method for subAwardFundingSource
    
    Returns:
    Returns the subAwardFundingSource.
  - setSubAwardFundingSource
```
public void setSubAwardFundingSource(SubAwardFundingSource subAwardFundingSource)
```
    . This is the Setter Method for subAwardFundingSource
    
    Parameters:
    subAwardFundingSource - The subAwardFundingSource to set.
  - getSubAwardContact
```
public SubAwardContact getSubAwardContact()
```
    . This is the Getter Method for subAwardContact
    
    Returns:
    Returns the subAwardContact.
  - setSubAwardContact
```
public void setSubAwardContact(SubAwardContact subAwardContact)
```
    . This is the Setter Method for subAwardContact
    
    Parameters:
    subAwardContact - The subAwardContact to set.
  - getSubAwardCloseout
```
public SubAwardCloseout getSubAwardCloseout()
```
    . This is the Getter Method for subAwardCloseout
    
    Returns:
    Returns the subAwardCloseout.
  - setSubAwardCloseout
```
public void setSubAwardCloseout(SubAwardCloseout subAwardCloseout)
```
    . This is the Setter Method for subAwardCloseout
    
    Parameters:
    subAwardCloseout - The subAwardCloseout to set.
  - getSubAwardAmountInfo
```
public SubAwardAmountInfo getSubAwardAmountInfo()
```
    . This is the Getter Method for subAwardAmountInfo
    
    Returns:
    Returns the subAwardAmountInfo.
  - setSubAwardAmountInfo
```
public void setSubAwardAmountInfo(SubAwardAmountInfo subAwardAmountInfo)
```
    . This is the Setter Method for subAwardAmountInfo
    
    Parameters:
    subAwardAmountInfo - The subAwardAmountInfo to set.
  - getSubAwardFundingSourceList
```
public List<SubAwardFundingSource> getSubAwardFundingSourceList()
```
    . This is the Getter Method for subAwardFundingSourceList
    
    Returns:
    Returns the subAwardFundingSourceList.
  - setSubAwardFundingSourceList
```
public void setSubAwardFundingSourceList(List<SubAwardFundingSource> subAwardFundingSourceList)
```
    . This is the Setter Method for subAwardFundingSourceList
    
    Parameters:
    subAwardFundingSourceList - The subAwardFundingSourceList to set.
  - getSubAwardAmountInfoList
```
public List<SubAwardAmountInfo> getSubAwardAmountInfoList()
```
    . This is the Getter Method for subAwardAmountInfoList
    
    Returns:
    Returns the subAwardAmountInfoList.
  - setSubAwardAmountInfoList
```
public void setSubAwardAmountInfoList(List<SubAwardAmountInfo> subAwardAmountInfoList)
```
    . This is the Setter Method for subAwardAmountInfoList
    
    Parameters:
    subAwardAmountInfoList - The subAwardAmountInfoList to set.
  - getSubAwardAmountReleasedList
```
public List<SubAwardAmountReleased> getSubAwardAmountReleasedList()
```
    . This is the Getter Method for subAwardAmountReleasedList
    
    Returns:
    Returns the subAwardAmountReleasedList.
  - getSubAwardContactsList
```
public List<SubAwardContact> getSubAwardContactsList()
```
    . This is the Getter Method for subAwardContactsList
    
    Returns:
    Returns the subAwardContactsList.
  - setSubAwardContactsList
```
public void setSubAwardContactsList(List<SubAwardContact> subAwardContactsList)
```
    . This is the Setter Method for subAwardContactsList
    
    Parameters:
    subAwardContactsList - The subAwardContactsList to set.
  - getSubAwardCloseoutList
```
public List<SubAwardCloseout> getSubAwardCloseoutList()
```
    . This is the Getter Method for subAwardCloseoutList
    
    Returns:
    Returns the subAwardCloseoutList.
  - setSubAwardCloseoutList
```
public void setSubAwardCloseoutList(List<SubAwardCloseout> subAwardCloseoutList)
```
    . This is the Setter Method for subAwardCloseoutList
    
    Parameters:
    subAwardCloseoutList - The subAwardCloseoutList to set.
  - getSubAwardCustomDataList
```
public List<SubAwardCustomData> getSubAwardCustomDataList()
```
    . This is the Getter Method for subAwardCustomDataList
    
    Returns:
    Returns the subAwardCustomDataList.
  - setSubAwardCustomDataList
```
public void setSubAwardCustomDataList(List<SubAwardCustomData> subAwardCustomDataList)
```
    . This is the Setter Method for subAwardCustomDataList
    
    Parameters:
    subAwardCustomDataList - The subAwardCustomDataList to set.
  - getStatusDescription
```
public String getStatusDescription()
```
    . This is the Getter Method for getStatusDescription
    
    Returns:
    Returns the statusDescription.
  - initializeCollections
```
protected void initializeCollections()
```
    . This is the Getter Method for initializeCollections
  - setSubAwardDocument
```
public void setSubAwardDocument(SubAwardDocument subAwardDocument)
```
    . This is the Setter Method for subAwardDocument
    
    Parameters:
    subAwardDocument - The subAwardDocument to set.
  - getSubAwardDocument
```
public SubAwardDocument getSubAwardDocument()
```
    . This is the Getter Method for getSubAwardDocument
    
    Returns:
    Returns the subAwardDocument.
  - setSubAwardStatus
```
public void setSubAwardStatus(SubAwardStatus subAwardStatus)
```
  - getSubAwardStatus
```
public SubAwardStatus getSubAwardStatus()
```
    . This is the Getter Method for getSubAwardStatus
    
    Returns:
    Returns the subAwardDocument.
  - setSubAwardType
```
public void setSubAwardType(AwardType subAwardType)
```
  - getSubAwardType
```
public AwardType getSubAwardType()
```
    . This is the Getter Method for subAwardType
    
    Returns:
    Returns the subAwardType.
  - getDocumentNumberForPermission
```
public String getDocumentNumberForPermission()
```
    Description copied from interface: Permissionable
    
    This method returns the appropriate document number for implementing documents For award it would be awardNumber and for PDD it would be proposal Number.
    
    Specified by:
    
    getDocumentNumberForPermission in interface Permissionable
    
    Returns:
  - getDocumentKey
```
public String getDocumentKey()
```
    Description copied from interface: Permissionable
    
    This method returns unique key for implementing document.
    
    Specified by:
    
    getDocumentKey in interface Permissionable
    
    Returns:
  - getRoleNames
```
public List<String> getRoleNames()
```
    Description copied from interface: Permissionable
    
    This method gets all the role names for particular document.
    
    Specified by:
    
    getRoleNames in interface Permissionable
    
    Returns:
  - getNamespace
```
public String getNamespace()
```
    Specified by:
    
    getNamespace in interface Permissionable
  - 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 Permissionable
    
    Specified by:
    
    getLeadUnitNumber in interface Negotiable
    
    Returns:
  - getDocumentRoleTypeCode
```
public String getDocumentRoleTypeCode()
```
    Specified by:
    
    getDocumentRoleTypeCode in interface Permissionable
  - populateAdditionalQualifiedRoleAttributes
```
public void populateAdditionalQualifiedRoleAttributes(Map<String,String> qualifiedRoleAttributes)
```
    Description copied from interface: Permissionable
    
    Allows a permissionable to set additional qualified role attributes that may be needed by kim services to resolve the role members.
    
    Specified by:
    
    populateAdditionalQualifiedRoleAttributes in interface Permissionable
  - 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<SubAward>
    
    See Also:
    SequenceOwner.incrementSequenceNumber()
  - setSequenceOwner
```
public void setSequenceOwner(SubAward newlyVersionedOwner)
```
    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<SubAward>
    
    See Also:
    SequenceOwner.getOwnerSequenceNumber()
  - getSequenceOwner
```
public SubAward 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<SubAward>
    
    Returns:
    the SequenceOwner
    See Also:
    SequenceAssociate.getSequenceOwner()
  - 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()
  - 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<SubAward>
    
    Returns:
    the owner's sequence number
  - 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<SubAward>
    
    Returns:
    the field name that versions are "grouped" by
  - setNewVersion
```
public void setNewVersion(boolean newVersion)
```
    . sets newVersion to specified value
    
    Parameters:
    newVersion - the newVersion to be set
  - getNewVersion
```
public boolean getNewVersion()
```
    . Gets the newVersion attribute
    
    Returns:
    Returns the newVersion attribute
  - getTotalObligatedAmount
```
public org.kuali.rice.core.api.util.type.KualiDecimal getTotalObligatedAmount()
```
    . This is the Getter Method for totalObligatedAmount
    
    Returns:
    Returns the totalObligatedAmount.
  - getLastUpdate
```
public String getLastUpdate()
```
    . This is the Getter Method for lastUpdate
    
    Returns:
    Returns the lastUpdate.
  - setLastUpdate
```
public void setLastUpdate(String lastUpdate)
```
    . This is the Setter Method for lastUpdate
    
    Parameters:
    lastUpdate - The lastUpdate to set.
  - setTotalObligatedAmount
```
public void setTotalObligatedAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalObligatedAmount)
```
    . This is the Setter Method for totalObligatedAmount
    
    Parameters:
    totalObligatedAmount - The totalObligatedAmount to set.
  - getTotalAnticipatedAmount
```
public org.kuali.rice.core.api.util.type.KualiDecimal getTotalAnticipatedAmount()
```
    . This is the Getter Method for totalAnticipatedAmount
    
    Returns:
    Returns the totalAnticipatedAmount.
  - setTotalAnticipatedAmount
```
public void setTotalAnticipatedAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalAnticipatedAmount)
```
    . This is the Setter Method for totalAnticipatedAmount
    
    Parameters:
    totalAnticipatedAmount - The totalAnticipatedAmount to set.
  - getTotalAmountReleased
```
public org.kuali.rice.core.api.util.type.KualiDecimal getTotalAmountReleased()
```
    . This is the Getter Method for totalAmountReleased
    
    Returns:
    Returns the totalAmountReleased.
  - setTotalAmountReleased
```
public void setTotalAmountReleased(org.kuali.rice.core.api.util.type.KualiDecimal totalAmountReleased)
```
    . This is the Setter Method for totalAmountReleased
    
    Parameters:
    totalAmountReleased - The totalAmountReleased to set.
  - getTotalAvailableAmount
```
public org.kuali.rice.core.api.util.type.KualiDecimal getTotalAvailableAmount()
```
    . This is the Getter Method for totalAvailableAmount
    
    Returns:
    Returns the totalAvailableAmount.
  - setTotalAvailableAmount
```
public void setTotalAvailableAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalAvailableAmount)
```
    . This is the Setter Method for totalAvailableAmount
    
    Parameters:
    totalAvailableAmount - The totalAvailableAmount to set.
  - getDocIdStatus
```
public String getDocIdStatus()
```
    . This is the Getter Method for docIdStatus
    
    Returns:
    Returns the docIdStatus.
  - setDocIdStatus
```
public void setDocIdStatus(String docIdStatus)
```
    . This is the Setter Method for docIdStatus
    
    Parameters:
    docIdStatus - The docIdStatus to set.
  - getSiteInvestigatorId
```
public String getSiteInvestigatorId()
```
    . This is the Getter Method for SiteInvestigatorId
    
    Returns:
    Returns the siteInvestigatorId.
  - setSiteInvestigatorId
```
public void setSiteInvestigatorId(String siteInvestigatorId)
```
    . This is the Setter Method for SiteInvestigatorId
    
    Parameters:
    siteInvestigatorId - The siteInvestigatorId to set.
  - getAssociatedDocumentId
```
public String getAssociatedDocumentId()
```
    Description copied from interface: Negotiable
    
    Returns the negotiable's document id.
    
    Specified by:
    
    getAssociatedDocumentId in interface Negotiable
    
    Returns:
  - 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:
  - 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
    
    Returns:
  - 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:
  - 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:
  - 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:
  - 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:
  - getAwardNumber
```
public String getAwardNumber()
```
    . This is the Getter Method for awardNumber
    
    Returns:
    Returns the awardNumber.
  - setAwardNumber
```
public void setAwardNumber(String awardNumber)
```
    . This is the Setter Method for awardNumber
    
    Parameters:
    awardNumber - The awardNumber to set.
  - isEditSubAward
```
public boolean isEditSubAward()
```
    . This is the Getter Method for editSubAward
    
    Returns:
    Returns the editSubAward.
  - setEditSubAward
```
public void setEditSubAward(boolean editSubAward)
```
    . This is the Setter Method for editSubAward
    
    Parameters:
    editSubAward - The editSubAward to set.
  - getIdentifierMap
```
protected Map<String,Object> getIdentifierMap(String identifierField,
                                  Object identifierValue)
```
    . Build an identifier map for the BOS lookup
    
    Parameters:
    identifierField -
    identifierValue -
    
    Returns:
  - isDefaultOpen
```
public boolean isDefaultOpen()
```
  - setDefaultOpen
```
public void setDefaultOpen(boolean defaultOpen)
```

Class SubAward

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.common.permissions.Permissionable

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.core.api.mo.ModelObjectBasic

Field Detail

NOTIFICATION_TYPE_SUBMIT

Constructor Detail

SubAward

Method Detail

getRolodex

setRolodex

getKcPerson

setKcPerson

getSubAwardSequenceStatus

setSubAwardSequenceStatus

getRolodexFirstName

setRolodexFirstName

getOrganization

setOrganization

getUnit

setUnit

getOrganizationName

setOrganizationName

getRequisitionerName

setRequisitionerName

getRequisitionerUnitName

setRequisitionerUnitName

getRequisitionerUserName

setRequisitionerUserName

getRequisitioner

getSiteInvestigatorName

setSiteInvestigatorName

initialize

getSubAwardId

setSubAwardId

getSubAwardCode

setSubAwardCode

getSequenceNumber

setSequenceNumber

getOrganizationId

setOrganizationId

getStartDate

setStartDate

getEndDate

setEndDate

getSubAwardTypeCode

setSubAwardTypeCode

getPurchaseOrderNum

setPurchaseOrderNum

getTitle

setTitle

getStatusCode

setStatusCode

getAccountNumber

setAccountNumber

getVendorNumber

setVendorNumber

getRequisitionerId

setRequisitionerId

getRequisitionerUnit

setRequisitionerUnit

getArchiveLocation

setArchiveLocation

getCloseoutDate

setCloseoutDate

getCloseoutIndicator

setCloseoutIndicator

getFundingSourceIndicator

setFundingSourceIndicator

getComments

setComments