org.kuali.rice.kns.bo
Class DocumentHeader

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.rice.kns.bo.DocumentHeader

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, BusinessObject, PersistableBusinessObject

public class DocumentHeader
extends PersistableBusinessObjectBase

Interface for DocumentHeaderBase

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

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

extension, versionNumber

Constructor Summary

DocumentHeader()
Constructor - creates empty instances of dependent objects

Method Summary

String	getDocumentDescription()
String	getDocumentNumber()
String	getDocumentTemplateNumber()
String	getExplanation() Gets the explanation attribute.
String	getOrganizationDocumentNumber()
KualiWorkflowDocument	getWorkflowDocument()
boolean	hasWorkflowDocument()
void	setDocumentDescription(String documentDescription)
void	setDocumentNumber(String documentNumber)
void	setDocumentTemplateNumber(String documentTemplateNumber)
void	setExplanation(String explanation) Sets the explanation attribute value.
void	setOrganizationDocumentNumber(String organizationDocumentNumber)
void	setWorkflowDocument(KualiWorkflowDocument workflowDocument)
protected LinkedHashMap	toStringMapper()

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

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

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

prepareForWorkflow, toString, toStringBuilder

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.bo.BusinessObject

prepareForWorkflow

Constructor Detail

DocumentHeader

public DocumentHeader()

Constructor - creates empty instances of dependent objects

Method Detail

getWorkflowDocument

public KualiWorkflowDocument getWorkflowDocument()

Returns:

workflowDocument

hasWorkflowDocument

public boolean hasWorkflowDocument()

Returns:

true if the workflowDocument is not null

setWorkflowDocument

public void setWorkflowDocument(KualiWorkflowDocument workflowDocument)

Parameters:

workflowDocument -

getDocumentNumber

public String getDocumentNumber()

Returns:

the documentNumber

setDocumentNumber

public void setDocumentNumber(String documentNumber)

Parameters:

documentNumber - the documentNumber to set

getDocumentDescription

public String getDocumentDescription()

Returns:

the documentDescription

setDocumentDescription

public void setDocumentDescription(String documentDescription)

Parameters:

documentDescription - the documentDescription to set

getOrganizationDocumentNumber

public String getOrganizationDocumentNumber()

Returns:

the organizationDocumentNumber

setOrganizationDocumentNumber

public void setOrganizationDocumentNumber(String organizationDocumentNumber)

Parameters:

organizationDocumentNumber - the organizationDocumentNumber to set

getDocumentTemplateNumber

public String getDocumentTemplateNumber()

Returns:

the documentTemplateNumber

setDocumentTemplateNumber

public void setDocumentTemplateNumber(String documentTemplateNumber)

Parameters:

documentTemplateNumber - the documentTemplateNumber to set

toStringMapper

protected LinkedHashMap toStringMapper()

Specified by:

toStringMapper in class BusinessObjectBase

Returns:

Map containing the fieldValues of the key fields for this class, indexed by fieldName

See Also:

BusinessObjectBase.toStringMapper()

getExplanation

public String getExplanation()

Gets the explanation attribute.

Returns:

Returns the explanation.

setExplanation

public void setExplanation(String explanation)

Sets the explanation attribute value.

Parameters:

explanation - The explanation to set.