org.kuali.kra.subaward.document

Class SubAwardDocument

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.subaward.document.SubAwardDocument

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.Copyable, org.kuali.rice.krad.document.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.document.TransactionalDocument

public class SubAwardDocument
extends ResearchDocumentBase
implements org.kuali.rice.krad.document.Copyable, org.kuali.rice.krad.document.SessionDocument

This class is for subAwardDocument...

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

Constructor Summary

Constructors

Constructor and Description
SubAwardDocument() .

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()
SubAward	getSubAward()
List<SubAward>	getSubAwardList()
protected VersionHistoryService	getVersionHistoryService()
protected void	init()
boolean	isDocumentSaveAfterVersioning()
boolean	isEditable() This method specifies if this document may be edited; i.e.
boolean	isProcessComplete() This method is to check whether rice async routing is ok now.
void	setDocumentSaveAfterSubAwardLookupEditOrVersion(boolean documentSaveAfterVersioning)
void	setSubAward(SubAward subAward)
void	setSubAwardList(List<SubAward> subAwardList)
boolean	useCustomLockDescriptors()

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

answerSplitNodeQuestion, getAllRolePersons, getCustomAttributeDocument, getCustomAttributeDocuments, getDocumentNextValue, getDocumentNextvalueBo, getDocumentNextvalues, getService, getUpdateTimestamp, getUpdateUser, initialize, isViewOnly, populateAdditionalQualifiedRoleAttributes, prepareForSave, 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.Copyable

toCopy

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

See Also:

Constant Field Values

Constructor Detail

SubAwardDocument

public SubAwardDocument()

. Constructs a subAwardDocument object

Method Detail

getDocumentTypeCode

public String getDocumentTypeCode()

Specified by:

getDocumentTypeCode in class ResearchDocumentBase

getSubAward

public SubAward getSubAward()

setSubAward

public void setSubAward(SubAward subAward)

setSubAwardList

public void setSubAwardList(List<SubAward> subAwardList)

getSubAwardList

public List<SubAward> getSubAwardList()

doRouteStatusChange

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

. The method is for doRouteStatusChange

Specified by:

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

Overrides:

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

isEditable

public boolean isEditable()

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

Returns:

boolean

init

protected void init()

isDocumentSaveAfterVersioning

public boolean isDocumentSaveAfterVersioning()

Returns:

setDocumentSaveAfterSubAwardLookupEditOrVersion

public void setDocumentSaveAfterSubAwardLookupEditOrVersion(boolean documentSaveAfterVersioning)

Parameters:

documentSaveAfterVersioning -

getVersionHistoryService

protected VersionHistoryService getVersionHistoryService()

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:

getDocumentCustomData

public List<? extends DocumentCustomData> getDocumentCustomData()

Specified by:

getDocumentCustomData in class ResearchDocumentBase

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

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

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