org.kuali.kra.proposaldevelopment.hierarchy.service.impl

Class ProposalHierarchyServiceImpl

java.lang.Object

org.kuali.kra.proposaldevelopment.hierarchy.service.impl.ProposalHierarchyServiceImpl

All Implemented Interfaces:

ProposalHierarchyService

@Transactional
public class ProposalHierarchyServiceImpl
extends Object
implements ProposalHierarchyService

This class...

Field Summary

Fields inherited from interface org.kuali.kra.proposaldevelopment.hierarchy.service.ProposalHierarchyService

HIERARCHY_CANCEL_APPSTATUS, HIERARCHY_CHILD_CANCEL_APPSTATUS, HIERARCHY_CHILD_DISAPPROVE_APPSTATUS, HIERARCHY_CHILD_ENROUTE_APPSTATUS, HIERARCHY_CHILD_FINAL_APPSTATUS, HIERARCHY_CHILD_PROCESSED_APPSTATUS, HIERARCHY_CHILD_REJECTED_APPSTATUS, HIERARCHY_DISAPPROVE_APPSTATUS, HIERARCHY_ENROUTE_APPSTATUS, HIERARCHY_FINAL_APPSTATUS, HIERARCHY_PROCESSED_APPSTATUS, HIERARCHY_REJECTED_APPSTATUS, HIERARCHY_ROUTING_PARENT_APPROVED_ANNOTATION, HIERARCHY_ROUTING_PARENT_CANCELLED_ANNOTATION, HIERARCHY_ROUTING_PARENT_DISAPPROVED_ANNOTATION, HIERARCHY_ROUTING_PARENT_REJECTED_ANNOTATION, HIERARCHY_ROUTING_PARENT_RESUBMITTED_ANNOTATION, HIERARCHY_ROUTING_PARENT_SUBMITTED_ANNOTATION, PROPOSAL_DEVELOPMENT_DOCUMENT_TYPE, PROPOSAL_ROUTING_REJECTED_ANNOTATION

Constructor Summary

Constructors

