org.kuali.kra.institutionalproposal.document

Class InstitutionalProposalDocument

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.institutionalproposal.document.InstitutionalProposalDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, 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.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.document.TransactionalDocument

public class InstitutionalProposalDocument
extends ResearchDocumentBase

This class represents the InstitutionalProposalDocument Object. InstitutionalProposalDocument has a 1:1 relationship with InstitutionalProposal Business Object. We have declared a list of InstitutionalProposal BOs in the InstitutionalProposalDocument 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; InstitutionalProposal and InstitutionalProposalDocument can have a 1:1 relationship.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOCUMENT_TYPE_CODE Comment for 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

Constructor Summary

Constructors

Constructor and Description
InstitutionalProposalDocument() Constructs a InstitutionalProposalDocument object

Method Summary

Methods

Modifier and Type	Method and Description
List	buildListOfDeletionAwareLists()
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)
String	getCustomLockDescriptor(org.kuali.rice.kim.api.identity.Person user)
List<? extends DocumentCustomData>	getDocumentCustomData()
String	getDocumentTypeCode()
InstitutionalProposal	getInstitutionalProposal() This method is a convenience method for facilitating a 1:1 relationship between InstitutionalProposalDocument and InstitutionalProposal to the outside world - aka a single InstitutionalProposal field associated with InstitutionalProposalDocument
List<InstitutionalProposal>	getInstitutionalProposalList()
protected void	init()
boolean	isProcessComplete() This method is to check whether rice async routing is ok now.
void	prepareForSave()
void	setInstitutionalProposal(InstitutionalProposal institutionalProposal) This method is a convenience method for facilitating a 1:1 relationship between InstitutionalProposalDocument and InstitutionalProposal to the outside world - aka a single InstitutionalProposal field associated with InstitutionalProposalDocument
void	setInstitutionalProposalList(List<InstitutionalProposal> institutionalProposalList)
boolean	useCustomLockDescriptors()

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

answerSplitNodeQuestion, 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, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, 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.Document

addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, 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

Comment for DOCUMENT_TYPE_CODE

See Also:

Constant Field Values

Constructor Detail

InstitutionalProposalDocument

public InstitutionalProposalDocument()

Constructs a InstitutionalProposalDocument object

Method Detail

getInstitutionalProposal

public InstitutionalProposal getInstitutionalProposal()

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

Returns:

setInstitutionalProposal

public void setInstitutionalProposal(InstitutionalProposal institutionalProposal)

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

Parameters:

institutionalProposal -

getInstitutionalProposalList

public List<InstitutionalProposal> getInstitutionalProposalList()

Returns:

setInstitutionalProposalList

public void setInstitutionalProposalList(List<InstitutionalProposal> institutionalProposalList)

Parameters:

institutionalProposalList -

getDocumentTypeCode

public String getDocumentTypeCode()

Specified by:

getDocumentTypeCode in class ResearchDocumentBase

See Also:

ResearchDocumentBase.getDocumentTypeCode()

init

protected void init()

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)

prepareForSave

public void prepareForSave()

Specified by:

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

Overrides:

prepareForSave in class ResearchDocumentBase

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

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:

getDocumentCustomData

public List<? extends DocumentCustomData> getDocumentCustomData()

Specified by:

getDocumentCustomData in class ResearchDocumentBase