org.kuali.kra.proposaldevelopment.document

Class ProposalDevelopmentDocument

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.rice.krad.document.DocumentBase

org.kuali.rice.krad.document.TransactionalDocumentBase

org.kuali.kra.document.ResearchDocumentBase

org.kuali.kra.budget.document.BudgetParentDocument<DevelopmentProposal>

org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, BudgetDocumentTypeChecker, BudgetVersionCollection, Permissionable, KrmsRulesContext, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject, org.kuali.rice.krad.document.Copyable, org.kuali.rice.krad.document.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.document.TransactionalDocument

public class ProposalDevelopmentDocument
extends BudgetParentDocument<DevelopmentProposal>
implements org.kuali.rice.krad.document.Copyable, org.kuali.rice.krad.document.SessionDocument, Permissionable, KrmsRulesContext

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOCUMENT_TYPE_CODE

Fields inherited from class org.kuali.rice.krad.document.DocumentBase

documentHeader, documentNumber

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Fields inherited from interface org.kuali.kra.common.permissions.Permissionable

AWARD_BUDGET_KEY, AWARD_KEY, COI_DISCLOSURE_KEY, COMMITTEE_KEY, COMMITTEE_SCHEDULE_KEY, IACUC_PROTOCOL_KEY, IACUC_PROTOCOL_ONLINE_REVIEW_KEY, NEGOTIATION_KEY, PROPOSAL_BUDGET_KEY, PROPOSAL_KEY, PROTOCOL_KEY, PROTOCOL_ONLINE_REVIEW_KEY, SPONSOR_HIREARCHY_KEY, SUBAWARD_KEY, TIME_AND_MONEY_KEY

Constructor Summary

Constructors

Constructor and Description
ProposalDevelopmentDocument()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFacts(org.kuali.rice.krms.api.engine.Facts.Builder factsBuilder)
boolean	answerSplitNodeQuestion(String routeNodeName) In documents that support it, this method should answer T/F for a SplitNode question regarding routing.
List	buildListOfDeletionAwareLists()
org.kuali.rice.kns.web.ui.ExtraButton	configureReturnToParentTopButton()
void	defaultDocumentDescription()
void	doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent event)
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange dto)
Boolean	getAllowsNoteAttachments()
List<BudgetDocumentVersion>	getBudgetDocumentVersions() Gets the budgetDocumentVersions attribute.
DevelopmentProposal	getBudgetParent()
Permissionable	getBudgetPermissionable()
List<CustomAttributeDocValue>	getCustomDataList()
String	getCustomLockDescriptor(org.kuali.rice.kim.api.identity.Person user)
protected org.kuali.rice.core.api.datetime.DateTimeService	getDateTimeService()
DevelopmentProposal	getDevelopmentProposal()
List<DevelopmentProposal>	getDevelopmentProposalList()
List<? extends DocumentCustomData>	getDocumentCustomData()
String	getDocumentKey() This method returns unique key for implementing document.
String	getDocumentNumberForPermission() This method returns the appropriate document number for implementing documents For award it would be awardNumber and for PDD it would be proposal Number.
String	getDocumentRoleTypeCode()
String	getDocumentTitle()
String	getDocumentTypeCode()
Budget	getFinalBudgetForThisProposal()
String	getFinalrateClassCode()
String	getInstitutionalProposalNumber()
protected org.kuali.rice.core.api.config.property.ConfigurationService	getKualiConfigurationService()
String	getLeadUnitNumber()
String	getNamespace()
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService() Looks up and returns the ParameterService.
Task	getParentAuthZTask(String taskName)
String	getProposalBudgetFlag() This method returns 'Y' if its a proposal budget
List<String>	getRoleNames() This method gets all the role names for particular document.
String	getSaveXmlFolderName()
String	getTaskGroupName()
void	initialize()
boolean	isComplete()
boolean	isDefaultDocumentDescription()
boolean	isProcessComplete() This method is to check whether rice async routing is ok now.
boolean	isProposalDeleted()
void	populateAgendaQualifiers(Map<String,String> qualifiers)
void	populateContextQualifiers(Map<String,String> qualifiers)
void	prepareForSave()
void	processAfterRetrieve()
void	processAfterRetrieveForBudget(BudgetDocument budgetDocument)
void	refreshBudgetDocumentVersions()
void	saveBudgetFinalVersionStatus(BudgetDocument budgetDocument)
void	setAllowsNoteAttachments(boolean allowsNoteAttachments)
void	setBudgetDocumentVersions(List<BudgetDocumentVersion> budgetDocumentVersions) Sets the budgetDocumentVersions attribute value.
void	setCustomDataList(List<CustomAttributeDocValue> customDataList)
void	setDevelopmentProposal(DevelopmentProposal proposal)
void	setDevelopmentProposalList(List<DevelopmentProposal> proposalList)
void	setInstitutionalProposalNumber(String institutionalProposalNumber)
void	setProposalDeleted(boolean proposalDeleted)
void	setSaveXmlFolderName(String saveXmlFolderName)
boolean	useCustomLockDescriptors()
org.kuali.rice.krad.workflow.KualiDocumentXmlMaterializer	wrapDocumentWithMetadataForXmlSerialization() Wraps a document in an instance of KualiDocumentXmlMaterializer, that provides additional metadata for serialization