Constructor and Description
ProposalHierarchyServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	aggregateHierarchy(DevelopmentProposal hierarchy)
boolean	allChildBudgetsAreComplete(String parentProposalNumber)
void	calculateAndSetProposalAppDocStatus(ProposalDevelopmentDocument doc, org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange dto)
protected String	calculateChildRouteStatus(ProposalDevelopmentDocument hierarchy, org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange dto) Based on the hierarchy, and route status change of the parent, calculate what route action should be taken on the children.
protected int	computeHierarchyHashCode(Budget budget) Creates a hash of the data pertinent to a hierarchy for comparison during hierarchy syncing.
protected int	computeHierarchyHashCode(DevelopmentProposal proposal) Creates a hash of the data pertinent to a hierarchy for comparison during hierarchy syncing.
protected void	copyInitialAttachments(DevelopmentProposal srcProposal, DevelopmentProposal destProposal)
protected void	copyInitialData(DevelopmentProposal hierarchyProposal, DevelopmentProposal srcProposal)
String	createHierarchy(DevelopmentProposal initialChild) This method takes a proposal, creates a Hierarchy and links the proposal as the initial child.
protected void	finalizeHierarchySync(DevelopmentProposal hierarchyProposal)
protected void	finalizeHierarchySync(ProposalDevelopmentDocument pdDoc)
protected BudgetPeriod	findOrCreateMatchingPeriod(BudgetPeriod childPeriod, Budget parentBudget)
protected BudgetService	getBudgetService()
BudgetSummaryService	getBudgetSummaryService()
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
List<ProposalDevelopmentDocument>	getChildProposalDevelopmentDocuments(String parentProposalNumber) Get a list of ProposalDevelopmentDocuments that are children of proposal number provided.
protected org.kuali.rice.core.api.config.property.ConfigurationService	getConfigurationService()
protected int	getCorrespondingParentPeriod(Budget parentBudget, Budget childBudget)
DevelopmentProposal	getDevelopmentProposal(String proposalNumber)
protected org.kuali.rice.krad.service.DocumentService	getDocumentService()
protected DevelopmentProposal	getHierarchy(String hierarchyProposalNumber)
protected BudgetDocument<DevelopmentProposal>	getHierarchyBudget(DevelopmentProposal hierarchyProposal)
protected List<BudgetDocument<DevelopmentProposal>>	getHierarchyBudgets(DevelopmentProposal hierarchyProposal)
List<DevelopmentProposal>	getHierarchyChildren(String parentProposalNumber) Get a list of DevelopmentProposals that are children of proposal number provided.
String	getHierarchyChildRouteStatus(String oldStatus, String newStatus) Calculate the AppDocStatus that should be applied to children of a parent moving from oldStatus to newStatus.
List<HierarchyPersonnelSummary>	getHierarchyPersonnelSummaries(String parentProposalNumber)
List<HierarchyProposalSummary>	getHierarchyProposalSummaries(String proposalNumber)
protected org.kuali.rice.kim.api.identity.IdentityService	getIdentityManagementService()
protected KraAuthorizationService	getKraAuthorizationService()
KraDocumentRejectionService	getKraDocumentRejectionService()
protected NarrativeService	getNarrativeService()
protected List<PropScienceKeyword>	getOldKeywords(DevelopmentProposal hierarchyProposal, DevelopmentProposal childProposal) Gets the old proposal science keywords before removing them from the parent.
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
ProposalDevelopmentDocument	getParentDocument(ProposalDevelopmentDocument child) Get the parent document of the hierarchy child document.
org.kuali.rice.kew.api.WorkflowDocument	getParentWorkflowDocument(ProposalDevelopmentDocument child) Get the parent workflow document of the hierarchy child document.
protected ProposalHierarchyDao	getProposalHierarchyDao()
protected List<ProposalPersonExtendedAttributes>	getProposalPersonExtendedAttributesToDelete()
HierarchyProposalSummary	getProposalSummary(String proposalNumber)
protected ProposalPersonBiographyService	getPropPersonBioService()
protected org.kuali.rice.kns.service.SessionDocumentService	getSessionDocumentService()
BudgetDocument<DevelopmentProposal>	getSyncableBudget(DevelopmentProposal childProposal) Gets the budget for hierarchy sync.
protected org.kuali.rice.krad.workflow.service.WorkflowDocumentService	getWorkflowDocumentService()
protected void	initializeBudget(DevelopmentProposal hierarchyProposal, DevelopmentProposal childProposal)
protected boolean	isBudgetSynchronized(DevelopmentProposal childProposal, ProposalDevelopmentBudgetExt childBudget)
protected boolean	isBudgetSynchronized(String childProposalNumber)
protected boolean	isSynchronized(DevelopmentProposal childProposal)
protected boolean	isSynchronized(String childProposalNumber)
protected void	linkChild(DevelopmentProposal hierarchyProposal, DevelopmentProposal newChildProposal, String hierarchyBudgetTypeCode)
void	linkToHierarchy(DevelopmentProposal hierarchyProposal, DevelopmentProposal newChildProposal, String hierarchyBudgetTypeCode) This method links a proposal to a Hierarchy.
protected void	loadAttachmentContent(Narrative narrative)
protected void	loadBioContent(ProposalPersonBiography bio)
DevelopmentProposal	lookupParent(DevelopmentProposal childProposal)
protected void	prepareHierarchySync(DevelopmentProposal hierarchyProposal)
protected void	prepareHierarchySync(ProposalDevelopmentDocument pdDoc)
protected void	rejectProposal(ProposalDevelopmentDocument proposalDoc, String reason, String principalId, String appDocStatus) Reject a proposal by sending it to the first node ( as named by PROPOSALDEVELOPMENTDOCUMENT_KEW_INITIAL_NODE_NAME )
void	rejectProposalDevelopmentDocument(String proposalNumber, String reason, String principalName, org.apache.struts.upload.FormFile rejectFile) Reject a proposal development document by proposal number.
protected void	rejectProposalHierarchy(ProposalDevelopmentDocument hierarchyParent, String reason, String principalId) Reject an entire proposal hierarchy.
protected void	removeChildBudgetElements(DevelopmentProposal parentProposal, Budget parentBudget, String childProposalNumber)
protected void	removeChildElements(DevelopmentProposal parentProposal, Budget parentBudget, String childProposalNumber)
void	removeFromHierarchy(DevelopmentProposal childProposal) This method removes childProposal from the hierarchy of which it is a member
protected String	renderMessage(String key, String... params)
protected boolean	rolesAreSimilar(ProposalPerson person1, ProposalPerson person2)
void	routeHierarchyChildren(ProposalDevelopmentDocument proposalDevelopmentDocument, org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange dto) Given the proposalDevelopmentDocument, RouteStatusChangeDTO, and the current user principal name, route all of the child proposal appropriately.
void	setBudgetService(BudgetService budgetService)
void	setBudgetSummaryService(BudgetSummaryService budgetSummaryService)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setConfigurationService(org.kuali.rice.core.api.config.property.ConfigurationService configurationService)
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)
void	setIdentityManagementService(org.kuali.rice.kim.api.identity.IdentityService identityManagerService)
protected void	setInitialPi(DevelopmentProposal hierarchy, DevelopmentProposal child)
void	setKraAuthorizationService(KraAuthorizationService kraAuthorizationService)
void	setKraDocumentRejectionService(KraDocumentRejectionService kraDocumentRejectionService)
void	setNarrativeService(NarrativeService narrativeService)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)
void	setProposalHierarchyDao(ProposalHierarchyDao proposalHierarchyDao)
void	setPropPersonBioService(ProposalPersonBiographyService propPersonBioService)
void	setSessionDocumentService(org.kuali.rice.kns.service.SessionDocumentService sessionDocumentService)
void	setWorkflowDocumentService(org.kuali.rice.krad.workflow.service.WorkflowDocumentService workflowDocumentService)
protected void	synchronizeAll(DevelopmentProposal hierarchyProposal)
protected boolean	synchronizeAllChildProposals(DevelopmentProposal hierarchyProposal) Synchronizes all child proposals to the parent.
protected void	synchronizeAllChildren(DevelopmentProposal hierarchyProposal)
void	synchronizeAllChildren(ProposalDevelopmentDocument pdDoc) This method synchronizes the contents of all children into the hierarchy.
protected void	synchronizeBudget(DevelopmentProposal hierarchyProposal, DevelopmentProposal childProposal, Budget hierarchyBudget, ProposalDevelopmentBudgetExt childBudget, BudgetDocument hierarchyBudgetDocument) Synchronizes the proposal budget from the child proposal to the parent proposal.
void	synchronizeChild(DevelopmentProposal childProposal) This method synchronizes the contents of one child into its hierarchy.
protected void	synchronizeChildBudget(Budget parentBudget, Budget childBudget, String childProposalNumber, String hierarchyBudgetTypeCode, boolean isOriginatingChildBudget)
protected boolean	synchronizeChildProposal(DevelopmentProposal hierarchyProposal, DevelopmentProposal childProposal) Synchronizes the given child proposal to the parent.
protected boolean	synchronizeChildProposalBudget(DevelopmentProposal hierarchyProposal, ProposalDevelopmentBudgetExt budget, DevelopmentProposal childProposal)
void	synchronizeChildProposalBudget(ProposalDevelopmentBudgetExt budget, DevelopmentProposal childProposal) This method syncs only the budget from the child proposal specificed to the hierarchy budget.
protected void	synchronizeKeywords(DevelopmentProposal hierarchyProposal, DevelopmentProposal childProposal, List<PropScienceKeyword> oldKeywords) Synchronizes the proposal science keywords from the child proposal to the parent proposal.
protected void	synchronizeNarratives(DevelopmentProposal hierarchyProposal, DevelopmentProposal childProposal) Synchronizes the proposal narratives from the child proposal to the parent proposal.
protected void	synchronizePersons(DevelopmentProposal hierarchyProposal, DevelopmentProposal childProposal, ProposalPerson principalInvestigator) Synchronizes the proposal persons from the child proposal to the parent proposal.
protected void	synchronizePersonsAndAggregate(DevelopmentProposal hierarchyProposal, DevelopmentProposal primaryChildProposal, ProposalPerson principalInvestigator) Synchronizes the proposal persons from the child proposal to the parent proposal and then restores any proposal persons that were in the given child proposal (and hence removed from the given parent proposal).
protected void	synchronizeSpecialReviews(DevelopmentProposal hierarchyProposal, DevelopmentProposal childProposal) Synchronizes the proposal special reviews from the child proposal to the parent proposal.
protected void	syncProposalPersons(DevelopmentProposal childProposal, DevelopmentProposal hierarchyProposal, ProposalPerson pi, List<ProposalPerson> removedPersons)
void	updateAppDocStatus(ProposalDevelopmentDocument doc, String principalId, String newStatus) Update the app doc status for the given document.
ProposalHierarchyErrorDto	validateChildBudgetPeriods(DevelopmentProposal hierarchyProposal, DevelopmentProposal childProposal, boolean allowEndDateChange)
boolean	validateRemovePermissions(DevelopmentProposal childProposal, String principalId)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProposalHierarchyServiceImpl

