org.kuali.kfs.module.endow.document
Class EndowmentTransactionalDocumentBase

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.rice.kns.document.DocumentBase
              org.kuali.rice.kns.document.TransactionalDocumentBase
                  org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase
                      org.kuali.kfs.module.endow.document.EndowmentTransactionalDocumentBase

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, EndowmentTransactionalDocument, FinancialSystemTransactionalDocument, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.PersistableBusinessObject, org.kuali.rice.kns.document.Document, org.kuali.rice.kns.document.SessionDocument, org.kuali.rice.kns.document.TransactionalDocument

Direct Known Subclasses:

EndowmentTransactionLinesDocumentBase

public abstract class EndowmentTransactionalDocumentBase
extends FinancialSystemTransactionalDocumentBase
implements EndowmentTransactionalDocument

See Also:

Serialized Form

Field Summary

protected static org.kuali.rice.kns.service.BusinessObjectService	businessObjectService
protected static String	CHECK_IF_ROUTE_SPLIT
protected static org.kuali.rice.kns.service.DateTimeService	dateTimeService
protected boolean	noRouteIndicator
protected boolean	transactionPosted
protected EndowmentTransactionSourceType	transactionSourceType
protected String	transactionSourceTypeCode
protected EndowmentTransactionSubType	transactionSubType
protected String	transactionSubTypeCode

Fields inherited from class org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase

documentHeader, LOG

Fields inherited from class org.kuali.rice.kns.document.DocumentBase

documentBusinessObject, documentNumber

Fields inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

EndowmentTransactionalDocumentBase()
Constructs a EndowmentTransactionalDocumentBase.java.

EndowmentTransactionalDocumentBase(String transactionSourceTypeCode)
Constructs used by creating a recurring or automated eDoc

Method Summary

boolean	answerSplitNodeQuestion(String nodeName)
void	doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent) When document is processed or in the final status, create an PendingTransactionDocumentEntry object and persist documentId, documentType and the approved date to END_PENDING_TRAN_DOC_T.
protected org.kuali.rice.kns.service.BusinessObjectService	getBusinessObjectService()
org.kuali.rice.kns.service.DateTimeService	getDateTimeService()
boolean	getNoRouteIndicator() Gets the noRouteIndicator.
EndowmentTransactionSourceType	getTransactionSourceType() Gets the transactionSourceType.
String	getTransactionSourceTypeCode() Gets the transaction source type code
EndowmentTransactionSubType	getTransactionSubType() Gets the transactionSubType.
String	getTransactionSubTypeCode() Gets the transaction sub-type code
protected void	initializeSourceTypeObj() This method fills source type code for UI on Initial request.
protected void	initializeSubType() This method fills sub type code for UI on Initial request.
boolean	isErrorCorrectedDocument() This method return true if the document is error corrected.
boolean	isTransactionPosted() Gets the transaction posted flag.
void	setNoRouteIndicator(boolean noRouteIndicator) Sets the noRouteIndicator.
void	setTransactionPosted(boolean transactionPosted) Sets the transaction posted flag.
void	setTransactionSourceType(EndowmentTransactionSourceType transactionSourceType) Sets the transactionSourceType.
void	setTransactionSourceTypeCode(String transactionSourceTypeCode) Sets the transaction source type code
void	setTransactionSubType(EndowmentTransactionSubType transactionSubType) Sets the transactionSubType.
void	setTransactionSubTypeCode(String transactionSubTypeCode) Sets the transaction sub-type code
void	toErrorCorrection()

Methods inherited from class org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase

getDocumentHeader, prepareForSave, processAfterRetrieve, setDocumentHeader

Methods inherited from class org.kuali.rice.kns.document.TransactionalDocumentBase

getAllowsCopy, isSessionDocument

Methods inherited from class org.kuali.rice.kns.document.DocumentBase

addCopyErrorDocumentNote, addPessimisticLock, afterLookup, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postProcessSave, prepareForSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, setNewDocumentHeader, setPessimisticLocks, toCopy, toString, toStringBuilder, toStringMapper, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

addNote, afterDelete, afterInsert, afterUpdate, beforeDelete, beforeInsert, beforeInsert, beforeUpdate, beforeUpdate, buildListOfDeletionAwareLists, deleteNote, getAttachmentService, getBoNote, getBoNotes, getExtension, getNoteService, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isAutoIncrementSet, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, setAutoIncrementSet, setBoNotes, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber, supportsBoNotes

Methods inherited from class org.kuali.rice.kns.bo.BusinessObjectBase

prepareForWorkflow

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.kfs.sys.document.FinancialSystemTransactionalDocument

getDocumentHeader

Methods inherited from interface org.kuali.rice.kns.document.Document

addPessimisticLock, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from interface org.kuali.rice.kns.bo.PersistableBusinessObject

addNote, buildListOfDeletionAwareLists, deleteNote, getBoNote, getBoNotes, getExtension, getObjectId, getVersionNumber, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from interface org.kuali.rice.kns.bo.BusinessObject

prepareForWorkflow, refresh

Methods inherited from interface org.apache.ojb.broker.PersistenceBrokerAware

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate

Field Detail

CHECK_IF_ROUTE_SPLIT

protected static final String CHECK_IF_ROUTE_SPLIT

See Also:

Constant Field Values

transactionSubTypeCode

protected String transactionSubTypeCode

transactionSourceTypeCode

protected String transactionSourceTypeCode

transactionPosted

protected boolean transactionPosted

transactionSubType

protected EndowmentTransactionSubType transactionSubType

transactionSourceType

protected EndowmentTransactionSourceType transactionSourceType

businessObjectService

