org.kuali.kra.proposaldevelopment.service

Interface ProposalStateService

All Known Implementing Classes:

ProposalStateServiceImpl

public interface ProposalStateService

The Proposal State Service is responsible for computing the state of a proposal. The well-defined states are:

• In Progress
• Approval Pending
• Approval Granted
• Approval Not Initiated - Submitted
• Approval Pending - Submitted
• Approved and Submitted
• Disapproved
• Approved Post-Submission
• Disapproved Post-Submission
• Canceled
• Document Error Occurred

Method Summary

Methods

Modifier and Type	Method and Description
String	getProposalStateTypeCode(ProposalDevelopmentDocument proposalDevelopmentDocument, boolean isRouteStatusChanged, boolean isReject) Get the Proposal State type code based upon the current configuration of the given proposal.

Method Detail

getProposalStateTypeCode

String getProposalStateTypeCode(ProposalDevelopmentDocument proposalDevelopmentDocument,
                              boolean isRouteStatusChanged,
                              boolean isReject)

Get the Proposal State type code based upon the current configuration of the given proposal. The Proposal State must be recomputed whenever the workflow route status changes or when the proposal is submitted to the sponsor. The order matters. For example, if the proposal is approved and then submitted, the state is "Approved and Submitted". If the proposal is submitted first and then approved, the state is "Approved Post-Submission".

Parameters:

proposalDevelopmentDocument - the proposal development document

isRouteStatusChanged - was the route status just changed (if false, the proposal was submitted to the sponsor)

isReject - was the action taken a rejection of the document?

Returns:

the proposal state type code