Methods inherited from class org.kuali.kra.budget.document.BudgetParentDocument

addNewBudgetVersion, getBudgetDocumentVersion, getBudgetHeaderNavigatorList, getFinalBudgetVersion, getNextBudgetVersionNumber

Methods inherited from class org.kuali.kra.document.ResearchDocumentBase

getAllRolePersons, getCustomAttributeDocument, getCustomAttributeDocuments, getDocumentNextValue, getDocumentNextvalueBo, getDocumentNextvalues, getService, getUpdateTimestamp, getUpdateUser, isViewOnly, populateAdditionalQualifiedRoleAttributes, setCustomAttributeDocuments, setDocumentNextvalues, setUpdateTimestamp, setUpdateUser, setViewOnly, toCopy, updateDocumentDescriptions, validateBusinessRules

Methods inherited from class org.kuali.rice.krad.document.TransactionalDocumentBase

getAllowsCopy, isSessionDocument

Methods inherited from class org.kuali.rice.krad.document.DocumentBase

addCopyErrorDocumentNote, addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, postProcessSave, prepareForSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNewDocumentHeader, setNotes, setPessimisticLocks

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refreshNonUpdateableReferences, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.document.Copyable

toCopy

Methods inherited from interface org.kuali.kra.common.permissions.Permissionable

populateAdditionalQualifiedRoleAttributes

Methods inherited from interface org.kuali.rice.krad.document.Document

addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNotes

Methods inherited from interface org.kuali.rice.krad.bo.PersistableBusinessObject

getExtension, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject

refresh

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Field Detail

DOCUMENT_TYPE_CODE

public static final String DOCUMENT_TYPE_CODE

See Also:

Constant Field Values

Constructor Detail

ProposalDevelopmentDocument

public ProposalDevelopmentDocument()

Method Detail

getDevelopmentProposalList

public List<DevelopmentProposal> getDevelopmentProposalList()

setDevelopmentProposalList

public void setDevelopmentProposalList(List<DevelopmentProposal> proposalList)

getDevelopmentProposal

public DevelopmentProposal getDevelopmentProposal()

setDevelopmentProposal

public void setDevelopmentProposal(DevelopmentProposal proposal)

getInstitutionalProposalNumber

public String getInstitutionalProposalNumber()

setInstitutionalProposalNumber

public void setInstitutionalProposalNumber(String institutionalProposalNumber)

initialize

public void initialize()

Overrides:

initialize in class ResearchDocumentBase

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange dto)

Specified by:

doRouteStatusChange in interface org.kuali.rice.krad.document.Document

Overrides:

doRouteStatusChange in class org.kuali.rice.krad.document.DocumentBase

doActionTaken

public void doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent event)

Specified by:

doActionTaken in interface org.kuali.rice.krad.document.Document

Overrides:

doActionTaken in class org.kuali.rice.krad.document.DocumentBase

See Also:

Document.doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent)

getKualiConfigurationService

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

getParameterService

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

Description copied from class: BudgetParentDocument

Looks up and returns the ParameterService.

Overrides:

getParameterService in class BudgetParentDocument<DevelopmentProposal>

Returns:

the parameter service.

getDateTimeService

protected org.kuali.rice.core.api.datetime.DateTimeService getDateTimeService()

getFinalBudgetForThisProposal

public Budget getFinalBudgetForThisProposal()

