Package org.kuali.rice.krad.bo

Class DocumentHeader

java.lang.Object
org.kuali.rice.krad.bo.DataObjectBase
org.kuali.rice.krad.bo.PersistableBusinessObjectBaseAdapter
org.kuali.rice.krad.bo.DocumentHeader
All Implemented Interfaces:
Serializable, GloballyUnique, Versioned
@Entity public class DocumentHeader extends PersistableBusinessObjectBaseAdapter
Business Object representing a document header. The document header contains metadata about a document. This contains a reference to the template associated with the document. This also provides the access to the underlying WorkflowDocument associated with this document header.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Field Details

    • documentNumber

      protected String documentNumber

    • documentDescription

      protected String documentDescription

    • organizationDocumentNumber

      protected String organizationDocumentNumber

    • documentTemplateNumber

      protected String documentTemplateNumber

    • explanation

      protected String explanation

  • Constructor Details

    • DocumentHeader

      public DocumentHeader()
      Constructor - creates empty instances of dependent objects

  • Method Details

    • getWorkflowDocument

      public WorkflowDocument getWorkflowDocument()
      Returns an instance of the the WorkflowDocument associated with this document header. The workflowDocument provides the core client interface for interacting with the KEW workflow module.
      Returns:
      workflowDocument

    • 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(WorkflowDocument workflowDocument)
      Associates a WorkflowDocument with this document header.
      Parameters:
      workflowDocument -

    • getDocumentNumber

      public String getDocumentNumber()
      Returns the documentNumber (also known as the docuementHeaderId). This is a unique identifier for the document.
      Returns:
      the documentNumber

    • setDocumentNumber

      public void setDocumentNumber(String documentNumber)
      Sets the documentNumber for this document. It serves as a unique identifier for the document.
      Parameters:
      documentNumber - the documentNumber to set

    • getDocumentDescription

      public String getDocumentDescription()
      Returns the description text for this document.
      Returns:
      the documentDescription

    • setDocumentDescription

      public void setDocumentDescription(String documentDescription)
      Sets the description text for this document.
      Parameters:
      documentDescription - the documentDescription to set

    • getOrganizationDocumentNumber

      public String getOrganizationDocumentNumber()
      Returns the organizationDocumentNumber. This identifier is one that may be used by a client to refer to the document.
      Returns:
      the organizationDocumentNumber

    • setOrganizationDocumentNumber

      public void setOrganizationDocumentNumber(String organizationDocumentNumber)
      Sets the value of the organizationDocumentNumber
      Parameters:
      organizationDocumentNumber - the organizationDocumentNumber to set

    • getDocumentTemplateNumber

      public String getDocumentTemplateNumber()
      Returns the documentTemplateNumber. It identifies the document template associated with this document.
      Returns:
      the documentTemplateNumber

    • setDocumentTemplateNumber

      public void setDocumentTemplateNumber(String documentTemplateNumber)
      Associates this document with a document template.
      Parameters:
      documentTemplateNumber - the id of the documentTemplate associated with this document

    • getExplanation

      public String getExplanation()
      Gets the explanation attribute. This text provides additional information about the purpose of the document.
      Returns:
      Returns the explanation.

    • setExplanation

      public void setExplanation(String explanation)
      Sets the explanation attribute value.
      Parameters:
      explanation - The explanation text string.