public ProposalHierarchyServiceImpl()

Method Detail

setIdentityManagementService

public void setIdentityManagementService(org.kuali.rice.kim.api.identity.IdentityService identityManagerService)

setBusinessObjectService

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

setDocumentService

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

setKraAuthorizationService

public void setKraAuthorizationService(KraAuthorizationService kraAuthorizationService)

setProposalHierarchyDao

public void setProposalHierarchyDao(ProposalHierarchyDao proposalHierarchyDao)

setNarrativeService

public void setNarrativeService(NarrativeService narrativeService)

setBudgetService

public void setBudgetService(BudgetService budgetService)

setPropPersonBioService

public void setPropPersonBioService(ProposalPersonBiographyService propPersonBioService)

setParameterService

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

setConfigurationService

public void setConfigurationService(org.kuali.rice.core.api.config.property.ConfigurationService configurationService)

createHierarchy

public String createHierarchy(DevelopmentProposal initialChild)
                       throws ProposalHierarchyException

Description copied from interface: ProposalHierarchyService

This method takes a proposal, creates a Hierarchy and links the proposal as the initial child.

Specified by:

createHierarchy in interface ProposalHierarchyService

Returns:

the proposal number of the new hierarchy

Throws:

ProposalHierarchyException - if the proposal is already a member of a hierarchy

See Also:

org.kuali.kra.proposaldevelopment.hierarchy.service.ProposalHierarchyService#createHierarchy(java.lang.String)

linkToHierarchy

public void linkToHierarchy(DevelopmentProposal hierarchyProposal,
                   DevelopmentProposal newChildProposal,
                   String hierarchyBudgetTypeCode)
                     throws ProposalHierarchyException

Description copied from interface: ProposalHierarchyService

This method links a proposal to a Hierarchy.

Specified by:

linkToHierarchy in interface ProposalHierarchyService

Parameters:

hierarchyProposal - the hierarchy to link the new child to

newChildProposal - the proposal to link to the hierarchy

hierarchyBudgetTypeCode - the type of budget syncing to perform with the child

Throws:

ProposalHierarchyException - if hierarchyProposal is not a valid Hierarchy or if newChildProposal is already a member of a hierarchy or does not exist

See Also:

ProposalHierarchyService.linkToHierarchy(org.kuali.kra.proposaldevelopment.bo.DevelopmentProposal, org.kuali.kra.proposaldevelopment.bo.DevelopmentProposal, java.lang.String)

removeFromHierarchy

public void removeFromHierarchy(DevelopmentProposal childProposal)
                         throws ProposalHierarchyException

Description copied from interface: ProposalHierarchyService

This method removes childProposal from the hierarchy of which it is a member

Specified by:

removeFromHierarchy in interface ProposalHierarchyService

Parameters:

childProposal - the proposal to remove

Throws:

ProposalHierarchyException - if childProposal is not a member of a hierarchy

See Also:

org.kuali.kra.proposaldevelopment.hierarchy.service.ProposalHierarchyService#removeFromHierarchy(java.lang.String)

synchronizeAllChildren

public void synchronizeAllChildren(ProposalDevelopmentDocument pdDoc)
                            throws ProposalHierarchyException

Description copied from interface: ProposalHierarchyService

This method synchronizes the contents of all children into the hierarchy. If any child has changed since its last synchronization, the parent is reaggregated.

Specified by:

synchronizeAllChildren in interface ProposalHierarchyService

Parameters:

pdDoc - the hierarchy in question

Throws:

ProposalHierarchyException - if hierarchyProposalDocument is not a valid Hierarchy

See Also:

org.kuali.kra.proposaldevelopment.hierarchy.service.ProposalHierarchySyncService#synchronizeAllChildren(java.lang.String)

synchronizeAllChildren

protected void synchronizeAllChildren(DevelopmentProposal hierarchyProposal)
                               throws ProposalHierarchyException

Throws:

ProposalHierarchyException

synchronizeAll

protected void synchronizeAll(DevelopmentProposal hierarchyProposal)
                       throws ProposalHierarchyException

Throws:

ProposalHierarchyException

synchronizeChild

public void synchronizeChild(DevelopmentProposal childProposal)
                      throws ProposalHierarchyException

Description copied from interface: ProposalHierarchyService

This method synchronizes the contents of one child into its hierarchy. If the child has changed since its last synchronization, the parent is reaggregated.

Specified by:

synchronizeChild in interface ProposalHierarchyService

Parameters:

childProposal - the child proposal in question

Throws:

ProposalHierarchyException - if childProposal is not a member of a hierarchy

See Also:

org.kuali.kra.proposaldevelopment.hierarchy.service.ProposalHierarchySyncService#synchronizeChild(java.lang.String)

synchronizeChildProposalBudget

public void synchronizeChildProposalBudget(ProposalDevelopmentBudgetExt budget,
                                  DevelopmentProposal childProposal)
                                    throws ProposalHierarchyException

Description copied from interface: ProposalHierarchyService

This method syncs only the budget from the child proposal specificed to the hierarchy budget.

Specified by:

synchronizeChildProposalBudget in interface ProposalHierarchyService

Throws:

ProposalHierarchyException

lookupParent

public DevelopmentProposal lookupParent(DevelopmentProposal childProposal)
                                 throws ProposalHierarchyException

Specified by:

lookupParent in interface ProposalHierarchyService

Throws:

ProposalHierarchyException

See Also:

ProposalHierarchyService.lookupParent(org.kuali.kra.proposaldevelopment.bo.DevelopmentProposal)

linkChild

protected void linkChild(DevelopmentProposal hierarchyProposal,
             DevelopmentProposal newChildProposal,
             String hierarchyBudgetTypeCode)
                  throws ProposalHierarchyException

Throws:

ProposalHierarchyException

copyInitialData

protected void copyInitialData(DevelopmentProposal hierarchyProposal,
                   DevelopmentProposal srcProposal)
                        throws ProposalHierarchyException

Throws:

ProposalHierarchyException

synchronizeAllChildProposals

protected boolean synchronizeAllChildProposals(DevelopmentProposal hierarchyProposal)
                                        throws ProposalHierarchyException

Synchronizes all child proposals to the parent.

Parameters:

hierarchyProposal -

Returns:

Throws:

ProposalHierarchyException

synchronizeChildProposal

protected boolean synchronizeChildProposal(DevelopmentProposal hierarchyProposal,
                               DevelopmentProposal childProposal)
                                    throws ProposalHierarchyException

Synchronizes the given child proposal to the parent.

