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

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.cg.document.CloseDocument

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 CloseDocument
extends FinancialSystemTransactionalDocumentBase

Instances of CloseDocument indicate dates on which the CloseBatchStep should be executed.

See Also:

Serialized Form

Field Summary

protected Date	closeOnOrBeforeDate
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

CloseDocument()

Method Summary

Date	getCloseOnOrBeforeDate() Gets the date on which this instance should trigger the CloseBatchStep to close out {Proposal}s and {@link Award}s.
Date	getUserInitiatedCloseDate() The CloseBatchStep will close out Proposals and Awards not yet closed and created before the date returned from this method.
void	setCloseOnOrBeforeDate(Date closeOnOrBeforeDate) Sets the date on which this instance should trigger the CloseBatchStep to close out {Proposal}s and {@link Award}s.
void	setUserInitiatedCloseDate(Date userInitiatedCloseDate) The CloseBatchStep will close out Proposals and Awards not yet closed and created before the date passed into this method.

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, 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.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

userInitiatedCloseDate

protected Date userInitiatedCloseDate

closeOnOrBeforeDate

protected Date closeOnOrBeforeDate

Constructor Detail

CloseDocument

public CloseDocument()

Method Detail

getUserInitiatedCloseDate

public Date getUserInitiatedCloseDate()

The CloseBatchStep will close out Proposals and Awards not yet closed and created before the date returned from this method.

Returns:

the date to use for comparison. See method description.

setUserInitiatedCloseDate

public void setUserInitiatedCloseDate(Date userInitiatedCloseDate)

The CloseBatchStep will close out Proposals and Awards not yet closed and created before the date passed into this method.

Parameters:

closeOnOrBeforeDate - the date to use for comparison. See method description.

getCloseOnOrBeforeDate

public Date getCloseOnOrBeforeDate()

Gets the date on which this instance should trigger the CloseBatchStep to close out {Proposal}s and {@link Award}s.

Returns:

the date on which this instance should trigger the CloseBatchStep to close out {Proposal}s and {@link Award}s.

setCloseOnOrBeforeDate

public void setCloseOnOrBeforeDate(Date closeOnOrBeforeDate)

Sets the date on which this instance should trigger the CloseBatchStep to close out {Proposal}s and {@link Award}s.

Parameters:

userInitiatedCloseDate - the date on which this instance should trigger the CloseBatchStep to close out {Proposal}s and {@link Award}s.