org.kuali.kra.proposaldevelopment.hierarchy.service

Interface ProposalHierarchyService

All Known Implementing Classes:

ProposalHierarchyServiceImpl

public interface ProposalHierarchyService

This class...

Field Summary

Fields

Modifier and Type	Field and Description
static String	HIERARCHY_CANCEL_APPSTATUS
static String	HIERARCHY_CHILD_CANCEL_APPSTATUS
static String	HIERARCHY_CHILD_DISAPPROVE_APPSTATUS
static String	HIERARCHY_CHILD_ENROUTE_APPSTATUS
static String	HIERARCHY_CHILD_FINAL_APPSTATUS
static String	HIERARCHY_CHILD_PROCESSED_APPSTATUS
static String	HIERARCHY_CHILD_REJECTED_APPSTATUS
static String	HIERARCHY_DISAPPROVE_APPSTATUS
static String	HIERARCHY_ENROUTE_APPSTATUS
static String	HIERARCHY_FINAL_APPSTATUS
static String	HIERARCHY_PROCESSED_APPSTATUS
static String	HIERARCHY_REJECTED_APPSTATUS
static String	HIERARCHY_ROUTING_PARENT_APPROVED_ANNOTATION
static String	HIERARCHY_ROUTING_PARENT_CANCELLED_ANNOTATION
static String	HIERARCHY_ROUTING_PARENT_DISAPPROVED_ANNOTATION
static String	HIERARCHY_ROUTING_PARENT_REJECTED_ANNOTATION
static String	HIERARCHY_ROUTING_PARENT_RESUBMITTED_ANNOTATION
static String	HIERARCHY_ROUTING_PARENT_SUBMITTED_ANNOTATION
static String	PROPOSAL_DEVELOPMENT_DOCUMENT_TYPE
static String	PROPOSAL_ROUTING_REJECTED_ANNOTATION

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allChildBudgetsAreComplete(String parentProposalNumber)
void	calculateAndSetProposalAppDocStatus(ProposalDevelopmentDocument doc, org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange dto)
String	createHierarchy(DevelopmentProposal initialChild) This method takes a proposal, creates a Hierarchy and links the proposal as the initial child.
List<ProposalDevelopmentDocument>	getChildProposalDevelopmentDocuments(String parentProposalNumber) Get a list of ProposalDevelopmentDocuments that are children of proposal number provided.
DevelopmentProposal	getDevelopmentProposal(String proposalNumber)
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)
ProposalDevelopmentDocument	getParentDocument(ProposalDevelopmentDocument doc) Get the parent document of the hierarchy child document.
org.kuali.rice.kew.api.WorkflowDocument	getParentWorkflowDocument(ProposalDevelopmentDocument doc) Get the parent workflow document of the hierarchy child document.
HierarchyProposalSummary	getProposalSummary(String proposalNumber)
BudgetDocument<DevelopmentProposal>	getSyncableBudget(DevelopmentProposal childProposal) Gets the budget for hierarchy sync.
void	linkToHierarchy(DevelopmentProposal hierarchyProposal, DevelopmentProposal newChildProposal, String hierarchyBudgetTypeCode) This method links a proposal to a Hierarchy.
DevelopmentProposal	lookupParent(DevelopmentProposal childProposal)
void	rejectProposalDevelopmentDocument(String proposalNumber, String reason, String principalId, org.apache.struts.upload.FormFile rejectFile) Reject a proposal development document by proposal number.
void	removeFromHierarchy(DevelopmentProposal childProposal) This method removes childProposal from the hierarchy of which it is a member
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	synchronizeAllChildren(ProposalDevelopmentDocument hierarchyProposalDocument) This method synchronizes the contents of all children into the hierarchy.
void	synchronizeChild(DevelopmentProposal childProposal) This method synchronizes the contents of one child into its hierarchy.
void	synchronizeChildProposalBudget(ProposalDevelopmentBudgetExt budget, DevelopmentProposal childProposal) This method syncs only the budget from the child proposal specificed to the hierarchy budget.
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)

Field Detail

HIERARCHY_CHILD_ENROUTE_APPSTATUS

static final String HIERARCHY_CHILD_ENROUTE_APPSTATUS

