org.kuali.kra.common.committee.document

Class CommitteeDocumentBase<CD extends CommitteeDocumentBase<CD,CMT,CS>,CMT extends CommitteeBase<CMT,CD,CS>,CS extends CommitteeScheduleBase<CS,CMT,?,?>>

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.common.committee.document.CommitteeDocumentBase<CD,CMT,CS>

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

Direct Known Subclasses:

CommitteeDocument, CommonCommitteeDocument

public abstract class CommitteeDocumentBase<CD extends CommitteeDocumentBase<CD,CMT,CS>,CMT extends CommitteeBase<CMT,CD,CS>,CS extends CommitteeScheduleBase<CS,CMT,?,?>>
extends ResearchDocumentBase
implements org.kuali.rice.krad.document.Copyable, org.kuali.rice.krad.document.SessionDocument

The CommitteeBase Document wraps a single CommitteeBase BO. The document is necessary for workflow.

See Also:

Serialized Form

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
List	buildListOfDeletionAwareLists()
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)
protected List<RolePersons>	getAllRolePersons() Get the list of roles for the document along with each of the individuals in those roles.
CMT	getCommittee() Get the CommitteeBase BO.
String	getCommitteeId()
List<CMT>	getCommitteeList() Get the list of committees.
protected abstract CommitteeServiceBase<CMT,CS>	getCommitteeService()
String	getDocStatusCode()
String	getDocumentTypeCode()
protected abstract CMT	getNewCommitteeInstanceHook()
protected abstract CD	getThisHook()
void	initialize()
boolean	isProcessComplete() This method is to check whether rice async routing is ok now.
void	prepareForSave()
void	setCommittee(CMT committee) Set the CommitteeBase BO.
void	setCommitteeId(String committeeId)
void	setCommitteeList(List<CMT> committeeList) Set the list of committees.
void	setDocStatusCode(String docStatusCode)

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

answerSplitNodeQuestion, getCustomAttributeDocument, getCustomAttributeDocuments, getDocumentCustomData, getDocumentNextValue, getDocumentNextvalueBo, getDocumentNextvalues, getService, getUpdateTimestamp, getUpdateUser, 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, getCustomLockDescriptor, 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, useCustomLockDescriptors

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, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNotes, useCustomLockDescriptors

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

Constructor Detail

CommitteeDocumentBase

public CommitteeDocumentBase()

Constructs a CommitteeDocument object

Method Detail

getThisHook

protected abstract CD getThisHook()

getNewCommitteeInstanceHook

protected abstract CMT getNewCommitteeInstanceHook()

initialize

public void initialize()

Overrides:

initialize in class ResearchDocumentBase

See Also:

ResearchDocumentBase.initialize()

getCommittee

public CMT getCommittee()

Get the CommitteeBase BO. This is a convenience method for easily obtaining the single CommitteeBase BO in the list.

Returns:

the CommitteeBase BO

setCommittee

public void setCommittee(CMT committee)

Set the CommitteeBase BO. This is a convenience method to easily insert the committee into the list.

Parameters:

committee - the CommitteeBase BO

getCommitteeList

public List<CMT> getCommitteeList()

Get the list of committees. WARNING: Developers should never call this method. This method is for OJB use only.

Returns:

the list with the single committee

setCommitteeList

public void setCommitteeList(List<CMT> committeeList)

Set the list of committees. WARNING: Developers should never call this method. This method is for OJB use only.

Parameters:

committeeList - the list containing the single committee

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

getAllRolePersons

protected List<RolePersons> getAllRolePersons()

Description copied from class: ResearchDocumentBase

Get the list of roles for the document along with each of the individuals in those roles. This information will be serialized into XML for workflow routing purposes. It is expected that this method will be overridden by derived classes.

Overrides:

getAllRolePersons in class ResearchDocumentBase

Returns:

the list of roles and the users in those roles for this document

See Also:

ResearchDocumentBase.getAllRolePersons()

getDocumentTypeCode

public String getDocumentTypeCode()

Specified by:

getDocumentTypeCode in class ResearchDocumentBase

prepareForSave

public void prepareForSave()

Specified by:

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

Overrides:

prepareForSave in class ResearchDocumentBase

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

getCommitteeService

protected abstract CommitteeServiceBase<CMT,CS> getCommitteeService()

getCommitteeId

public String getCommitteeId()

setCommitteeId

public void setCommitteeId(String committeeId)

getDocStatusCode

public String getDocStatusCode()

setDocStatusCode

public void setDocStatusCode(String docStatusCode)

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: