ProposalCopyServiceImpl (Kuali Coeus 5.1.1 API)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`ProposalCopyServiceImpl.DocProperty` Each property in the document that can be copied is represented by its getter and setter method.

Constructor Summary

Constructors
Constructor and Description

ProposalCopyServiceImpl()

Constructors
Constructor and Description
`ProposalCopyServiceImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`clearCertifyQuestions(ProposalDevelopmentDocument doc)` Clear the Certify questions for each investigator.
`protected void`	`copyAndFinalizeBudgetVersion(String documentNumber, ProposalDevelopmentDocument dest, int budgetVersionNumber, boolean resetRates)`
`protected void`	`copyAttachments(ProposalDevelopmentDocument src, ProposalDevelopmentDocument dest)` Copy the Attachments (proposal, personal, and institutional) to the new document.
`protected void`	`copyBudget(ProposalDevelopmentDocument src, ProposalDevelopmentDocument dest, String budgetVersions)` This method...
`protected void`	`copyCustomData(ProposalDevelopmentDocument src, ProposalDevelopmentDocument dest)` This method copies all custom data from one document to another.
`protected void`	`copyOverviewProperties(ProposalDevelopmentDocument src, ProposalDevelopmentDocument dest)` Copies the document overview properties.
`protected void`	`copyProperties(DevelopmentProposal src, DevelopmentProposal dest, List<ProposalCopyServiceImpl.DocProperty> properties)`
`String`	`copyProposal(ProposalDevelopmentDocument doc, ProposalCopyCriteria criteria)` Copy a proposal development document.
`protected void`	`copyProposal(ProposalDevelopmentDocument src, ProposalDevelopmentDocument dest, ProposalCopyCriteria criteria)` Copies the source proposal development document to the destination document.
`protected void`	`copyProposalProperties(ProposalDevelopmentDocument src, ProposalDevelopmentDocument dest)` Copies over the "normal" Proposal Development Document properties.
`protected void`	`copyRequiredProperties(ProposalDevelopmentDocument srcDoc, ProposalDevelopmentDocument destDoc)` Copy over the required properties so we can do an initial save of the document in order to obtain a proposal number.
`protected ProposalDevelopmentDocument`	`createNewProposal(ProposalDevelopmentDocument srcDoc, ProposalCopyCriteria criteria)` Create a new proposal based upon a source proposal.
`protected ProposalPersonUnit`	`createProposalPersonUnit(ProposalPerson person, String unitNumber, boolean isLeadUnit, boolean isDeletable, List<ProposalPersonUnit> oldProposalPersonUnits)`
`protected ProposalPersonUnit`	`findProposalPersonUnit(String unitNumber, List<ProposalPersonUnit> proposalPersonUnits)`
`protected void`	`fixBudgetVersions(ProposalDevelopmentDocument doc)` Fix data related to Budget Versions.
`protected void`	`fixCongressionalDistricts(ProposalDevelopmentDocument doc)` This method sets all congressional district ids to null, so new ids get assigned to them.
`protected void`	`fixKeyPersonnel(ProposalDevelopmentDocument doc, String oldLeadUnitNumber, String newLeadUnitNumber)` Fix the Key Personnel.
`protected void`	`fixKeyPersonnelUnits(ProposalDevelopmentDocument doc, String oldLeadUnitNumber, String newLeadUnitNumber)` Fix the Key Personnel.
`protected void`	`fixNextValues(ProposalDevelopmentDocument oldDoc, ProposalDevelopmentDocument newDoc)` The document next values must be the same in the new version as in the old document.
`protected void`	`fixNumericProperty(Object object, String methodName, Class clazz, Object propertyValue, Map<String,Object> objectMap)` Recurse through all of the BOs and if a BO has a specific property, set its value to the new value.
`protected void`	`fixOrganizationAndLocations(ProposalDevelopmentDocument doc)` If the Lead Unit has changed in the previous `Document`, then this method corrects related properties `Organization` and `ProposalSite` instances
`protected void`	`fixProposal(ProposalDevelopmentDocument srcDoc, ProposalDevelopmentDocument newDoc, ProposalCopyCriteria criteria)` Fix the proposal.
`protected void`	`fixProposalNumbers(Object object, String proposalNumber, List<Object> list)` Recurse through all of the BOs and if a BO has a ProposalNumber property, set its value to the new proposal number.
`BudgetService<DevelopmentProposal>`	`getBudgetService()` Gets the budgetService attribute.
`BudgetSummaryService`	`getBudgetSummaryService()` Gets the budgetSummaryService attribute.
`protected List<ProposalCopyServiceImpl.DocProperty>`	`getCopyableProperties()` Get the list of DevelopmentProposal properties that can be copied.
`protected org.kuali.rice.core.api.datetime.DateTimeService`	`getDateTimeService()`
`protected Method`	`getGetter(String name, Method[] methods)` Gets the getter method for a property.
`protected org.kuali.rice.krad.service.KualiRuleService`	`getKualiRuleService()` Get the Kuali Rule Service.
`protected String`	`getPropertyName(Method method)` Get the name of a property.
`QuestionnaireAnswerService`	`getQuestionnaireAnswerService()` Gets the questionnaireAnswerService attribute.
`QuestionnaireService`	`getQuestionnaireService()` Gets the questionnaireService attribute.
`protected void`	`initializeAuthorization(ProposalDevelopmentDocument doc)` Initialize the Authorizations for a new proposal.
`protected boolean`	`isFilteredProperty(String name)` Is this a filtered property?
`protected boolean`	`isPropertyGetterMethod(Method method, Method[] methods)` Is the given method a getter method for a property? Must conform to the following: Must start with the get Must have a corresponding setter method Must have zero arguments.
`protected boolean`	`isProposalTypeRenewalRevisionContinuation(String proposalTypeCode)` Is the Proposal Type set to Renewal, Revision, or a Continuation?
`protected void`	`loadAttachmentContent(Narrative narrative)` Load the attachment content for a specific narrative from the database.
`protected void`	`loadAttachmentContents(ProposalDevelopmentDocument doc)` Load the attachment contents from the database.
`protected void`	`loadBioContent(ProposalPersonBiography bio)` Load the attachment content for a specific personal attachment from the database.
`protected void`	`removePersonNarrativePermission(String personId, Narrative narrative)`
`void`	`setBudgetService(BudgetService<DevelopmentProposal> budgetService)` Sets the budgetService attribute value.
`void`	`setBudgetSummaryService(BudgetSummaryService budgetSummaryService)` Sets the budgetSummaryService attribute value.
`void`	`setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)` Set the Business Object Service.
`void`	`setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)`
`void`	`setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)`
`void`	`setKeyPersonnelService(KeyPersonnelService keyPersonnelService)` Set the Key Personnel Service.
`protected void`	`setLeadUnit(ProposalDevelopmentDocument doc, String newLeadUnitNumber)` Set the lead unit for the new proposal.
`void`	`setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)` Sets the ParameterService.
`void`	`setQuestionnaireAnswerService(QuestionnaireAnswerService questionnaireAnswerService)` Sets the questionnaireAnswerService attribute value.
`void`	`setQuestionnaireService(QuestionnaireService questionnaireService)` Sets the questionnaireService attribute value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProposalCopyServiceImpl
```
public ProposalCopyServiceImpl()
```
- Method Detail
  - setParameterService
```
public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)
```
    Sets the ParameterService.
    
    Parameters:
    parameterService - the parameter service.
  - copyProposal
```
public String copyProposal(ProposalDevelopmentDocument doc,
                  ProposalCopyCriteria criteria)
                    throws Exception
