org.kuali.kfs.module.cg.document
Class ProposalAwardCloseDocument

java.lang.Object
  extended by org.kuali.rice.kns.bo.BusinessObjectBase
      extended by org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          extended by org.kuali.rice.kns.document.DocumentBase
              extended by org.kuali.rice.kns.document.TransactionalDocumentBase
                  extended by org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase
                      extended by org.kuali.kfs.module.cg.document.ProposalAwardCloseDocument
All Implemented Interfaces:
Serializable, org.apache.ojb.broker.PersistenceBrokerAware, 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

public class ProposalAwardCloseDocument
extends FinancialSystemTransactionalDocumentBase

Instances of this class are used to signal to the CloseBatchStep that a close should occur on a particular day.

See Also:
Serialized Form

Field Summary
protected  Long awardClosedCount
           
protected  Date closeOnOrBeforeDate
           
protected  org.kuali.rice.kim.bo.Person personUser
           
protected  String principalName
           
protected  Long proposalClosedCount
           
protected  Date userInitiatedCloseDate
           
 
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
ProposalAwardCloseDocument()
          Default constructor.
 
Method Summary
 Long getAwardClosedCount()
          Gets the awardClosedCount attribute.
 Date getCloseOnOrBeforeDate()
          Gets the closeOnOrBeforeDate attribute.
 org.kuali.rice.kim.bo.Person getPersonUser()
           
 String getPrincipalName()
          Gets the principalName attribute.
 Long getProposalClosedCount()
          Gets the proposalClosedCount attribute.
 Date getUserInitiatedCloseDate()
          Gets the userInitiatedCloseDate attribute.
 boolean isApproved()
           
 void setAwardClosedCount(Long awardClosedCount)
          Sets the awardClosedCount attribute.
 void setCloseOnOrBeforeDate(Date closeOnOrBeforeDate)
          Sets the closeOnOrBeforeDate attribute.
 void setPersonUser(org.kuali.rice.kim.bo.Person personUser)
          Deprecated.  
 void setPrincipalName(String principalName)
          Sets the principalName attribute.
 void setProposalClosedCount(Long proposalClosedCount)
          Sets the proposalClosedCount attribute.
 void setUserInitiatedCloseDate(Date userInitiatedCloseDate)
          Sets the userInitiatedCloseDate attribute.
protected  LinkedHashMap toStringMapper()
           
 
Methods inherited from class org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase
answerSplitNodeQuestion, doRouteStatusChange, getDocumentHeader, prepareForSave, processAfterRetrieve, setDocumentHeader, toErrorCorrection
 
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, 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.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, refreshPessimisticLocks, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, 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

closeOnOrBeforeDate

protected Date closeOnOrBeforeDate

userInitiatedCloseDate

protected Date userInitiatedCloseDate

awardClosedCount

protected Long awardClosedCount

proposalClosedCount

protected Long proposalClosedCount

principalName

protected String principalName

personUser

protected org.kuali.rice.kim.bo.Person personUser
Constructor Detail

ProposalAwardCloseDocument

public ProposalAwardCloseDocument()
Default constructor.

Method Detail

isApproved

public boolean isApproved()
Returns:
whether or not this document has been approved.

getCloseOnOrBeforeDate

public Date getCloseOnOrBeforeDate()
Gets the closeOnOrBeforeDate attribute.

Returns:
Returns the closeOnOrBeforeDate

setCloseOnOrBeforeDate

public void setCloseOnOrBeforeDate(Date closeOnOrBeforeDate)
Sets the closeOnOrBeforeDate attribute.

Parameters:
closeOnOrBeforeDate - The closeOnOrBeforeDate to set.

getAwardClosedCount

public Long getAwardClosedCount()
Gets the awardClosedCount attribute.

Returns:
Returns the awardClosedCount

setAwardClosedCount

public void setAwardClosedCount(Long awardClosedCount)
Sets the awardClosedCount attribute.

Parameters:
awardClosedCount - The awardClosedCount to set.

getProposalClosedCount

public Long getProposalClosedCount()
Gets the proposalClosedCount attribute.

Returns:
Returns the proposalClosedCount

setProposalClosedCount

public void setProposalClosedCount(Long proposalClosedCount)
Sets the proposalClosedCount attribute.

Parameters:
proposalClosedCount - The proposalClosedCount to set.

getPrincipalName

public String getPrincipalName()
Gets the principalName attribute.

Returns:
Returns the principalName

setPrincipalName

public void setPrincipalName(String principalName)
Sets the principalName attribute.

Parameters:
principalName - The principalName to set.

getUserInitiatedCloseDate

public Date getUserInitiatedCloseDate()
Gets the userInitiatedCloseDate attribute.

Returns:
Returns the userInitiatedCloseDate

setUserInitiatedCloseDate

public void setUserInitiatedCloseDate(Date userInitiatedCloseDate)
Sets the userInitiatedCloseDate attribute.

Parameters:
userInitiatedCloseDate - The userInitiatedCloseDate to set.

getPersonUser

public org.kuali.rice.kim.bo.Person getPersonUser()
Returns:
the Person for the personUser

setPersonUser

public void setPersonUser(org.kuali.rice.kim.bo.Person personUser)
Deprecated. 

Parameters:
personUser - The personUser to set.

toStringMapper

protected LinkedHashMap toStringMapper()
Overrides:
toStringMapper in class org.kuali.rice.kns.document.DocumentBase
See Also:
BusinessObjectBase.toStringMapper()


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.