org.kuali.kra.timeandmoney.document

Class TimeAndMoneyDocument

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.timeandmoney.document.TimeAndMoneyDocument

All Implemented Interfaces:

Serializable, Comparable, org.apache.ojb.broker.PersistenceBrokerAware, Permissionable, 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 TimeAndMoneyDocument
extends ResearchDocumentBase
implements org.kuali.rice.krad.document.Copyable, org.kuali.rice.krad.document.SessionDocument, Permissionable, Comparable

This class represents the Time and Money Document Object.

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

Fields inherited from interface org.kuali.kra.common.permissions.Permissionable

AWARD_BUDGET_KEY, AWARD_KEY, COI_DISCLOSURE_KEY, COMMITTEE_KEY, COMMITTEE_SCHEDULE_KEY, IACUC_PROTOCOL_KEY, IACUC_PROTOCOL_ONLINE_REVIEW_KEY, NEGOTIATION_KEY, PROPOSAL_BUDGET_KEY, PROPOSAL_KEY, PROTOCOL_KEY, PROTOCOL_ONLINE_REVIEW_KEY, SPONSOR_HIREARCHY_KEY, SUBAWARD_KEY, TIME_AND_MONEY_KEY

Constructor Summary

Constructors

Constructor and Description
TimeAndMoneyDocument() Constructs a AwardDocument object

Method Summary

Methods

Modifier and Type	Method and Description
void	add(PendingTransaction newPendingTransaction)
List	buildListOfDeletionAwareLists()
int	compareTo(Object o)
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)
protected ActivePendingTransactionsService	getActivePendingTransactionsService()
Award	getAward() Gets the award attribute.
List<AwardAmountTransaction>	getAwardAmountTransactions() Gets the awardAmountTransactions attribute.
Map<String,AwardHierarchy>	getAwardHierarchyItems() Gets the awardHierarchyItems attribute.
Map<String,AwardHierarchyNode>	getAwardHierarchyNodes() Gets the awardHierarchyNodes attribute.
protected AwardHierarchyService	getAwardHierarchyService()
String	getAwardNumber() Gets the awardNumber attribute.
List<AwardVersionHistory>	getAwardVersionHistoryList() Gets the awardVersionHistoryList attribute.
AwardVersionService	getAwardVersionService()
List<? extends DocumentCustomData>	getDocumentCustomData()
String	getDocumentKey() This method returns unique key for implementing document.
String	getDocumentNumberForPermission() This method returns the appropriate document number for implementing documents For award it would be awardNumber and for PDD it would be proposal Number.
String	getDocumentRoleTypeCode()
boolean	getDocumentRouteStatus()
String	getDocumentTypeCode()
String	getLeadUnitNumber()
String	getNamespace()
AwardAmountTransaction	getNewAwardAmountTransaction() Gets the newAwardAmountTransaction attribute.
List<String>	getOrder() Gets the order attribute.
List<PendingTransaction>	getPendingTransactions() Gets the pendingTransactions attribute.
List<String>	getRoleNames() This method gets all the role names for particular document.
String	getRootAwardNumber() Gets the rootAwardNumber attribute.
List<TimeAndMoneyActionSummary>	getTimeAndMoneyActionSummaryItems() Gets the timeAndMoneyActionSummaryItems attribute.
Map<Object,Object>	getTimeAndMoneyHistory() Gets the timeAndMoneyHistory attribute.
protected void	init()
boolean	isInitialSave() This method tests if document has been previously persisted.
boolean	isNew()
boolean	isProcessComplete() This method is to check whether rice async routing is ok now.
void	prepareForSave()
void	setAward(Award award) Sets the award attribute value.
void	setAwardAmountTransactions(List<AwardAmountTransaction> awardAmountTransactions) Sets the awardAmountTransactions attribute value.
void	setAwardHierarchyItems(Map<String,AwardHierarchy> awardHierarchyItems) Sets the awardHierarchyItems attribute value.
void	setAwardHierarchyNodes(Map<String,AwardHierarchyNode> awardHierarchyNodes) Sets the awardHierarchyNodes attribute value.
void	setAwardNumber(String awardNumber) Sets the awardNumber attribute value.
void	setAwardVersionHistoryList(List<AwardVersionHistory> awardVersionHistoryList) Sets the awardVersionHistoryList attribute value.
void	setNewAwardAmountTransaction(AwardAmountTransaction newAwardAmountTransaction) Sets the newAwardAmountTransaction attribute value.
void	setOrder(List<String> order) Sets the order attribute value.
void	setPendingTransactions(List<PendingTransaction> pendingTransactions) Sets the pendingTransactions attribute value.
void	setRootAwardNumber(String rootAwardNumber) Sets the rootAwardNumber attribute value.
void	setTimeAndMoneyActionSummaryItems(List<TimeAndMoneyActionSummary> timeAndMoneyActionSummaryItems) Sets the timeAndMoneyActionSummaryItems attribute value.
void	setTimeAndMoneyHistory(Map<Object,Object> timeAndMoneyHistory) Sets the timeAndMoneyHistory attribute value.

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, 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.kra.common.permissions.Permissionable

