org.kuali.kra.award.document

Class AwardDocument

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<Award>

org.kuali.kra.award.document.AwardDocument

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 AwardDocument
extends BudgetParentDocument<Award>
implements org.kuali.rice.krad.document.Copyable, org.kuali.rice.krad.document.SessionDocument, KrmsRulesContext

This class represents the Award Document Object. AwardDocument has a 1:1 relationship with Award Business Object. We have declared a list of Award BOs in the AwardDocument at the same time to get around the OJB anonymous keys issue of primary keys of different data types. Also we have provided convenient getter and setter methods so that to the outside world; Award and AwardDocument can have a 1:1 relationship.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOCUMENT_TYPE_CODE
static String	PLACEHOLDER_DOC_DESCRIPTION

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
AwardDocument() Constructs a AwardDocument object

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.
String	buildForwardUrl()
List	buildListOfDeletionAwareLists()
org.kuali.rice.kns.web.ui.ExtraButton	configureReturnToParentTopButton()
void	doRouteLevelChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange levelChangeEvent)
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)
List<BudgetDocumentVersion>	getActualBudgetDocumentVersions()
Award	getAward() This method is a convenience method for facilitating a 1:1 relationship between AwardDocument and Award to the outside world - aka a single Award field associated with AwardDocument
List<Award>	getAwardList()
AwardService	getAwardService()
protected AwardSyncService	getAwardSyncService()
List	getBudgetDocumentVersions()
List<org.kuali.rice.kns.datadictionary.HeaderNavigation>	getBudgetHeaderNavigatorList()
Award	getBudgetParent()
Permissionable	getBudgetPermissionable()
AwardBudgetVersionOverviewExt	getBudgetVersionOverview()
boolean	getCanModify()
String	getCustomLockDescriptor(org.kuali.rice.kim.api.identity.Person user)
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	getDocumentTypeCode()
protected org.kuali.rice.kim.api.identity.IdentityService	getIdentityService()
protected InstitutionalProposalService	getInstitutionalProposalService()
protected KraAuthorizationService	getKraAuthorizationService()
String	getLeadUnitNumber()
String	getNamespace()
Task	getParentAuthZTask(String taskName)
protected org.kuali.rice.kim.api.permission.PermissionService	getPermissionService()
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	getRuleContextName()
String	getTaskGroupName()
protected VersionHistoryService	getVersionHistoryService()
protected void	init()
boolean	isCanceled()
boolean	isComplete()
boolean	isDocumentSaveAfterVersioning()
boolean	isEditable() This method specifies if this document may be edited; i.e.
boolean	isPlaceHolderDocument()
boolean	isProcessComplete() This method is to check whether rice async routing is ok now.
boolean	isSaved() Is document in Saved state?
void	populateAgendaQualifiers(Map<String,String> qualifiers)
void	populateContextQualifiers(Map<String,String> qualifiers)
void	postProcessSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)
void	prepareForSave()
void	processAfterRetrieveForBudget(BudgetDocument budgetDocument)
void	refreshBudgetDocumentVersions()
void	saveBudgetFinalVersionStatus(BudgetDocument budgetDocument)
void	setActualBudgetDocumentVersions(List<BudgetDocumentVersion> actualBudgetDocumentVersions)
void	setAward(Award award) This method is a convenience method for facilitating a 1:1 relationship between AwardDocument and Award to the outside world - aka a single Award field associated with AwardDocument
void	setAwardList(List<Award> awardList)
void	setAwardService(AwardService awardService)
void	setBudgetDocumentVersions(List<BudgetDocumentVersion> budgetDocumentVersions)
void	setDocumentSaveAfterAwardLookupEditOrVersion(boolean documentSaveAfterVersioning)
boolean	useCustomLockDescriptors()

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

addNewBudgetVersion, getBudgetDocumentVersion, getFinalBudgetVersion, getNextBudgetVersionNumber, getParameterService

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

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

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, doActionTaken, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, 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, doActionTaken, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, 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

PLACEHOLDER_DOC_DESCRIPTION

public static final String PLACEHOLDER_DOC_DESCRIPTION

See Also:

Constant Field Values

DOCUMENT_TYPE_CODE

public static final String DOCUMENT_TYPE_CODE

See Also:

Constant Field Values

Constructor Detail

AwardDocument

public AwardDocument()

Constructs a AwardDocument object

Method Detail

getAward

public Award getAward()

This method is a convenience method for facilitating a 1:1 relationship between AwardDocument and Award to the outside world - aka a single Award field associated with AwardDocument

Returns:

setAward

public void setAward(Award award)

This method is a convenience method for facilitating a 1:1 relationship between AwardDocument and Award to the outside world - aka a single Award field associated with AwardDocument

Parameters:

award -

getAwardList

public List<Award> getAwardList()

Returns:

setAwardList

public void setAwardList(List<Award> awardList)