```
    Description copied from interface: ProposalCopyService
    
    Copy a proposal development document. The criteria controls various aspects of the copying process, e.g. whether or not to copy attachments.
    
    Specified by:
    
    copyProposal in interface ProposalCopyService
    
    Parameters:
    doc - the proposal development document to copy.
    criteria - the user-specified criteria that controls various copy operations.
    
    Returns:
    the document number of the new document that is saved in the database; otherwise null if an error occurred, e.g. the user didn't have permission to copy the document
    
    Throws:
    
    Exception - if anything really bad happens
    See Also:
    ProposalCopyService.copyProposal(org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument, org.kuali.kra.proposaldevelopment.bo.ProposalCopyCriteria)
  - createNewProposal
```
protected ProposalDevelopmentDocument createNewProposal(ProposalDevelopmentDocument srcDoc,
                                            ProposalCopyCriteria criteria)
                                                 throws Exception
```
    Create a new proposal based upon a source proposal. Only copy over the properties necessary for the initial creation of the proposal. This will give us the proposal number to use when copying over the remainder of the proposal.
    
    Parameters:
    srcDoc -
    criteria -
    
    Returns:
    
    Throws:
    
    Exception
  - copyRequiredProperties
```
protected void copyRequiredProperties(ProposalDevelopmentDocument srcDoc,
                          ProposalDevelopmentDocument destDoc)
```
    Copy over the required properties so we can do an initial save of the document in order to obtain a proposal number.
    
    Parameters:
    srcDoc -
    destDoc -
  - copyProposal
```
protected void copyProposal(ProposalDevelopmentDocument src,
                ProposalDevelopmentDocument dest,
                ProposalCopyCriteria criteria)
                     throws Exception
```
    Copies the source proposal development document to the destination document.
    
    Parameters:
    src - the source document, i.e. the original.
    dest - the destination document, i.e. the new document.
    criteria - the user-specified criteria.
    
    Throws:
    
    Exception - if the copy fails for any reason.
  - copyProposalProperties
```
protected void copyProposalProperties(ProposalDevelopmentDocument src,
                          ProposalDevelopmentDocument dest)
                               throws Exception
```
    Copies over the "normal" Proposal Development Document properties. Only the properties declared within the ProposalDevelopmentDocument class are copied. Properties from parent classes are not copied.
    
    Parameters:
    src - the source proposal development document, i.e. the original.
    dest - the destination proposal development document, i.e. the new document.
    
    Throws:
    
    Exception - if the copy fails for any reason.
  - fixNextValues
```
protected void fixNextValues(ProposalDevelopmentDocument oldDoc,
                 ProposalDevelopmentDocument newDoc)
```
    The document next values must be the same in the new version as in the old document. Note that the next document values must be assigned the document number of the new version.
    
    Parameters:
    oldDoc -
    newDoc -
  - copyProperties
```
protected void copyProperties(DevelopmentProposal src,
                  DevelopmentProposal dest,
                  List<ProposalCopyServiceImpl.DocProperty> properties)
                       throws Exception
```
    Throws:
    
    Exception
  - copyOverviewProperties
```
protected void copyOverviewProperties(ProposalDevelopmentDocument src,
                          ProposalDevelopmentDocument dest)
```
    Copies the document overview properties. These properties are the Description, Explanation, and Organization Document Number. These properties belong to a parent class and thus they were not copied over in step 2.
    
    Parameters:
    src - the source proposal development document, i.e. the original.
    dest - the destination proposal development document, i.e. the new document.
  - getCopyableProperties
```
protected List<ProposalCopyServiceImpl.DocProperty> getCopyableProperties()
```
    Get the list of DevelopmentProposal properties that can be copied. A property can only be copied if it meets the following criteria.
    - It was declared in the DevelopmentProposal class.
    - It has a setter and a getter method.
    - It is not a filtered property.
    Returns:
    the list of properties that can be copied.
  - getPropertyName
```
protected String getPropertyName(Method method)
```
    Get the name of a property. The method must be a setter method. The property name is computed by removing the "set" from the method name.
    
    Parameters:
    method - the setter method.
    
    Returns:
    the name of the corresponding property.
  - isFilteredProperty
```
protected boolean isFilteredProperty(String name)
```
    Is this a filtered property?
    
    Parameters:
    name - the name of the property.
    
    Returns:
    true if filtered; otherwise false.
  - getGetter
```
protected Method getGetter(String name,
               Method[] methods)
```
    Gets the getter method for a property.
    
    Parameters:
    name - the name of the property.
    methods - the list of methods to look in for the getter method.
    
    Returns:
    the getter method or null if not found.
  - setLeadUnit
```
protected void setLeadUnit(ProposalDevelopmentDocument doc,
               String newLeadUnitNumber)
```
    Set the lead unit for the new proposal.
    
    Parameters:
    doc - the new proposal development document
    newLeadUnitNumber - the new lead unit number
  - fixProposal
```
protected void fixProposal(ProposalDevelopmentDocument srcDoc,
               ProposalDevelopmentDocument newDoc,
               ProposalCopyCriteria criteria)
                    throws Exception
```
    Fix the proposal.
    
    Parameters:
    criteria - the copy criteria
    
    Throws:
    
    Exception
  - fixOrganizationAndLocations
```
protected void fixOrganizationAndLocations(ProposalDevelopmentDocument doc)
```
    If the Lead Unit has changed in the previous Document, then this method corrects related properties Organization and ProposalSite instances
    
    Parameters:
    doc - ProposalDevelopmentDocument to fix
  - fixProposalNumbers
```
protected void fixProposalNumbers(Object object,
                      String proposalNumber,
                      List<Object> list)
                           throws Exception
```
    Recurse through all of the BOs and if a BO has a ProposalNumber property, set its value to the new proposal number.
    
    Parameters:
    object - the object
    proposalNumber - the proposal number
    list - I assume this is the list of objects that have already been processed.
    
    Throws:
    
    Exception
  - isPropertyGetterMethod
```
protected boolean isPropertyGetterMethod(Method method,
                             Method[] methods)
```
    Is the given method a getter method for a property? Must conform to the following:
    1. Must start with the get
    2. Must have a corresponding setter method
    3. Must have zero arguments.
    Parameters:
    method - the method to check
    methods - the other methods in the object
    
    Returns:
    true if it is property getter method; otherwise false
  - fixKeyPersonnel
```
protected void fixKeyPersonnel(ProposalDevelopmentDocument doc,
                   String oldLeadUnitNumber,
                   String newLeadUnitNumber)
                        throws Exception
```
    Fix the Key Personnel.
    
    Parameters:
    doc - the proposal development document
    oldLeadUnitNumber - the old lead unit number
    newLeadUnitNumber - the new lead unit number
    
    Throws:
    
    Exception
  - fixCongressionalDistricts
```
protected void fixCongressionalDistricts(ProposalDevelopmentDocument doc)
```
    This method sets all congressional district ids to null, so new ids get assigned to them.
    
    Parameters:
    doc -
  - fixBudgetVersions
```
protected void fixBudgetVersions(ProposalDevelopmentDocument doc)
```
    Fix data related to Budget Versions.
    
    Parameters:
    doc - the proposal development document
    oldLeadUnitNumber - the old lead unit number
    newLeadUnitNumber - the new lead unit number
  - clearCertifyQuestions
```
protected void clearCertifyQuestions(ProposalDevelopmentDocument doc)
```
    Clear the Certify questions for each investigator.
    
    Parameters:
    doc - the Proposal Development Document
  - fixKeyPersonnelUnits
```
protected void fixKeyPersonnelUnits(ProposalDevelopmentDocument doc,
                        String oldLeadUnitNumber,
                        String newLeadUnitNumber)
                             throws Exception