getFinalrateClassCode

public String getFinalrateClassCode()

getDocumentTypeCode

public String getDocumentTypeCode()

Specified by:

getDocumentTypeCode in class ResearchDocumentBase

wrapDocumentWithMetadataForXmlSerialization

public org.kuali.rice.krad.workflow.KualiDocumentXmlMaterializer wrapDocumentWithMetadataForXmlSerialization()

Wraps a document in an instance of KualiDocumentXmlMaterializer, that provides additional metadata for serialization

Specified by:

wrapDocumentWithMetadataForXmlSerialization in interface org.kuali.rice.krad.document.Document

Overrides:

wrapDocumentWithMetadataForXmlSerialization in class ResearchDocumentBase

See Also:

org.kuali.core.document.Document#wrapDocumentWithMetadataForXmlSerialization()

prepareForSave

public void prepareForSave()

Specified by:

prepareForSave in interface org.kuali.rice.krad.document.Document

Overrides:

prepareForSave in class ResearchDocumentBase

processAfterRetrieve

public void processAfterRetrieve()

Specified by:

processAfterRetrieve in interface org.kuali.rice.krad.document.Document

Overrides:

processAfterRetrieve in class ResearchDocumentBase

getAllowsNoteAttachments

public Boolean getAllowsNoteAttachments()

setAllowsNoteAttachments

public void setAllowsNoteAttachments(boolean allowsNoteAttachments)

getRoleNames

public List<String> getRoleNames()

Description copied from interface: Permissionable

This method gets all the role names for particular document.

Specified by:

getRoleNames in interface Permissionable

Returns:

See Also:

Permissionable.getRoleNames()

getDocumentNumberForPermission

public String getDocumentNumberForPermission()

Description copied from interface: Permissionable

This method returns the appropriate document number for implementing documents For award it would be awardNumber and for PDD it would be proposal Number.

Specified by:

getDocumentNumberForPermission in interface Permissionable

Returns:

See Also:

Permissionable.getDocumentNumberForPermission()

getDocumentKey

public String getDocumentKey()

Description copied from interface: Permissionable

This method returns unique key for implementing document.

Specified by:

getDocumentKey in interface Permissionable

Returns:

See Also:

Permissionable.getDocumentKey()

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

buildListOfDeletionAwareLists in interface org.kuali.rice.krad.bo.PersistableBusinessObject

Overrides:

buildListOfDeletionAwareLists in class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

See Also:

org.kuali.core.bo.PersistableBusinessObjectBase#buildListOfDeletionAwareLists()

setBudgetDocumentVersions

public void setBudgetDocumentVersions(List<BudgetDocumentVersion> budgetDocumentVersions)

Sets the budgetDocumentVersions attribute value.

Specified by:

setBudgetDocumentVersions in interface BudgetVersionCollection

Parameters:

budgetDocumentVersions - The budgetDocumentVersions to set.

getBudgetDocumentVersions

public List<BudgetDocumentVersion> getBudgetDocumentVersions()

Gets the budgetDocumentVersions attribute.

Specified by:

getBudgetDocumentVersions in interface BudgetVersionCollection

Returns:

Returns the budgetDocumentVersions.

getParentAuthZTask

public Task getParentAuthZTask(String taskName)

Specified by:

getParentAuthZTask in class BudgetParentDocument<DevelopmentProposal>

isComplete

public boolean isComplete()

Specified by:

isComplete in class BudgetParentDocument<DevelopmentProposal>

saveBudgetFinalVersionStatus

public void saveBudgetFinalVersionStatus(BudgetDocument budgetDocument)

Specified by:

saveBudgetFinalVersionStatus in class BudgetParentDocument<DevelopmentProposal>

processAfterRetrieveForBudget

public void processAfterRetrieveForBudget(BudgetDocument budgetDocument)

Specified by:

processAfterRetrieveForBudget in class BudgetParentDocument<DevelopmentProposal>

getTaskGroupName

public String getTaskGroupName()

Specified by:

getTaskGroupName in class BudgetParentDocument<DevelopmentProposal>

configureReturnToParentTopButton

public org.kuali.rice.kns.web.ui.ExtraButton configureReturnToParentTopButton()

Specified by:

configureReturnToParentTopButton in class BudgetParentDocument<DevelopmentProposal>

getBudgetParent

public DevelopmentProposal getBudgetParent()

