public abstract class ResearchDocumentBase
extends org.kuali.rice.krad.document.TransactionalDocumentBase
| Constructor and Description |
|---|
ResearchDocumentBase() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
answerSplitNodeQuestion(String routeNodeName)
In documents that support it, this method should answer T/F for a SplitNode question
regarding routing.
|
protected List<RolePersons> |
getAllRolePersons()
Get the list of roles for the document along with each of the individuals in those roles.
|
CustomAttributeDocument |
getCustomAttributeDocument(String key)
Gets the customAttributeDocuments attribute.
|
Map<String,CustomAttributeDocument> |
getCustomAttributeDocuments()
This method populates the customAttributes for this document.
|
abstract List<? extends DocumentCustomData> |
getDocumentCustomData() |
Integer |
getDocumentNextValue(String propertyName) |
DocumentNextvalue |
getDocumentNextvalueBo(String propertyName) |
List<DocumentNextvalue> |
getDocumentNextvalues() |
abstract String |
getDocumentTypeCode() |
protected <T> T |
getService(Class<T> serviceClass)
Lookups and returns a service class.
|
Timestamp |
getUpdateTimestamp() |
String |
getUpdateUser() |
void |
initialize() |
abstract boolean |
isProcessComplete()
Returns whether the post-processing is considered complete for this document.
|
boolean |
isViewOnly() |
void |
populateAdditionalQualifiedRoleAttributes(Map<String,String> qualifiedRoleAttributes) |
void |
prepareForSave() |
void |
processAfterRetrieve() |
void |
setCustomAttributeDocuments(Map<String,CustomAttributeDocument> customAttributeDocuments)
Sets the customAttributeDocuments attribute value.
|
void |
setDocumentNextvalues(List<DocumentNextvalue> documentNextvalues) |
void |
setUpdateTimestamp(Timestamp updateTimestamp) |
void |
setUpdateUser(String updateUser) |
void |
setViewOnly(boolean viewOnly) |
void |
toCopy() |
void |
updateDocumentDescriptions(List<BudgetDocumentVersion> budgetVersionOverviews) |
void |
validateBusinessRules(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)
Override to provide more meaningful error message
|
org.kuali.rice.krad.workflow.KualiDocumentXmlMaterializer |
wrapDocumentWithMetadataForXmlSerialization()
Wraps a document in an instance of KualiDocumentXmlMaterializer, that provides additional metadata for serialization
|
getAllowsCopy, isSessionDocumentaddCopyErrorDocumentNote, addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, doRouteLevelChange, doRouteStatusChange, 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, useCustomLockDescriptorsafterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refreshNonUpdateableReferences, setExtension, setNewCollectionRecord, setObjectId, setVersionNumberclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaddNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, doRouteStatusChange, 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, useCustomLockDescriptorspublic void initialize()
public void prepareForSave()
prepareForSave in interface org.kuali.rice.krad.document.DocumentprepareForSave in class org.kuali.rice.krad.document.DocumentBasepublic void processAfterRetrieve()
processAfterRetrieve in interface org.kuali.rice.krad.document.DocumentprocessAfterRetrieve in class org.kuali.rice.krad.document.DocumentBasepublic void validateBusinessRules(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)
validateBusinessRules in interface org.kuali.rice.krad.document.DocumentvalidateBusinessRules in class org.kuali.rice.krad.document.DocumentBaseevent - public void updateDocumentDescriptions(List<BudgetDocumentVersion> budgetVersionOverviews)
public Map<String,CustomAttributeDocument> getCustomAttributeDocuments()
public abstract List<? extends DocumentCustomData> getDocumentCustomData()
public Timestamp getUpdateTimestamp()
public void setUpdateTimestamp(Timestamp updateTimestamp)
public String getUpdateUser()
public void setUpdateUser(String updateUser)
public void setDocumentNextvalues(List<DocumentNextvalue> documentNextvalues)
public List<DocumentNextvalue> getDocumentNextvalues()
public DocumentNextvalue getDocumentNextvalueBo(String propertyName)
public void setCustomAttributeDocuments(Map<String,CustomAttributeDocument> customAttributeDocuments)
customAttributeDocuments - The customAttributeDocuments to set.public CustomAttributeDocument getCustomAttributeDocument(String key)
public org.kuali.rice.krad.workflow.KualiDocumentXmlMaterializer wrapDocumentWithMetadataForXmlSerialization()
wrapDocumentWithMetadataForXmlSerialization in interface org.kuali.rice.krad.document.DocumentwrapDocumentWithMetadataForXmlSerialization in class org.kuali.rice.krad.document.DocumentBaseDocument.wrapDocumentWithMetadataForXmlSerialization()protected List<RolePersons> getAllRolePersons()
protected <T> T getService(Class<T> serviceClass)
T - the type of service.serviceClass - the service class.public abstract String getDocumentTypeCode()
public boolean isViewOnly()
public void setViewOnly(boolean viewOnly)
public boolean answerSplitNodeQuestion(String routeNodeName) throws Exception
routeNodeName - The name of the routeNode as it appears in the document workflow definition.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.Exceptionpublic void populateAdditionalQualifiedRoleAttributes(Map<String,String> qualifiedRoleAttributes)
public void toCopy()
throws org.kuali.rice.kew.api.exception.WorkflowException,
IllegalStateException
toCopy in class org.kuali.rice.krad.document.DocumentBaseorg.kuali.rice.kew.api.exception.WorkflowExceptionIllegalStateExceptionpublic abstract boolean isProcessComplete()
Copyright © 2013 The Kuali Foundation. All Rights Reserved.