org.kuali.kra.institutionalproposal.service.impl

Class InstitutionalProposalServiceImpl

java.lang.Object

org.kuali.kra.institutionalproposal.service.impl.InstitutionalProposalServiceImpl

All Implemented Interfaces:

InstitutionalProposalService

@Transactional
public class InstitutionalProposalServiceImpl
extends Object
implements InstitutionalProposalService

This class provides the default implementation of the InstitutionalProposalService.

Constructor Summary

Constructors

Constructor and Description
InstitutionalProposalServiceImpl()

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 pending Institutional Proposal based on given development proposal and budget.
String	createInstitutionalProposalVersion(String proposalNumber, DevelopmentProposal developmentProposal, Budget budget) Creates a new active 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.
protected void	doBaseFieldsDataFeed(InstitutionalProposal institutionalProposal, DevelopmentProposal developmentProposal)
protected void	doBudgetDataFeed(InstitutionalProposal institutionalProposal, Budget budget)
protected void	doCustomAttributeDataFeed(InstitutionalProposalDocument institutionalProposalDocument, DevelopmentProposal developmentProposal)
List<InstitutionalProposal>	fundInstitutionalProposals(Set<String> proposalNumbers) Designate one or more Institutional Proposals as Funded by an Award.
protected InstitutionalProposalPerson	generateInstitutionalProposalPerson(ProposalPerson pdPerson)
protected InstitutionalProposalSpecialReview	generateIpSpecialReview(ProposalSpecialReview dpSpecialReview)
protected InstitutionalProposal	getActiveInstitutionalProposal(String proposalNumber) Queries the persistence layer to find the InstitutionalProposal record for the given proposalNumber.
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.
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
protected Integer	getDefaultCostShareTypeCode()
protected Integer	getDefaultStatusCode()
org.kuali.rice.krad.service.DocumentService	getDocumentService()
InstitutionalProposal	getInstitutionalProposal(String proposalId) Return an Institutional Proposal, if one exists.
String	getNextInstitutionalProposalNumber()
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
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.
VersioningService	getVersioningService()
protected Integer	getWithdrawnStatusCode()
protected InstitutionalProposalDocument	mergeProposals(InstitutionalProposal institutionalProposal, DevelopmentProposal developmentProposal, Budget budget)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)
void	setInstitutionalProposalVersioningService(InstitutionalProposalVersioningService institutionalProposalVersioningService)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)
void	setSequenceAccessorService(org.kuali.rice.krad.service.SequenceAccessorService sequenceAccessorService) Set the Sequence Accessor Service.
void	setVersioningService(VersioningService versioningService)
protected void	synchNewCustomAttributes(InstitutionalProposal newInstitutionalProposal, InstitutionalProposal oldInstitutionalProposal) This method is to synch custom attributes.
protected ArrayList<AwardFundingProposal>	transferFundingProposals(InstitutionalProposal oldIP, InstitutionalProposal newIP)
protected InstitutionalProposalDocument	versionProposal(String proposalNumber, DevelopmentProposal developmentProposal, Budget budget)

Methods inherited from class java.lang.Object

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

Constructor Detail

InstitutionalProposalServiceImpl

public InstitutionalProposalServiceImpl()

Method Detail

createInstitutionalProposal

public String createInstitutionalProposal(DevelopmentProposal developmentProposal,
                                 Budget budget)

Creates a new pending Institutional Proposal based on given development proposal and budget.

Specified by:

createInstitutionalProposal in interface InstitutionalProposalService

Parameters:

developmentProposal - DevelopmentProposal

budget - Budget

Returns:

String The new proposal number

See Also:

InstitutionalProposalService.createInstitutionalProposal(DevelopmentProposal, Budget)

createInstitutionalProposalVersion

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

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

Specified by:

createInstitutionalProposalVersion in interface InstitutionalProposalService

Parameters:

proposalNumber - String

developmentProposal - DevelopmentProposal

budget - Budget

Returns:

String The new version number

See Also:

InstitutionalProposalService.createInstitutionalProposalVersion(String, DevelopmentProposal, Budget)

getInstitutionalProposal

public InstitutionalProposal getInstitutionalProposal(String proposalId)

Return an Institutional Proposal, if one exists.

Specified by:

getInstitutionalProposal in interface InstitutionalProposalService

Parameters:

proposalId - String

Returns:

InstitutionalProposal, or null if none is found.

See Also:

InstitutionalProposalService.getInstitutionalProposal(String)

getPendingInstitutionalProposalVersion

public 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. This is just a pass-through to InstitutionalProposalVersioningService, but we needed this method to be part of the module API.

Specified by:

getPendingInstitutionalProposalVersion in interface InstitutionalProposalService

Parameters:

proposalNumber - String

Returns:

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

See Also:

VersionStatus

getActiveInstitutionalProposalVersion

public 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.

Specified by:

getActiveInstitutionalProposalVersion in interface InstitutionalProposalService

Parameters:

proposalNumber - String

Returns:

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

See Also:

VersionStatus

fundInstitutionalProposals

public 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.

Specified by:

fundInstitutionalProposals in interface InstitutionalProposalService

Parameters:

proposalNumbers - The proposals to update.