If a key protocol person appears in multiple child proposals and is removed from the given child proposal, then this also aggregates that key person back to the parent proposal from a different child proposal, making sure that all the key persons in all of the child proposals are represented in the parent proposal.

Parameters:

hierarchyProposal -

childProposal -

Returns:

Throws:

ProposalHierarchyException

synchronizeChildProposalBudget

protected boolean synchronizeChildProposalBudget(DevelopmentProposal hierarchyProposal,
                                     ProposalDevelopmentBudgetExt budget,
                                     DevelopmentProposal childProposal)
                                          throws ProposalHierarchyException

Throws:

ProposalHierarchyException

getOldKeywords

protected List<PropScienceKeyword> getOldKeywords(DevelopmentProposal hierarchyProposal,
                                      DevelopmentProposal childProposal)

Gets the old proposal science keywords before removing them from the parent.

Parameters:

hierarchyProposal -

childProposal -

Returns:

synchronizeKeywords

protected void synchronizeKeywords(DevelopmentProposal hierarchyProposal,
                       DevelopmentProposal childProposal,
                       List<PropScienceKeyword> oldKeywords)

Synchronizes the proposal science keywords from the child proposal to the parent proposal.

Parameters:

hierarchyProposal -

childProposal -

oldKeywords -

synchronizeSpecialReviews

protected void synchronizeSpecialReviews(DevelopmentProposal hierarchyProposal,
                             DevelopmentProposal childProposal)

Synchronizes the proposal special reviews from the child proposal to the parent proposal.

Parameters:

hierarchyProposal -

childProposal -

synchronizeNarratives

protected void synchronizeNarratives(DevelopmentProposal hierarchyProposal,
                         DevelopmentProposal childProposal)

Synchronizes the proposal narratives from the child proposal to the parent proposal.

Parameters:

hierarchyProposal -

childProposal -

synchronizePersonsAndAggregate

protected void synchronizePersonsAndAggregate(DevelopmentProposal hierarchyProposal,
                                  DevelopmentProposal primaryChildProposal,
                                  ProposalPerson principalInvestigator)

Synchronizes the proposal persons from the child proposal to the parent proposal and then restores any proposal persons that were in the given child proposal (and hence removed from the given parent proposal).

This first synchronizes the main proposal persons from the primary child proposal to the parent proposal and then runs the same algorithm on all other children of the parent proposal.

Parameters:

hierarchyProposal -

primaryChildProposal -

principalInvestigator -

synchronizePersons

protected void synchronizePersons(DevelopmentProposal hierarchyProposal,
                      DevelopmentProposal childProposal,
                      ProposalPerson principalInvestigator)

Synchronizes the proposal persons from the child proposal to the parent proposal.

Parameters:

hierarchyProposal -

childProposal -

principalInvestigator -

synchronizeBudget

protected void synchronizeBudget(DevelopmentProposal hierarchyProposal,
                     DevelopmentProposal childProposal,
                     Budget hierarchyBudget,
                     ProposalDevelopmentBudgetExt childBudget,
                     BudgetDocument hierarchyBudgetDocument)
                          throws ProposalHierarchyException

Synchronizes the proposal budget from the child proposal to the parent proposal.

Parameters:

hierarchyProposal -

childProposal -

hierarchyBudget -

childBudget -

hierarchyBudgetDocument -

Throws:

ProposalHierarchyException

syncProposalPersons

protected void syncProposalPersons(DevelopmentProposal childProposal,
                       DevelopmentProposal hierarchyProposal,
                       ProposalPerson pi,
                       List<ProposalPerson> removedPersons)

synchronizeChildBudget

protected void synchronizeChildBudget(Budget parentBudget,
                          Budget childBudget,
                          String childProposalNumber,
                          String hierarchyBudgetTypeCode,
                          boolean isOriginatingChildBudget)
                               throws ProposalHierarchyException

Throws:

ProposalHierarchyException

findOrCreateMatchingPeriod

protected BudgetPeriod findOrCreateMatchingPeriod(BudgetPeriod childPeriod,
                                      Budget parentBudget)

aggregateHierarchy

protected void aggregateHierarchy(DevelopmentProposal hierarchy)
                           throws ProposalHierarchyException

Throws:

ProposalHierarchyException

getHierarchy

protected DevelopmentProposal getHierarchy(String hierarchyProposalNumber)
                                    throws ProposalHierarchyException

Throws:

ProposalHierarchyException

getDevelopmentProposal

public DevelopmentProposal getDevelopmentProposal(String proposalNumber)

Specified by:

getDevelopmentProposal in interface ProposalHierarchyService

isSynchronized

protected boolean isSynchronized(String childProposalNumber)
                          throws ProposalHierarchyException

Throws:

ProposalHierarchyException

isSynchronized

protected boolean isSynchronized(DevelopmentProposal childProposal)
                          throws ProposalHierarchyException

Throws:

ProposalHierarchyException

isBudgetSynchronized

protected boolean isBudgetSynchronized(String childProposalNumber)
                                throws ProposalHierarchyException

Throws:

ProposalHierarchyException

isBudgetSynchronized

protected boolean isBudgetSynchronized(DevelopmentProposal childProposal,
                           ProposalDevelopmentBudgetExt childBudget)
                                throws ProposalHierarchyException

Throws:

ProposalHierarchyException

setInitialPi

protected void setInitialPi(DevelopmentProposal hierarchy,
                DevelopmentProposal child)

getHierarchyBudgets

protected List<BudgetDocument<DevelopmentProposal>> getHierarchyBudgets(DevelopmentProposal hierarchyProposal)
                                                                 throws ProposalHierarchyException

Throws:

ProposalHierarchyException

getHierarchyBudget

protected BudgetDocument<DevelopmentProposal> getHierarchyBudget(DevelopmentProposal hierarchyProposal)
                                                          throws ProposalHierarchyException

Throws:

ProposalHierarchyException

getSyncableBudget

public BudgetDocument<DevelopmentProposal> getSyncableBudget(DevelopmentProposal childProposal)
                                                      throws ProposalHierarchyException

Description copied from interface: ProposalHierarchyService

Gets the budget for hierarchy sync. This will be the budget marked final or the most recently created budget.

Specified by:

getSyncableBudget in interface ProposalHierarchyService

Returns:

Throws:

ProposalHierarchyException

initializeBudget

protected void initializeBudget(DevelopmentProposal hierarchyProposal,
                    DevelopmentProposal childProposal)
                         throws ProposalHierarchyException

Throws:

ProposalHierarchyException

validateChildBudgetPeriods

public ProposalHierarchyErrorDto validateChildBudgetPeriods(DevelopmentProposal hierarchyProposal,
                                                   DevelopmentProposal childProposal,
                                                   boolean allowEndDateChange)
                                                     throws ProposalHierarchyException

Specified by:

validateChildBudgetPeriods in interface ProposalHierarchyService

Throws:

ProposalHierarchyException

getCorrespondingParentPeriod

protected int getCorrespondingParentPeriod(Budget parentBudget,
                               Budget childBudget)

removeChildElements

protected void removeChildElements(DevelopmentProposal parentProposal,
                       Budget parentBudget,
                       String childProposalNumber)

removeChildBudgetElements

protected void removeChildBudgetElements(DevelopmentProposal parentProposal,
                             Budget parentBudget,
                             String childProposalNumber)

prepareHierarchySync

protected void prepareHierarchySync(DevelopmentProposal hierarchyProposal)

prepareHierarchySync

protected void prepareHierarchySync(ProposalDevelopmentDocument pdDoc)

finalizeHierarchySync

protected void finalizeHierarchySync(ProposalDevelopmentDocument pdDoc)
                              throws ProposalHierarchyException

Throws:

ProposalHierarchyException

finalizeHierarchySync

protected void finalizeHierarchySync(DevelopmentProposal hierarchyProposal)
                              throws ProposalHierarchyException

Throws:

ProposalHierarchyException

copyInitialAttachments

protected void copyInitialAttachments(DevelopmentProposal srcProposal,
                          DevelopmentProposal destProposal)

loadAttachmentContent

protected void loadAttachmentContent(Narrative narrative)

loadBioContent

protected void loadBioContent(ProposalPersonBiography bio)

getHierarchyChildRouteStatus

public String getHierarchyChildRouteStatus(String oldStatus,
                                  String newStatus)

Description copied from interface: ProposalHierarchyService

Calculate the AppDocStatus that should be applied to children of a parent moving from oldStatus to newStatus.

Specified by:

getHierarchyChildRouteStatus in interface ProposalHierarchyService

Parameters:

oldStatus - The old workflow status of the parent document.

newStatus - The new workflow status of the parent document.

Returns:

The AppWorkDocStatus that should be set in a children.

See Also:

ProposalHierarchyService.getHierarchyChildRouteStatus(java.lang.String, java.lang.String)

computeHierarchyHashCode

protected int computeHierarchyHashCode(DevelopmentProposal proposal)

Creates a hash of the data pertinent to a hierarchy for comparison during hierarchy syncing.

computeHierarchyHashCode

protected int computeHierarchyHashCode(Budget budget)

Creates a hash of the data pertinent to a hierarchy for comparison during hierarchy syncing.

getChildProposalDevelopmentDocuments

public List<ProposalDevelopmentDocument> getChildProposalDevelopmentDocuments(String parentProposalNumber)
                                                                       throws ProposalHierarchyException

Description copied from interface: ProposalHierarchyService

Get a list of ProposalDevelopmentDocuments that are children of proposal number provided.

Specified by:

getChildProposalDevelopmentDocuments in interface ProposalHierarchyService

Parameters:

parentProposalNumber - the proposal number of the hierarchy parent.

Returns:

List of ProposalDevelopmentDocuments

Throws:

ProposalHierarchyException - if the provided proposal is not a hierarchy.

See Also:

ProposalHierarchyService.getChildProposalDevelopmentDocuments(java.lang.String)

getHierarchyChildren

public List<DevelopmentProposal> getHierarchyChildren(String parentProposalNumber)

Description copied from interface: ProposalHierarchyService

Get a list of DevelopmentProposals that are children of proposal number provided.

Specified by:

getHierarchyChildren in interface ProposalHierarchyService

Parameters:

parentProposalNumber - the proposal number of the hierarchy parent.

Returns:

List of DevelopmentProposals

See Also:

ProposalHierarchyService.getHierarchyChildren(java.lang.String)

getParentWorkflowDocument

public org.kuali.rice.kew.api.WorkflowDocument getParentWorkflowDocument(ProposalDevelopmentDocument child)
                                                                  throws ProposalHierarchyException

Description copied from interface: ProposalHierarchyService

Get the parent workflow document of the hierarchy child document. This is a utility method.

Specified by:

getParentWorkflowDocument in interface ProposalHierarchyService

Parameters:

child - The child in question

Returns:

The KualiWorklowDocument of the child's parent.

Throws:

ProposalHierarchyException - if the provided proposal is not in a hierarchy.

See Also:

org.kuali.kra.proposaldevelopment.hierarchy.service.ProposalHierarchyService#getParentWorkflowStatus(org.kuali.kra.proposaldevelopment.bo.DevelopmentProposal)

getParentDocument

public ProposalDevelopmentDocument getParentDocument(ProposalDevelopmentDocument child)
                                              throws ProposalHierarchyException

Description copied from interface: ProposalHierarchyService

Get the parent document of the hierarchy child document. This is a utility method.

Specified by:

getParentDocument in interface ProposalHierarchyService

Parameters:

child - The child in question

Returns:

The Document of the child's parent.

Throws:

ProposalHierarchyException - if the provided proposal is not in a hierarchy.

See Also:

ProposalHierarchyService.getParentDocument(org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument)

rejectProposal

protected void rejectProposal(ProposalDevelopmentDocument proposalDoc,
                  String reason,
                  String principalId,
                  String appDocStatus)
                       throws org.kuali.rice.kew.api.exception.WorkflowException

Reject a proposal by sending it to the first node ( as named by PROPOSALDEVELOPMENTDOCUMENT_KEW_INITIAL_NODE_NAME )

Parameters:

proposalDoc - The ProposalDevelopmentDocument that should be rejected.

appDocStatus - the application status to set in the workflow document.

principalId - the principal we are rejecting the document as.

appDocStatus - the application document status to apply ( does not apply if null )

Throws:

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

rejectProposalHierarchy

protected void rejectProposalHierarchy(ProposalDevelopmentDocument hierarchyParent,
                           String reason,
                           String principalId)
                                throws ProposalHierarchyException

Reject an entire proposal hierarchy. This works by first rejecting each child, and then rejecting the parent.

Parameters:

hierarchyParent - The hierarchy to reject

reason - the reason to be applied to the annotation field. The reason will be pre-pended with static text indicating if it was a child or the parent.

principalName - the name of the principal that is rejecting the document.

Throws:

ProposalHierarchyException - If hierarchyParent is not a hierarchy, or there was a problem rejecting one of the documents.

rejectProposalDevelopmentDocument

public void rejectProposalDevelopmentDocument(String proposalNumber,
                                     String reason,
                                     String principalName,
                                     org.apache.struts.upload.FormFile rejectFile)
                                       throws org.kuali.rice.kew.api.exception.WorkflowException,
                                              ProposalHierarchyException,
                                              IOException

Description copied from interface: ProposalHierarchyService

Reject a proposal development document by proposal number. This will return a proposal to state almost but not quite like initiated state. If the proposal is a hierarchy all of the children will be returned to the initiated state as well.

Specified by:

rejectProposalDevelopmentDocument in interface ProposalHierarchyService

Parameters:

proposalNumber - the proposalNumber you wish to reject

reason - the reason why it is rejected. Will be added to the route log.

principalName - The princpal to reject the document as.

rejectFile - The file uploaded when the proposoal development was rejected.

Throws:

org.kuali.rice.kew.api.exception.WorkflowException - if there is a problem getting the workflow document, or rejecting the document.

ProposalHierarchyException

IOException - if there is a problem with the upload file.

See Also:

org.kuali.kra.proposaldevelopment.hierarchy.service.ProposalHierarchyService#rejectProposalDevelopmentDocument(java.lang.String, java.lang.String)

calculateChildRouteStatus

protected String calculateChildRouteStatus(ProposalDevelopmentDocument hierarchy,
                               org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange dto)

Based on the hierarchy, and route status change of the parent, calculate what route action should be taken on the children.

Parameters:

hierarchy - the heirarchy being routed

dto - the route status change information.

Returns:

The route action to take on the children.

routeHierarchyChildren

public void routeHierarchyChildren(ProposalDevelopmentDocument proposalDevelopmentDocument,
                          org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange dto)
                            throws ProposalHierarchyException