```
    Fix the Key Personnel. This requires changing the lead unit for the PI and the COIs to the new lead unit. Also, if the PI's home unit is not in the list, we must add it.
    
    Parameters:
    doc - the proposal development document
    oldLeadUnitNumber - the old lead unit number
    newLeadUnitNumber - the new lead unit number
    
    Throws:
    
    Exception
  - createProposalPersonUnit
```
protected ProposalPersonUnit createProposalPersonUnit(ProposalPerson person,
                                          String unitNumber,
                                          boolean isLeadUnit,
                                          boolean isDeletable,
                                          List<ProposalPersonUnit> oldProposalPersonUnits)
```
  - findProposalPersonUnit
```
protected ProposalPersonUnit findProposalPersonUnit(String unitNumber,
                                        List<ProposalPersonUnit> proposalPersonUnits)
```
  - initializeAuthorization
```
protected void initializeAuthorization(ProposalDevelopmentDocument doc)
```
    Initialize the Authorizations for a new proposal. The initiator/creator is assigned the Aggregator role.
    
    Parameters:
    doc - the proposal development document
  - copyAttachments
```
protected void copyAttachments(ProposalDevelopmentDocument src,
                   ProposalDevelopmentDocument dest)
                        throws Exception
```
    Copy the Attachments (proposal, personal, and institutional) to the new document. Does this by loading the actual attachments (since they are left out of the object graph under normal conditions, then copies the attachments (ProposalPersonBiographies, Narratives, and InstituteAttachments).
    
    Parameters:
    src - the source proposal development document, i.e. the original.
    dest - the destination proposal development document, i.e. the new document.
    
    Throws:
    
    Exception
  - removePersonNarrativePermission
```
protected void removePersonNarrativePermission(String personId,
                                   Narrative narrative)
```
  - loadAttachmentContents
```
protected void loadAttachmentContents(ProposalDevelopmentDocument doc)
```
    Load the attachment contents from the database.
    
    Parameters:
    doc - the proposal development document to load attachment contents into.
  - loadAttachmentContent
```
protected void loadAttachmentContent(Narrative narrative)
```
    Load the attachment content for a specific narrative from the database.
    
    Parameters:
    narrative - the narrative for which to load the contents.
  - loadBioContent
```
protected void loadBioContent(ProposalPersonBiography bio)
```
    Load the attachment content for a specific personal attachment from the database.
    
    Parameters:
    bio - the personal attachment for which to load the contents.
  - copyBudget
```
protected void copyBudget(ProposalDevelopmentDocument src,
              ProposalDevelopmentDocument dest,
              String budgetVersions)
                   throws Exception
```
    This method...
    
    Parameters:
    src - the source proposal development document, i.e. the original.
    dest - the destination proposal development document, i.e. the new document.
    budgetVersions -
    
    Throws:
    
    Exception
  - copyAndFinalizeBudgetVersion
```
protected void copyAndFinalizeBudgetVersion(String documentNumber,
                                ProposalDevelopmentDocument dest,
                                int budgetVersionNumber,
                                boolean resetRates)
                                     throws Exception
```
    Throws:
    
    Exception
  - fixNumericProperty
```
protected void fixNumericProperty(Object object,
                      String methodName,
                      Class clazz,
                      Object propertyValue,
                      Map<String,Object> objectMap)
                           throws Exception
```
    Recurse through all of the BOs and if a BO has a specific property, set its value to the new value.
    
    Parameters:
    object - the object
    propertyValue -
    
    Throws:
    
    Exception
  - copyCustomData
```
protected void copyCustomData(ProposalDevelopmentDocument src,
                  ProposalDevelopmentDocument dest)