See Also:

Constant Field Values

HIERARCHY_CHILD_CANCEL_APPSTATUS

static final String HIERARCHY_CHILD_CANCEL_APPSTATUS

See Also:

Constant Field Values

HIERARCHY_CHILD_DISAPPROVE_APPSTATUS

static final String HIERARCHY_CHILD_DISAPPROVE_APPSTATUS

See Also:

Constant Field Values

HIERARCHY_CHILD_PROCESSED_APPSTATUS

static final String HIERARCHY_CHILD_PROCESSED_APPSTATUS

See Also:

Constant Field Values

HIERARCHY_CHILD_FINAL_APPSTATUS

static final String HIERARCHY_CHILD_FINAL_APPSTATUS

See Also:

Constant Field Values

HIERARCHY_CHILD_REJECTED_APPSTATUS

static final String HIERARCHY_CHILD_REJECTED_APPSTATUS

See Also:

Constant Field Values

HIERARCHY_REJECTED_APPSTATUS

static final String HIERARCHY_REJECTED_APPSTATUS

See Also:

Constant Field Values

HIERARCHY_ENROUTE_APPSTATUS

static final String HIERARCHY_ENROUTE_APPSTATUS

See Also:

Constant Field Values

HIERARCHY_CANCEL_APPSTATUS

static final String HIERARCHY_CANCEL_APPSTATUS

See Also:

Constant Field Values

HIERARCHY_DISAPPROVE_APPSTATUS

static final String HIERARCHY_DISAPPROVE_APPSTATUS

See Also:

Constant Field Values

HIERARCHY_PROCESSED_APPSTATUS

static final String HIERARCHY_PROCESSED_APPSTATUS

See Also:

Constant Field Values

HIERARCHY_FINAL_APPSTATUS

static final String HIERARCHY_FINAL_APPSTATUS

See Also:

Constant Field Values

HIERARCHY_ROUTING_PARENT_DISAPPROVED_ANNOTATION

static final String HIERARCHY_ROUTING_PARENT_DISAPPROVED_ANNOTATION

See Also:

Constant Field Values

HIERARCHY_ROUTING_PARENT_APPROVED_ANNOTATION

static final String HIERARCHY_ROUTING_PARENT_APPROVED_ANNOTATION

See Also:

Constant Field Values

HIERARCHY_ROUTING_PARENT_CANCELLED_ANNOTATION

static final String HIERARCHY_ROUTING_PARENT_CANCELLED_ANNOTATION

See Also:

Constant Field Values

HIERARCHY_ROUTING_PARENT_SUBMITTED_ANNOTATION

static final String HIERARCHY_ROUTING_PARENT_SUBMITTED_ANNOTATION

See Also:

Constant Field Values

HIERARCHY_ROUTING_PARENT_RESUBMITTED_ANNOTATION

static final String HIERARCHY_ROUTING_PARENT_RESUBMITTED_ANNOTATION

See Also:

Constant Field Values

HIERARCHY_ROUTING_PARENT_REJECTED_ANNOTATION

static final String HIERARCHY_ROUTING_PARENT_REJECTED_ANNOTATION

See Also:

Constant Field Values

PROPOSAL_ROUTING_REJECTED_ANNOTATION

static final String PROPOSAL_ROUTING_REJECTED_ANNOTATION

See Also:

Constant Field Values

PROPOSAL_DEVELOPMENT_DOCUMENT_TYPE

static final String PROPOSAL_DEVELOPMENT_DOCUMENT_TYPE

See Also:

Constant Field Values

Method Detail

createHierarchy

String createHierarchy(DevelopmentProposal initialChild)
                       throws ProposalHierarchyException

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

Parameters:

initialChildProposal -

Returns:

the proposal number of the new hierarchy

Throws:

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

linkToHierarchy

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

This method links a proposal to a Hierarchy.

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

removeFromHierarchy

void removeFromHierarchy(DevelopmentProposal childProposal)
                         throws ProposalHierarchyException

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

Parameters:

childProposal - the proposal to remove

Throws:

ProposalHierarchyException - if childProposal is not a member of a hierarchy

synchronizeChild