Specified by:

getBudgetParent in class BudgetParentDocument<DevelopmentProposal>

useCustomLockDescriptors

public boolean useCustomLockDescriptors()

Specified by:

useCustomLockDescriptors in interface org.kuali.rice.krad.document.Document

Overrides:

useCustomLockDescriptors in class org.kuali.rice.krad.document.DocumentBase

getCustomLockDescriptor

public String getCustomLockDescriptor(org.kuali.rice.kim.api.identity.Person user)

Specified by:

getCustomLockDescriptor in interface org.kuali.rice.krad.document.Document

Overrides:

getCustomLockDescriptor in class org.kuali.rice.krad.document.DocumentBase

getBudgetPermissionable

public Permissionable getBudgetPermissionable()

Specified by:

getBudgetPermissionable in class BudgetParentDocument<DevelopmentProposal>

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String routeNodeName)
                                throws Exception

Description copied from class: ResearchDocumentBase

In documents that support it, this method should answer T/F for a SplitNode question regarding routing. The SimpleBooleanSplitNode will supply the route node name which implementations should use to answer the question. For example, isHierarchyChild would be answered by ProposalDevelopementDocument as T if the document is a child within a proposal hierarchy and false otherwise. If a document does not support answering the question, it should throw an UnsupportedOperationException. The stub implementation throws an UnsupportedOperationException for any input.

Overrides:

answerSplitNodeQuestion in class ResearchDocumentBase

Parameters:

routeNodeName - The name of the routeNode as it appears in the document workflow definition.

Returns:

boolean value representing the answer.

Throws:

UnsupportedOperationException - if the document does not support answering a split node question, or if it does not support answering the question for the supplied route name.

Exception

See Also:

ResearchDocumentBase.answerSplitNodeQuestion(java.lang.String)

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface Permissionable

getLeadUnitNumber

public String getLeadUnitNumber()

Specified by:

getLeadUnitNumber in interface Permissionable

getDocumentRoleTypeCode

public String getDocumentRoleTypeCode()

Specified by:

getDocumentRoleTypeCode in interface Permissionable

getProposalBudgetFlag

public String getProposalBudgetFlag()

Description copied from interface: BudgetDocumentTypeChecker

This method returns 'Y' if its a proposal budget

Specified by:

getProposalBudgetFlag in interface BudgetDocumentTypeChecker

Returns:

isProcessComplete

public boolean isProcessComplete()

This method is to check whether rice async routing is ok now. Close to hack. called by holdingpageaction Different document type may have different routing set up, so each document type can implement its own isProcessComplete

Specified by:

isProcessComplete in class ResearchDocumentBase

Returns:

isProposalDeleted

public boolean isProposalDeleted()

setProposalDeleted

public void setProposalDeleted(boolean proposalDeleted)

refreshBudgetDocumentVersions

public void refreshBudgetDocumentVersions()

Specified by:

refreshBudgetDocumentVersions in interface BudgetVersionCollection

populateContextQualifiers

public void populateContextQualifiers(Map<String,String> qualifiers)

Specified by:

populateContextQualifiers in interface KrmsRulesContext

addFacts

public void addFacts(org.kuali.rice.krms.api.engine.Facts.Builder factsBuilder)

Specified by:

addFacts in interface KrmsRulesContext

populateAgendaQualifiers

public void populateAgendaQualifiers(Map<String,String> qualifiers)

Specified by:

populateAgendaQualifiers in interface KrmsRulesContext

defaultDocumentDescription

public void defaultDocumentDescription()

getDocumentCustomData

public List<? extends DocumentCustomData> getDocumentCustomData()

Specified by:

getDocumentCustomData in class ResearchDocumentBase

getCustomDataList

public List<CustomAttributeDocValue> getCustomDataList()

setCustomDataList

public void setCustomDataList(List<CustomAttributeDocValue> customDataList)

getSaveXmlFolderName

public String getSaveXmlFolderName()

setSaveXmlFolderName

public void setSaveXmlFolderName(String saveXmlFolderName)

isDefaultDocumentDescription

public boolean isDefaultDocumentDescription()

getDocumentTitle

public String getDocumentTitle()

Specified by:

getDocumentTitle in interface org.kuali.rice.krad.document.Document

Overrides:

getDocumentTitle in class org.kuali.rice.krad.document.DocumentBase