```
    This method copies all custom data from one document to another.
    
    Parameters:
    src -
    dest -
  - setBusinessObjectService
```
public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
```
    Set the Business Object Service. It is set via dependency injection.
    
    Parameters:
    businessObjectService - the Business Object Service
  - setDocumentService
```
public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)
```
  - setKeyPersonnelService
```
public void setKeyPersonnelService(KeyPersonnelService keyPersonnelService)
```
    Set the Key Personnel Service. It is set via dependency injection.
    
    Parameters:
    keyPersonnelService - the Key Personnel Service
  - getKualiRuleService
```
protected org.kuali.rice.krad.service.KualiRuleService getKualiRuleService()
```
    Get the Kuali Rule Service.
    
    Returns:
    the Kuali Rule Service
  - getQuestionnaireService
```
public QuestionnaireService getQuestionnaireService()
```
    Gets the questionnaireService attribute.
    
    Returns:
    Returns the questionnaireService.
  - setQuestionnaireService
```
public void setQuestionnaireService(QuestionnaireService questionnaireService)
```
    Sets the questionnaireService attribute value.
    
    Parameters:
    questionnaireService - The questionnaireService to set.
  - getQuestionnaireAnswerService
```
public QuestionnaireAnswerService getQuestionnaireAnswerService()
```
    Gets the questionnaireAnswerService attribute.
    
    Returns:
    Returns the questionnaireAnswerService.
  - setQuestionnaireAnswerService
```
public void setQuestionnaireAnswerService(QuestionnaireAnswerService questionnaireAnswerService)
```
    Sets the questionnaireAnswerService attribute value.
    
    Parameters:
    questionnaireAnswerService - The questionnaireAnswerService to set.
  - isProposalTypeRenewalRevisionContinuation
```
protected boolean isProposalTypeRenewalRevisionContinuation(String proposalTypeCode)
```
    Is the Proposal Type set to Renewal, Revision, or a Continuation?
    
    Parameters:
    proposalTypeCode - proposal type code
    
    Returns:
    true or false
  - getDateTimeService
```
protected org.kuali.rice.core.api.datetime.DateTimeService getDateTimeService()
```
  - setDateTimeService
```
public void setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)
```
  - getBudgetService
```
public BudgetService<DevelopmentProposal> getBudgetService()
```
    Gets the budgetService attribute.
    
    Returns:
    Returns the budgetService.
  - setBudgetService
```
public void setBudgetService(BudgetService<DevelopmentProposal> budgetService)
```
    Sets the budgetService attribute value.
    
    Parameters:
    budgetService - The budgetService to set.
  - getBudgetSummaryService
```
public BudgetSummaryService getBudgetSummaryService()
```
    Gets the budgetSummaryService attribute.
    
    Returns:
    Returns the budgetSummaryService.
  - setBudgetSummaryService
```
public void setBudgetSummaryService(BudgetSummaryService budgetSummaryService)
```
    Sets the budgetSummaryService attribute value.
    
    Parameters:
    budgetSummaryService - The budgetSummaryService to set.

Class ProposalCopyServiceImpl

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProposalCopyServiceImpl

Method Detail

setParameterService

copyProposal

createNewProposal

copyRequiredProperties

copyProposal

copyProposalProperties

fixNextValues

copyProperties

copyOverviewProperties

getCopyableProperties

getPropertyName

isFilteredProperty

getGetter

setLeadUnit

fixProposal

fixOrganizationAndLocations

fixProposalNumbers

isPropertyGetterMethod

fixKeyPersonnel

fixCongressionalDistricts

fixBudgetVersions

clearCertifyQuestions

fixKeyPersonnelUnits

createProposalPersonUnit

findProposalPersonUnit

initializeAuthorization

copyAttachments

removePersonNarrativePermission

loadAttachmentContents

loadAttachmentContent

loadBioContent

copyBudget

copyAndFinalizeBudgetVersion

fixNumericProperty

copyCustomData

setBusinessObjectService

setDocumentService

setKeyPersonnelService

getKualiRuleService

getQuestionnaireService

setQuestionnaireService

getQuestionnaireAnswerService

setQuestionnaireAnswerService

isProposalTypeRenewalRevisionContinuation

getDateTimeService

setDateTimeService

getBudgetService

setBudgetService

getBudgetSummaryService

setBudgetSummaryService