populateAdditionalQualifiedRoleAttributes

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

Field Detail

DOCUMENT_TYPE_CODE

public static final String DOCUMENT_TYPE_CODE

See Also:

Constant Field Values

Constructor Detail

TimeAndMoneyDocument

public TimeAndMoneyDocument()

Constructs a AwardDocument object

Method Detail

getDocumentTypeCode

public String getDocumentTypeCode()

Specified by:

getDocumentTypeCode in class ResearchDocumentBase

isInitialSave

public boolean isInitialSave()

This method tests if document has been previously persisted.

Returns:

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

init

protected void init()

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

getAwardHierarchyService

protected AwardHierarchyService getAwardHierarchyService()

getAwardVersionService

public AwardVersionService getAwardVersionService()

getActivePendingTransactionsService

protected ActivePendingTransactionsService getActivePendingTransactionsService()

getDocumentKey

public String getDocumentKey()

Description copied from interface: Permissionable

This method returns unique key for implementing document.

Specified by:

getDocumentKey in interface Permissionable

Returns:

getDocumentNumberForPermission

public String getDocumentNumberForPermission()

Description copied from interface: Permissionable

This method returns the appropriate document number for implementing documents For award it would be awardNumber and for PDD it would be proposal Number.

Specified by:

getDocumentNumberForPermission in interface Permissionable

Returns:

getRoleNames

public List<String> getRoleNames()

Description copied from interface: Permissionable

This method gets all the role names for particular document.

Specified by:

getRoleNames in interface Permissionable

Returns:

getDocumentRouteStatus

public boolean getDocumentRouteStatus()

isNew

public boolean isNew()

getAwardNumber

public String getAwardNumber()

Gets the awardNumber attribute.

Returns:

Returns the awardNumber.

setAwardNumber

public void setAwardNumber(String awardNumber)

Sets the awardNumber attribute value.

Parameters:

awardNumber - The awardNumber to set.

getAwardHierarchyNodes

public Map<String,AwardHierarchyNode> getAwardHierarchyNodes()

Gets the awardHierarchyNodes attribute.

Returns:

Returns the awardHierarchyNodes.

setAwardHierarchyNodes

public void setAwardHierarchyNodes(Map<String,AwardHierarchyNode> awardHierarchyNodes)

Sets the awardHierarchyNodes attribute value.

Parameters:

awardHierarchyNodes - The awardHierarchyNodes to set.

getPendingTransactions

public List<PendingTransaction> getPendingTransactions()

Gets the pendingTransactions attribute.

Returns:

Returns the pendingTransactions.

setPendingTransactions

public void setPendingTransactions(List<PendingTransaction> pendingTransactions)

Sets the pendingTransactions attribute value.

Parameters:

pendingTransactions - The pendingTransactions to set.

add

public void add(PendingTransaction newPendingTransaction)

getAwardHierarchyItems

public Map<String,AwardHierarchy> getAwardHierarchyItems()

Gets the awardHierarchyItems attribute.

Returns:

Returns the awardHierarchyItems.

setAwardHierarchyItems

public void setAwardHierarchyItems(Map<String,AwardHierarchy> awardHierarchyItems)

Sets the awardHierarchyItems attribute value.

Parameters:

awardHierarchyItems - The awardHierarchyItems to set.

getAwardAmountTransactions

public List<AwardAmountTransaction> getAwardAmountTransactions()

Gets the awardAmountTransactions attribute.

Returns:

Returns the awardAmountTransactions.

setAwardAmountTransactions

public void setAwardAmountTransactions(List<AwardAmountTransaction> awardAmountTransactions)

Sets the awardAmountTransactions attribute value.

Parameters:

awardAmountTransactions - The awardAmountTransactions to set.

getTimeAndMoneyHistory

public Map<Object,Object> getTimeAndMoneyHistory()

Gets the timeAndMoneyHistory attribute.

Returns:

Returns the timeAndMoneyHistory.

setTimeAndMoneyHistory

public void setTimeAndMoneyHistory(Map<Object,Object> timeAndMoneyHistory)

Sets the timeAndMoneyHistory attribute value.

Parameters:

timeAndMoneyHistory - The timeAndMoneyHistory to set.

getTimeAndMoneyActionSummaryItems

public List<TimeAndMoneyActionSummary> getTimeAndMoneyActionSummaryItems()

Gets the timeAndMoneyActionSummaryItems attribute.

Returns:

Returns the timeAndMoneyActionSummaryItems.

setTimeAndMoneyActionSummaryItems

public void setTimeAndMoneyActionSummaryItems(List<TimeAndMoneyActionSummary> timeAndMoneyActionSummaryItems)

Sets the timeAndMoneyActionSummaryItems attribute value.

Parameters:

timeAndMoneyActionSummaryItems - The timeAndMoneyActionSummaryItems to set.

getAward

public Award getAward()

Gets the award attribute.

Returns:

Returns the award.

setAward

public void setAward(Award award)

Sets the award attribute value.

Parameters:

award - The award to set.

getNewAwardAmountTransaction

public AwardAmountTransaction getNewAwardAmountTransaction()

Gets the newAwardAmountTransaction attribute.

Returns:

Returns the newAwardAmountTransaction.

setNewAwardAmountTransaction

public void setNewAwardAmountTransaction(AwardAmountTransaction newAwardAmountTransaction)

Sets the newAwardAmountTransaction attribute value.

Parameters:

newAwardAmountTransaction - The newAwardAmountTransaction to set.

getRootAwardNumber

public String getRootAwardNumber()

Gets the rootAwardNumber attribute.

Returns:

Returns the rootAwardNumber.

setRootAwardNumber

public void setRootAwardNumber(String rootAwardNumber)

Sets the rootAwardNumber attribute value.

Parameters:

rootAwardNumber - The rootAwardNumber to set.

prepareForSave

public void prepareForSave()

Specified by:

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

Overrides:

prepareForSave in class ResearchDocumentBase

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface Permissionable

getLeadUnitNumber

public String getLeadUnitNumber()

Specified by:

getLeadUnitNumber in interface Permissionable

getDocumentRoleTypeCode

public String getDocumentRoleTypeCode()

Specified by:

getDocumentRoleTypeCode in interface Permissionable

getAwardVersionHistoryList

public List<AwardVersionHistory> getAwardVersionHistoryList()

Gets the awardVersionHistoryList attribute.

Returns:

Returns the awardVersionHistoryList.

setAwardVersionHistoryList

public void setAwardVersionHistoryList(List<AwardVersionHistory> awardVersionHistoryList)

Sets the awardVersionHistoryList attribute value.

Parameters:

awardVersionHistoryList - The awardVersionHistoryList to set.

getOrder

public List<String> getOrder()

Gets the order attribute.

Returns:

Returns the order.

setOrder

public void setOrder(List<String> order)

Sets the order attribute value.

Parameters:

order - The order to set.

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:

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

getDocumentCustomData

public List<? extends DocumentCustomData> getDocumentCustomData()

Specified by:

getDocumentCustomData in class ResearchDocumentBase