Returns:

List The new Funded versions.

defundInstitutionalProposals

public 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).

Specified by:

defundInstitutionalProposals in interface InstitutionalProposalService

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

public List<InstitutionalProposal> getProposalsForProposalNumber(String proposalNumber)

Description copied from interface: InstitutionalProposalService

Get all versions of a proposal.

Specified by:

getProposalsForProposalNumber in interface InstitutionalProposalService

Returns:

See Also:

org.kuali.kra.institutionalproposal.service.InstitutionalProposalService#getProposalForProposalNumber(java.lang.String)

getAllLinkedDevelopmentProposals

public List<DevelopmentProposal> getAllLinkedDevelopmentProposals(String proposalNumber)

Description copied from interface: InstitutionalProposalService

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

Specified by:

getAllLinkedDevelopmentProposals in interface InstitutionalProposalService

Returns:

See Also:

InstitutionalProposalService.getAllLinkedDevelopmentProposals(java.lang.String)

getNextInstitutionalProposalNumber

public String getNextInstitutionalProposalNumber()

Specified by:

getNextInstitutionalProposalNumber in interface InstitutionalProposalService

getActiveInstitutionalProposal

protected InstitutionalProposal getActiveInstitutionalProposal(String proposalNumber)

Queries the persistence layer to find the InstitutionalProposal record for the given proposalNumber.

Parameters:

proposalNumber - String

Returns:

InstitutionalProposal

versionProposal

protected InstitutionalProposalDocument versionProposal(String proposalNumber,
                                            DevelopmentProposal developmentProposal,
                                            Budget budget)
                                                 throws VersionException,
                                                        org.kuali.rice.kew.api.exception.WorkflowException

Throws:

VersionException

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

mergeProposals

protected InstitutionalProposalDocument mergeProposals(InstitutionalProposal institutionalProposal,
                                           DevelopmentProposal developmentProposal,
                                           Budget budget)
                                                throws org.kuali.rice.kew.api.exception.WorkflowException

Throws:

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

doBaseFieldsDataFeed

protected void doBaseFieldsDataFeed(InstitutionalProposal institutionalProposal,
                        DevelopmentProposal developmentProposal)

doCustomAttributeDataFeed

protected void doCustomAttributeDataFeed(InstitutionalProposalDocument institutionalProposalDocument,
                             DevelopmentProposal developmentProposal)
                                  throws org.kuali.rice.kew.api.exception.WorkflowException

Throws:

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

generateInstitutionalProposalPerson

protected InstitutionalProposalPerson generateInstitutionalProposalPerson(ProposalPerson pdPerson)

generateIpSpecialReview

protected InstitutionalProposalSpecialReview generateIpSpecialReview(ProposalSpecialReview dpSpecialReview)

doBudgetDataFeed

protected void doBudgetDataFeed(InstitutionalProposal institutionalProposal,
                    Budget budget)

getDefaultStatusCode

protected Integer getDefaultStatusCode()

getWithdrawnStatusCode

protected Integer getWithdrawnStatusCode()

getDefaultCostShareTypeCode

protected Integer getDefaultCostShareTypeCode()

createAndSaveNewVersion

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

Description copied from interface: InstitutionalProposalService

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

Specified by:

createAndSaveNewVersion in interface InstitutionalProposalService

Returns:

Throws:

VersionException

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

IOException

See Also:

InstitutionalProposalService.createAndSaveNewVersion(org.kuali.kra.institutionalproposal.home.InstitutionalProposal, org.kuali.kra.institutionalproposal.document.InstitutionalProposalDocument)

synchNewCustomAttributes

protected void synchNewCustomAttributes(InstitutionalProposal newInstitutionalProposal,
                            InstitutionalProposal oldInstitutionalProposal)

This method is to synch custom attributes. During version process only existing custom attributes available in the old document is copied. We need to make sure we have all the latest custom attributes tied to the new document.

Parameters:

newInstitutionalProposal -

oldInstitutionalProposal -

transferFundingProposals

protected ArrayList<AwardFundingProposal> transferFundingProposals(InstitutionalProposal oldIP,
                                                       InstitutionalProposal newIP)

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

setDocumentService

public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)

setVersioningService

public void setVersioningService(VersioningService versioningService)

setInstitutionalProposalVersioningService

public void setInstitutionalProposalVersioningService(InstitutionalProposalVersioningService institutionalProposalVersioningService)

setSequenceAccessorService

public void setSequenceAccessorService(org.kuali.rice.krad.service.SequenceAccessorService sequenceAccessorService)

Set the Sequence Accessor Service.

Parameters:

sequenceAccessorService - the Sequence Accessor Service

getValidFundingProposalStatusCodes

public Collection<String> getValidFundingProposalStatusCodes()

Description copied from interface: InstitutionalProposalService

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

Specified by:

getValidFundingProposalStatusCodes in interface InstitutionalProposalService

Returns:

See Also:

InstitutionalProposalService.getValidFundingProposalStatusCodes()

getParameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

getDocumentService

public org.kuali.rice.krad.service.DocumentService getDocumentService()

getVersioningService

public VersioningService getVersioningService()

getBusinessObjectService

public org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()