Parameters:

awardList -

getDocumentTypeCode

public String getDocumentTypeCode()

Specified by:

getDocumentTypeCode in class ResearchDocumentBase

isDocumentSaveAfterVersioning

public boolean isDocumentSaveAfterVersioning()

Returns:

setDocumentSaveAfterAwardLookupEditOrVersion

public void setDocumentSaveAfterAwardLookupEditOrVersion(boolean documentSaveAfterVersioning)

Parameters:

documentSaveAfterVersioning -

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()

doRouteStatusChange

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

Specified by:

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

Overrides:

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

See Also:

DocumentBase.doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange)

doRouteLevelChange

public void doRouteLevelChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange levelChangeEvent)

Specified by:

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

Overrides:

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

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)

init

protected void init()

prepareForSave

public void prepareForSave()

Specified by:

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

Overrides:

prepareForSave in class ResearchDocumentBase

postProcessSave

public void postProcessSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)

Specified by:

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

Overrides:

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

getKraAuthorizationService

protected KraAuthorizationService getKraAuthorizationService()

getVersionHistoryService

protected VersionHistoryService getVersionHistoryService()

Returns:

getAwardSyncService

protected AwardSyncService getAwardSyncService()

getBudgetDocumentVersions

public List getBudgetDocumentVersions()

Specified by:

getBudgetDocumentVersions in interface BudgetVersionCollection

setBudgetDocumentVersions

public void setBudgetDocumentVersions(List<BudgetDocumentVersion> budgetDocumentVersions)

Specified by:

setBudgetDocumentVersions in interface BudgetVersionCollection

saveBudgetFinalVersionStatus

public void saveBudgetFinalVersionStatus(BudgetDocument budgetDocument)

Specified by:

saveBudgetFinalVersionStatus in class BudgetParentDocument<Award>

processAfterRetrieveForBudget

public void processAfterRetrieveForBudget(BudgetDocument budgetDocument)

Specified by:

processAfterRetrieveForBudget in class BudgetParentDocument<Award>

getDocumentKey

public String getDocumentKey()

Description copied from interface: Permissionable

This method returns unique key for implementing document.

Specified by:

getDocumentKey in interface Permissionable

Returns:

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:

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:

getBudgetPermissionable

public Permissionable getBudgetPermissionable()

Specified by:

getBudgetPermissionable in class BudgetParentDocument<Award>

getTaskGroupName

public String getTaskGroupName()

Specified by:

getTaskGroupName in class BudgetParentDocument<Award>

configureReturnToParentTopButton

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

Specified by:

configureReturnToParentTopButton in class BudgetParentDocument<Award>

getBudgetHeaderNavigatorList

public List<org.kuali.rice.kns.datadictionary.HeaderNavigation> getBudgetHeaderNavigatorList()

Overrides:

getBudgetHeaderNavigatorList in class BudgetParentDocument<Award>

getBudgetParent

public Award getBudgetParent()

Specified by:

getBudgetParent in class BudgetParentDocument<Award>

getParentAuthZTask

public Task getParentAuthZTask(String taskName)

Specified by:

getParentAuthZTask in class BudgetParentDocument<Award>

isComplete

public boolean isComplete()

Specified by:

isComplete in class BudgetParentDocument<Award>

isEditable

public boolean isEditable()

This method specifies if this document may be edited; i.e. it's only initiated or saved

Returns:

isSaved

public boolean isSaved()

Is document in Saved state?

Returns:

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

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:

getCanModify

public boolean getCanModify()

getPermissionService

protected org.kuali.rice.kim.api.permission.PermissionService getPermissionService()

getIdentityService

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

getInstitutionalProposalService

protected InstitutionalProposalService getInstitutionalProposalService()

getBudgetVersionOverview

public AwardBudgetVersionOverviewExt getBudgetVersionOverview()

isPlaceHolderDocument

public boolean isPlaceHolderDocument()

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:

getActualBudgetDocumentVersions

public List<BudgetDocumentVersion> getActualBudgetDocumentVersions()

setActualBudgetDocumentVersions

public void setActualBudgetDocumentVersions(List<BudgetDocumentVersion> actualBudgetDocumentVersions)

refreshBudgetDocumentVersions

public void refreshBudgetDocumentVersions()

Specified by:

refreshBudgetDocumentVersions in interface BudgetVersionCollection

getAwardService

public AwardService getAwardService()

setAwardService

public void setAwardService(AwardService awardService)

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

getRuleContextName

public String getRuleContextName()

populateAgendaQualifiers

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

Specified by:

populateAgendaQualifiers in interface KrmsRulesContext

buildForwardUrl

public String buildForwardUrl()

getDocumentCustomData

public List<? extends DocumentCustomData> getDocumentCustomData()

Specified by:

getDocumentCustomData in class ResearchDocumentBase

isCanceled

public boolean isCanceled()