protected static transient org.kuali.rice.kns.service.BusinessObjectService businessObjectService

dateTimeService

protected static transient org.kuali.rice.kns.service.DateTimeService dateTimeService

noRouteIndicator

protected boolean noRouteIndicator

Constructor Detail

EndowmentTransactionalDocumentBase

public EndowmentTransactionalDocumentBase()

Constructs a EndowmentTransactionalDocumentBase.java.

EndowmentTransactionalDocumentBase

public EndowmentTransactionalDocumentBase(String transactionSourceTypeCode)

Constructs used by creating a recurring or automated eDoc

Method Detail

initializeSourceTypeObj

protected void initializeSourceTypeObj()

This method fills source type code for UI on Initial request.

initializeSubType

protected void initializeSubType()

This method fills sub type code for UI on Initial request.

getTransactionSubTypeCode

public String getTransactionSubTypeCode()

Description copied from interface: EndowmentTransactionalDocument

Gets the transaction sub-type code

Specified by:

getTransactionSubTypeCode in interface EndowmentTransactionalDocument

Returns:

transaction sub-type code

See Also:

EndowmentTransactionalDocument.getTransactionSubTypeCode()

setTransactionSubTypeCode

public void setTransactionSubTypeCode(String transactionSubTypeCode)

Description copied from interface: EndowmentTransactionalDocument

Sets the transaction sub-type code

Specified by:

setTransactionSubTypeCode in interface EndowmentTransactionalDocument

See Also:

EndowmentTransactionalDocument.setTransactionSubTypeCode(java.lang.String)

getTransactionSourceTypeCode

public String getTransactionSourceTypeCode()

Description copied from interface: EndowmentTransactionalDocument

Gets the transaction source type code

Specified by:

getTransactionSourceTypeCode in interface EndowmentTransactionalDocument

Returns:

transaction source type code

See Also:

EndowmentTransactionalDocument.getTransactionSourceTypeCode()

setTransactionSourceTypeCode

public void setTransactionSourceTypeCode(String transactionSourceTypeCode)

Description copied from interface: EndowmentTransactionalDocument

Sets the transaction source type code

Specified by:

setTransactionSourceTypeCode in interface EndowmentTransactionalDocument

See Also:

EndowmentTransactionalDocument.setTransactionSourceTypeCode(java.lang.String)

isTransactionPosted

public boolean isTransactionPosted()

Description copied from interface: EndowmentTransactionalDocument

Gets the transaction posted flag.

Specified by:

isTransactionPosted in interface EndowmentTransactionalDocument

Returns:

true of false depending on whether the transactions on this document have been posted or not

See Also:

EndowmentTransactionalDocument.isTransactionPosted()

setTransactionPosted

public void setTransactionPosted(boolean transactionPosted)

Description copied from interface: EndowmentTransactionalDocument

Sets the transaction posted flag.

Specified by:

setTransactionPosted in interface EndowmentTransactionalDocument

Parameters:

transactionPosted - the value to be set

See Also:

EndowmentTransactionalDocument.setTransactionPosted(boolean)

getTransactionSubType

public EndowmentTransactionSubType getTransactionSubType()

Gets the transactionSubType.

Returns:

transactionSubType

setTransactionSubType

public void setTransactionSubType(EndowmentTransactionSubType transactionSubType)

Sets the transactionSubType.

Parameters:

transactionSubType -

getTransactionSourceType

public EndowmentTransactionSourceType getTransactionSourceType()

Gets the transactionSourceType.

Returns:

transactionSourceType

setTransactionSourceType

public void setTransactionSourceType(EndowmentTransactionSourceType transactionSourceType)

Sets the transactionSourceType.

Parameters:

transactionSourceType -

getNoRouteIndicator

public boolean getNoRouteIndicator()

Gets the noRouteIndicator.

Returns:

noRouteIndicator

setNoRouteIndicator

public void setNoRouteIndicator(boolean noRouteIndicator)

Sets the noRouteIndicator.

Specified by:

setNoRouteIndicator in interface EndowmentTransactionalDocument

Parameters:

noRouteIndicator -

toErrorCorrection

public void toErrorCorrection()
                       throws org.kuali.rice.kew.exception.WorkflowException,
                              IllegalStateException

Overrides:

toErrorCorrection in class FinancialSystemTransactionalDocumentBase

Throws:

org.kuali.rice.kew.exception.WorkflowException

IllegalStateException

See Also:

Correctable.toErrorCorrection()

isErrorCorrectedDocument

public boolean isErrorCorrectedDocument()

Description copied from interface: EndowmentTransactionalDocument

This method return true if the document is error corrected.

Specified by:

isErrorCorrectedDocument in interface EndowmentTransactionalDocument

Returns:

See Also:

EndowmentTransactionalDocument.isErrorCorrectedDocument()

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent)

When document is processed or in the final status, create an PendingTransactionDocumentEntry object and persist documentId, documentType and the approved date to END_PENDING_TRAN_DOC_T.

Specified by:

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

Overrides:

doRouteStatusChange in class FinancialSystemTransactionalDocumentBase

See Also:

org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase#doRouteStatusChange()

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String nodeName)
                                throws UnsupportedOperationException

Specified by:

answerSplitNodeQuestion in interface FinancialSystemTransactionalDocument

Overrides:

answerSplitNodeQuestion in class FinancialSystemTransactionalDocumentBase

Throws:

UnsupportedOperationException

getBusinessObjectService

protected org.kuali.rice.kns.service.BusinessObjectService getBusinessObjectService()

getDateTimeService

public org.kuali.rice.kns.service.DateTimeService getDateTimeService()