void synchronizeChild(DevelopmentProposal childProposal)
                      throws ProposalHierarchyException

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

Parameters:

childProposal - the child proposal in question

Throws:

ProposalHierarchyException - if childProposal is not a member of a hierarchy

synchronizeChildProposalBudget

void synchronizeChildProposalBudget(ProposalDevelopmentBudgetExt budget,
                                  DevelopmentProposal childProposal)
                                    throws ProposalHierarchyException

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

Parameters:

childProposal -

Throws:

ProposalHierarchyException

synchronizeAllChildren

void synchronizeAllChildren(ProposalDevelopmentDocument hierarchyProposalDocument)
                            throws ProposalHierarchyException

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

Parameters:

hierarchyProposalDocument - the hierarchy in question

Throws:

ProposalHierarchyException - if hierarchyProposalDocument is not a valid Hierarchy

getDevelopmentProposal

DevelopmentProposal getDevelopmentProposal(String proposalNumber)

lookupParent

DevelopmentProposal lookupParent(DevelopmentProposal childProposal)
                                 throws ProposalHierarchyException

Throws:

ProposalHierarchyException

getHierarchyPersonnelSummaries

List<HierarchyPersonnelSummary> getHierarchyPersonnelSummaries(String parentProposalNumber)
                                                               throws ProposalHierarchyException

Throws:

ProposalHierarchyException

getHierarchyProposalSummaries

List<HierarchyProposalSummary> getHierarchyProposalSummaries(String proposalNumber)
                                                             throws ProposalHierarchyException

Throws:

ProposalHierarchyException

validateChildBudgetPeriods

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

Throws:

ProposalHierarchyException

getParentWorkflowDocument

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

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

Parameters:

doc - The child in question

Returns:

The KualiWorklowDocument of the child's parent.

Throws:

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

getParentDocument

ProposalDevelopmentDocument getParentDocument(ProposalDevelopmentDocument doc)
                                              throws ProposalHierarchyException

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

Parameters:

doc - The child in question

Returns:

The Document of the child's parent.

Throws:

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

getHierarchyChildRouteStatus

String getHierarchyChildRouteStatus(String oldStatus,
                                  String newStatus)

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

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.

getHierarchyChildren

List<DevelopmentProposal> getHierarchyChildren(String parentProposalNumber)
                                               throws ProposalHierarchyException

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

Parameters:

parentProposalNumber - the proposal number of the hierarchy parent.

Returns:

List of DevelopmentProposals

Throws:

ProposalHierarchyException - if the provided proposal is not a hierarchy.

getChildProposalDevelopmentDocuments

List<ProposalDevelopmentDocument> getChildProposalDevelopmentDocuments(String parentProposalNumber)
                                                                       throws ProposalHierarchyException

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

Parameters:

parentProposalNumber - the proposal number of the hierarchy parent.

Returns:

List of ProposalDevelopmentDocuments

Throws:

ProposalHierarchyException - if the provided proposal is not a hierarchy.

rejectProposalDevelopmentDocument

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

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.

Parameters:

proposalNumber - the proposalNumber you wish to reject

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

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

routeHierarchyChildren

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

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

Parameters:

proposalDevelopmentDocument - The heirarchy being routed.

dto - the route status change dto object.

currentUserPrincipalName - the name of the user to perform submit or approve operations on the child document.

Throws:

ProposalHierarchyException - If there is a problem routing the children.

allChildBudgetsAreComplete

boolean allChildBudgetsAreComplete(String parentProposalNumber)

validateRemovePermissions

boolean validateRemovePermissions(DevelopmentProposal childProposal,
                                String principalId)

updateAppDocStatus

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

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.

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

calculateAndSetProposalAppDocStatus

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

Throws:

ProposalHierarchyException

getSyncableBudget

BudgetDocument<DevelopmentProposal> getSyncableBudget(DevelopmentProposal childProposal)
                                                      throws ProposalHierarchyException

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

Parameters:

childProposal -

Returns:

Throws:

ProposalHierarchyException

getProposalSummary

HierarchyProposalSummary getProposalSummary(String proposalNumber)
                                            throws ProposalHierarchyException

Throws:

ProposalHierarchyException