Description copied from interface: ProposalHierarchyService

Given the proposalDevelopmentDocument, RouteStatusChangeDTO, and the current user principal name, route all of the child proposal appropriately.

Specified by:

routeHierarchyChildren in interface ProposalHierarchyService

Parameters:

proposalDevelopmentDocument - The heirarchy being routed.

dto - the route status change dto object.

Throws:

ProposalHierarchyException - If there is a problem routing the children.

See Also:

org.kuali.kra.proposaldevelopment.hierarchy.service.ProposalHierarchyService#routeHierarchyChildren(org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument, org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange, java.lang.String)

calculateAndSetProposalAppDocStatus

public void calculateAndSetProposalAppDocStatus(ProposalDevelopmentDocument doc,
                                       org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange dto)
                                         throws ProposalHierarchyException

Specified by:

calculateAndSetProposalAppDocStatus in interface ProposalHierarchyService

Throws:

ProposalHierarchyException

updateAppDocStatus

public void updateAppDocStatus(ProposalDevelopmentDocument doc,
                      String principalId,
                      String newStatus)
                        throws ProposalHierarchyException

Description copied from interface: ProposalHierarchyService

Update the app doc status for the given document. Workflow ignores a null or empty value so once you set this you have to manage it after that point.

Specified by:

updateAppDocStatus in interface ProposalHierarchyService

Parameters:

doc - The proposal dev document you want to update.

principalId - the principal id to update it as.

newStatus - the new status, can be any string.

Throws:

ProposalHierarchyException

allChildBudgetsAreComplete

public boolean allChildBudgetsAreComplete(String parentProposalNumber)

Specified by:

allChildBudgetsAreComplete in interface ProposalHierarchyService

rolesAreSimilar

protected boolean rolesAreSimilar(ProposalPerson person1,
                      ProposalPerson person2)

getHierarchyPersonnelSummaries

public List<HierarchyPersonnelSummary> getHierarchyPersonnelSummaries(String parentProposalNumber)
                                                               throws ProposalHierarchyException

Specified by:

getHierarchyPersonnelSummaries in interface ProposalHierarchyService

Throws:

ProposalHierarchyException

See Also:

ProposalHierarchyService.getHierarchyPersonnelSummaries(java.lang.String)

getHierarchyProposalSummaries

public List<HierarchyProposalSummary> getHierarchyProposalSummaries(String proposalNumber)
                                                             throws ProposalHierarchyException

Specified by:

getHierarchyProposalSummaries in interface ProposalHierarchyService

Throws:

ProposalHierarchyException

See Also:

ProposalHierarchyService.getHierarchyProposalSummaries(java.lang.String)

getProposalSummary

public HierarchyProposalSummary getProposalSummary(String proposalNumber)
                                            throws ProposalHierarchyException

Specified by:

getProposalSummary in interface ProposalHierarchyService

Throws:

ProposalHierarchyException

validateRemovePermissions

public boolean validateRemovePermissions(DevelopmentProposal childProposal,
                                String principalId)

Specified by:

validateRemovePermissions in interface ProposalHierarchyService

renderMessage

protected String renderMessage(String key,
                   String... params)

getKraDocumentRejectionService

public KraDocumentRejectionService getKraDocumentRejectionService()

setKraDocumentRejectionService

public void setKraDocumentRejectionService(KraDocumentRejectionService kraDocumentRejectionService)

setSessionDocumentService

public void setSessionDocumentService(org.kuali.rice.kns.service.SessionDocumentService sessionDocumentService)

setWorkflowDocumentService

public void setWorkflowDocumentService(org.kuali.rice.krad.workflow.service.WorkflowDocumentService workflowDocumentService)

getBusinessObjectService

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

getDocumentService

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

getKraAuthorizationService

protected KraAuthorizationService getKraAuthorizationService()

getProposalHierarchyDao

protected ProposalHierarchyDao getProposalHierarchyDao()

getNarrativeService

protected NarrativeService getNarrativeService()

getBudgetService

protected BudgetService getBudgetService()

getPropPersonBioService

protected ProposalPersonBiographyService getPropPersonBioService()

getParameterService

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

getIdentityManagementService

protected org.kuali.rice.kim.api.identity.IdentityService getIdentityManagementService()

getConfigurationService

protected org.kuali.rice.core.api.config.property.ConfigurationService getConfigurationService()

getProposalPersonExtendedAttributesToDelete

protected List<ProposalPersonExtendedAttributes> getProposalPersonExtendedAttributesToDelete()

getSessionDocumentService

protected org.kuali.rice.kns.service.SessionDocumentService getSessionDocumentService()

getWorkflowDocumentService

protected org.kuali.rice.krad.workflow.service.WorkflowDocumentService getWorkflowDocumentService()

getBudgetSummaryService

public BudgetSummaryService getBudgetSummaryService()

setBudgetSummaryService

public void setBudgetSummaryService(BudgetSummaryService budgetSummaryService)