org.kuali.kra.institutionalproposal.service

Interface InstitutionalProposalService

All Known Implementing Classes:

InstitutionalProposalServiceImpl

public interface InstitutionalProposalService

This interface defines public services made available by the Institutional Proposal module.

Method Summary

Methods

Modifier and Type	Method and Description
InstitutionalProposalDocument	createAndSaveNewVersion(InstitutionalProposal currentInstitutionalProposal, InstitutionalProposalDocument currentInstitutionalProposalDocument) This method is to create a new version of an existing Institute Proposal
String	createInstitutionalProposal(DevelopmentProposal developmentProposal, Budget budget) Creates a new Institutional Proposal with data copied from the given development proposal and budget.
String	createInstitutionalProposalVersion(String proposalNumber, DevelopmentProposal developmentProposal, Budget budget) Creates a new version of the Institutional Proposal corresponding to the given proposal number, with data copied from the given development proposal and budget.
List<InstitutionalProposal>	defundInstitutionalProposals(Set<String> proposalNumbers, String awardNumber, Integer awardSequence) Designate the given Proposals as no longer funded by the given Award.
List<InstitutionalProposal>	fundInstitutionalProposals(Set<String> proposalNumbers) Designate one or more Institutional Proposals as Funded by an Award.
InstitutionalProposal	getActiveInstitutionalProposalVersion(String proposalNumber) Return the ACTIVE version of an Institutional Proposal, if one exists.
List<DevelopmentProposal>	getAllLinkedDevelopmentProposals(String proposalNumber) Return all Development Proposals linked to any version of the institutional proposal identified by proposalNumber.
InstitutionalProposal	getInstitutionalProposal(String proposalId) Return an Institutional Proposal, if one exists.
String	getNextInstitutionalProposalNumber()
InstitutionalProposal	getPendingInstitutionalProposalVersion(String proposalNumber) Return the PENDING version of an Institutional Proposal, if one exists.
List<InstitutionalProposal>	getProposalsForProposalNumber(String proposalNumber) Get all versions of a proposal.
Collection<String>	getValidFundingProposalStatusCodes() Return a list of valid proposal status codes for award funding as defined by the 'validFundingProposalStatusCodes' parm.

Method Detail

createInstitutionalProposal

String createInstitutionalProposal(DevelopmentProposal developmentProposal,
                                 Budget budget)

Creates a new Institutional Proposal with data copied from the given development proposal and budget.

Parameters:

developmentProposal - DevelopmentProposal

budget - Budget

Returns:

String The new proposal number

createInstitutionalProposalVersion

String createInstitutionalProposalVersion(String proposalNumber,
                                        DevelopmentProposal developmentProposal,
                                        Budget budget)

Creates a new version of the Institutional Proposal corresponding to the given proposal number, with data copied from the given development proposal and budget.

Parameters:

proposalNumber - String

developmentProposal - DevelopmentProposal

budget - Budget

Returns:

String The new version number

getInstitutionalProposal

InstitutionalProposal getInstitutionalProposal(String proposalId)

Return an Institutional Proposal, if one exists.

Parameters:

proposalId - String

Returns:

InstitutionalProposal, or null if none is found.

getPendingInstitutionalProposalVersion

InstitutionalProposal getPendingInstitutionalProposalVersion(String proposalNumber)

Return the PENDING version of an Institutional Proposal, if one exists. Note, PENDING here refers to the Version Status, NOT the Proposal Status of the Institutional Proposal.

Parameters:

proposalNumber - String

Returns:

InstitutionalProposal, or null if a PENDING version is not found.

See Also:

VersionStatus

getActiveInstitutionalProposalVersion

InstitutionalProposal getActiveInstitutionalProposalVersion(String proposalNumber)

Return the ACTIVE version of an Institutional Proposal, if one exists. Note, ACTIVE here refers to the Version Status, NOT the Proposal Status of the Institutional Proposal.

Parameters:

proposalNumber - String

Returns:

InstitutionalProposal, or null if a ACTIVE version is not found.

See Also:

VersionStatus

fundInstitutionalProposals

List<InstitutionalProposal> fundInstitutionalProposals(Set<String> proposalNumbers)

Designate one or more Institutional Proposals as Funded by an Award. If the given Proposal has a Proposal Status of Pending, a new Final version of the Proposal will be created with a Proposal Status of Funded. If the current Active version is already Funded, it will be left alone.

Parameters:

proposalNumbers - The proposals to update.

Returns:

List The new Funded versions.

defundInstitutionalProposals

List<InstitutionalProposal> defundInstitutionalProposals(Set<String> proposalNumbers,
                                                       String awardNumber,
                                                       Integer awardSequence)

Designate the given Proposals as no longer funded by the given Award. If the given Award was the only funding Award for a Proposal, a new Final version of the Proposal will be created with a Proposal Status of Pending. If the Proposal has other funding Awards, it will be left alone. It will also be left alone if it is funded by the active version of the given award number (this is a functional requirement).

Parameters:

proposalNumbers - The proposals to update.

awardNumber - The Award that is de-funding the proposal.

awardSequence - The sequence number of the Award.

Returns:

List The new Pending versions.

getProposalsForProposalNumber

List<InstitutionalProposal> getProposalsForProposalNumber(String proposalNumber)

Get all versions of a proposal.

Parameters:

proposalNumber -

Returns:

getAllLinkedDevelopmentProposals

List<DevelopmentProposal> getAllLinkedDevelopmentProposals(String proposalNumber)

Return all Development Proposals linked to any version of the institutional proposal identified by proposalNumber.

Parameters:

proposalNumber -

Returns:

getNextInstitutionalProposalNumber

String getNextInstitutionalProposalNumber()

getValidFundingProposalStatusCodes

Collection<String> getValidFundingProposalStatusCodes()

Return a list of valid proposal status codes for award funding as defined by the 'validFundingProposalStatusCodes' parm.

Returns:

createAndSaveNewVersion

InstitutionalProposalDocument createAndSaveNewVersion(InstitutionalProposal currentInstitutionalProposal,
                                                    InstitutionalProposalDocument currentInstitutionalProposalDocument)
                                                      throws VersionException,
                                                             org.kuali.rice.kew.api.exception.WorkflowException,
                                                             IOException

This method is to create a new version of an existing Institute Proposal

Parameters:

currentInstitutionalProposal -

currentInstitutionalProposalDocument -

Returns:

Throws:

VersionException

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

IOException