org.kuali.ole.sys.businessobject

Class FinancialSystemDocumentHeader

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.ole.sys.businessobject.FinancialSystemDocumentHeader

All Implemented Interfaces:

Serializable, Cloneable, org.apache.ojb.broker.PersistenceBrokerAware, org.eclipse.persistence.descriptors.changetracking.ChangeTracker, org.eclipse.persistence.internal.descriptors.PersistenceEntity, org.eclipse.persistence.internal.descriptors.PersistenceObject, org.eclipse.persistence.internal.weaving.PersistenceWeaved, org.eclipse.persistence.internal.weaving.PersistenceWeavedChangeTracking, org.eclipse.persistence.internal.weaving.PersistenceWeavedFetchGroups, org.eclipse.persistence.internal.weaving.PersistenceWeavedRest, org.eclipse.persistence.queries.FetchGroupTracker, 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

@Entity
public class FinancialSystemDocumentHeader
extends org.kuali.rice.krad.bo.PersistableBusinessObjectBase

This class is a custom DocumentHeader class used by OLE to facilitate custom data fields and a few UI fields

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	correctedByDocumentId
protected String	documentNumber
protected String	financialDocumentInErrorNumber
protected String	financialDocumentStatusCode
protected org.kuali.rice.core.api.util.type.KualiDecimal	financialDocumentTotalAmount

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

extension, newCollectionRecord, objectId, versionNumber

Fields inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

_persistence_cacheKey, _persistence_fetchGroup, _persistence_href, _persistence_listener, _persistence_primaryKey, _persistence_relationshipInfo, _persistence_session, _persistence_shouldRefreshFetchGroup

Constructor Summary

Constructors

Constructor and Description
FinancialSystemDocumentHeader() Constructor - creates empty instances of dependent objects

Method Summary

Methods

Modifier and Type	Method and Description
String	getApplicationDocumentStatus() Gets the applicationDocumentStatus attribute.
String	getCorrectedByDocumentId() Gets the correctedByDocumentId attribute.
Date	getDocumentFinalDate() Gets the documentFinalDate attribute.
String	getDocumentNumber()
String	getFinancialDocumentInErrorNumber() Gets the financialDocumentInErrorNumber attribute.
String	getFinancialDocumentStatusCode() Gets the financialDocumentStatusCode attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getFinancialDocumentTotalAmount() Gets the financialDocumentTotalAmount attribute.
org.kuali.rice.kew.api.WorkflowDocument	getWorkflowDocument() method to retrieve the workflow document for the given documentHeader.
boolean	hasWorkflowDocument() Returns whether this document header has a WorkflowDocument associated with it.
void	setApplicationDocumentStatus(String applicationDocumentStatus) Sets the applicationDocumentStatus attribute.
void	setCorrectedByDocumentId(String correctedByDocumentId) Sets the correctedByDocumentId attribute value.
void	setDocumentNumber(String documentNumber)
void	setFinancialDocumentInErrorNumber(String financialDocumentInErrorNumber) Sets the financialDocumentInErrorNumber attribute value.
void	setFinancialDocumentStatusCode(String financialDocumentStatusCode) Sets the financialDocumentStatusCode attribute value.
void	setFinancialDocumentTotalAmount(org.kuali.rice.core.api.util.type.KualiDecimal financialDocumentTotalAmount) Sets the financialDocumentTotalAmount attribute value.
void	setWorkflowDocument(org.kuali.rice.kew.api.WorkflowDocument workflowDocument) Associates a WorkflowDocument with this document header.
void	updateAndSaveAppDocStatus(String applicationDocumentStatus) Updates status of this document and saves the workfl *

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

_persistence_get_objectId, _persistence_get_versionNumber, _persistence_get, _persistence_new, _persistence_post_clone, _persistence_set_objectId, _persistence_set_versionNumber, _persistence_set, afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getLegacyDataAdapter, getObjectId, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

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

_persistence_checkFetched, _persistence_checkFetchedForSet, _persistence_getCacheKey, _persistence_getFetchGroup, _persistence_getHref, _persistence_getId, _persistence_getPropertyChangeListener, _persistence_getRelationships, _persistence_getSession, _persistence_isAttributeFetched, _persistence_propertyChange, _persistence_resetFetchGroup, _persistence_setCacheKey, _persistence_setFetchGroup, _persistence_setHref, _persistence_setId, _persistence_setPropertyChangeListener, _persistence_setRelationships, _persistence_setSession, _persistence_setShouldRefreshFetchGroup, _persistence_shallow_clone, _persistence_shouldRefreshFetchGroup, 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.core.api.mo.ModelObjectBasic

toString

Methods inherited from interface org.eclipse.persistence.internal.descriptors.PersistenceObject

_persistence_shallow_clone

Field Detail

financialDocumentTotalAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal financialDocumentTotalAmount

correctedByDocumentId

protected String correctedByDocumentId

financialDocumentInErrorNumber

protected String financialDocumentInErrorNumber

financialDocumentStatusCode

protected String financialDocumentStatusCode

documentNumber

protected String documentNumber

Constructor Detail

FinancialSystemDocumentHeader

public FinancialSystemDocumentHeader()

Constructor - creates empty instances of dependent objects

Method Detail

getFinancialDocumentTotalAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getFinancialDocumentTotalAmount()

Gets the financialDocumentTotalAmount attribute.

Returns:

Returns the financialDocumentTotalAmount.

setFinancialDocumentTotalAmount

public void setFinancialDocumentTotalAmount(org.kuali.rice.core.api.util.type.KualiDecimal financialDocumentTotalAmount)

Sets the financialDocumentTotalAmount attribute value.

Parameters:

financialDocumentTotalAmount - The financialDocumentTotalAmount to set.

getCorrectedByDocumentId

public String getCorrectedByDocumentId()

Gets the correctedByDocumentId attribute.

Returns:

Returns the correctedByDocumentId.

setCorrectedByDocumentId

public void setCorrectedByDocumentId(String correctedByDocumentId)

Sets the correctedByDocumentId attribute value.

Parameters:

correctedByDocumentId - The correctedByDocumentId to set.

getFinancialDocumentInErrorNumber

public String getFinancialDocumentInErrorNumber()

Gets the financialDocumentInErrorNumber attribute.

Returns:

Returns the financialDocumentInErrorNumber.

setFinancialDocumentInErrorNumber

public void setFinancialDocumentInErrorNumber(String financialDocumentInErrorNumber)

Sets the financialDocumentInErrorNumber attribute value.

Parameters:

financialDocumentInErrorNumber - The financialDocumentInErrorNumber to set.

getFinancialDocumentStatusCode

public String getFinancialDocumentStatusCode()

Gets the financialDocumentStatusCode attribute.

Returns:

Returns the financialDocumentStatusCode.

setFinancialDocumentStatusCode

public void setFinancialDocumentStatusCode(String financialDocumentStatusCode)

Sets the financialDocumentStatusCode attribute value.

Parameters:

financialDocumentStatusCode - The financialDocumentStatusCode to set.

getDocumentNumber

public String getDocumentNumber()

setDocumentNumber

public void setDocumentNumber(String documentNumber)

getDocumentFinalDate

public Date getDocumentFinalDate()

Gets the documentFinalDate attribute.

Returns:

Returns the documentFinalDate.

getApplicationDocumentStatus

public String getApplicationDocumentStatus()

Gets the applicationDocumentStatus attribute.

Returns:

Returns the applicationDocumentStatus

setApplicationDocumentStatus

public void setApplicationDocumentStatus(String applicationDocumentStatus)

Sets the applicationDocumentStatus attribute.

Parameters:

applicationDocumentStatus - The applicationDocumentStatus to set.

hasWorkflowDocument

public boolean hasWorkflowDocument()

Returns whether this document header has a WorkflowDocument associated with it.

Returns:

true if the workflowDocument is not null

setWorkflowDocument

public void setWorkflowDocument(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)

Associates a WorkflowDocument with this document header.

Parameters:

workflowDocument -

getWorkflowDocument

public org.kuali.rice.kew.api.WorkflowDocument getWorkflowDocument()

method to retrieve the workflow document for the given documentHeader.

Returns:

workflowDocument

updateAndSaveAppDocStatus

public void updateAndSaveAppDocStatus(String applicationDocumentStatus)
                               throws org.kuali.rice.kew.api.exception.WorkflowException

Updates status of this document and saves the workfl *

Parameters:

applicationDocumentStatus - is the app doc status to save

Throws:

org.kuali.rice.kew.api.exception.WorkflowException