Package org.dlese.dpc.schemedit.dcs

Class StatusEntry

java.lang.Object
org.dlese.dpc.schemedit.dcs.StatusEntry
public class StatusEntry extends Object
Wrapper for a StatusEntry element of a DcsDataRecord.

Contains the following elements:

  • editor - the person (if known) that created the statusEntry
  • status - the status flag (e.g., "Done").
  • statusNote - an explanation for the assigned status
  • changeDate - a timestamp for creation of the StatusEntry
Author:
ostwald

$Id $

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.dom4j.Element
    entryElement
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    StatusEntry()
    Constructor for the StatusEntry object
    StatusEntry(String status, String statusNote, String editor)
    Constructor for the StatusEntry object given parameters as Strings.
    StatusEntry(String status, String statusNote, String editor, String changeDate)
    Constructor for the StatusEntry object given parameters as Strings.
    StatusEntry(org.dom4j.Element entryElement)
    Constructor for the StatusEntry object given a Element containing the values for statusEntry attributes.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getChangeDate()
    Gets the changeDate attribute of the StatusEntry object
    Date
    getDate()
    Return the changeDate attribute as a Date.
    String
    getEditor()
    Gets the editor attribute of the StatusEntry object
    org.dom4j.Element
    getElement()
    Returns clone of the entryElement attribute of the StatusEntry object.
    String
    getStatus()
    Gets the status attribute of the StatusEntry object
    String
    getStatusNote()
    Gets the statusNote attribute of the StatusEntry object
    void
    printEntry()
    Description of the Method
    void
    setChangeDate(String s)
    Sets the changeDate attribute of the StatusEntry object
    void
    setEditor(String s)
    Sets the editor attribute of the StatusEntry object
    void
    setStatus(String s)
    Sets the status attribute of the StatusEntry object
    void
    setStatusNote(String s)
    Sets the statusNote attribute of the StatusEntry object

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • entryElement

      protected org.dom4j.Element entryElement

  • Constructor Details

    • StatusEntry

      public StatusEntry()
      Constructor for the StatusEntry object

    • StatusEntry

      public StatusEntry(String status, String statusNote, String editor)
      Constructor for the StatusEntry object given parameters as Strings.
      Parameters:
      status - status label
      statusNote - note describing status change
      editor - who made the change

    • StatusEntry

      public StatusEntry(String status, String statusNote, String editor, String changeDate)
      Constructor for the StatusEntry object given parameters as Strings.
      Parameters:
      status - status label
      statusNote - note describing status change
      editor - who made the change
      changeDate - textual representation of date

    • StatusEntry

      public StatusEntry(org.dom4j.Element entryElement)
      Constructor for the StatusEntry object given a Element containing the values for statusEntry attributes.
      Parameters:
      entryElement - Description of the Parameter

  • Method Details

    • getElement

      public org.dom4j.Element getElement()
      Returns clone of the entryElement attribute of the StatusEntry object.
      Returns:
      The element value

    • getStatus

      public String getStatus() throws Exception
      Gets the status attribute of the StatusEntry object
      Returns:
      The status value
      Throws:
      Exception - if the entryElement does not have an "status" element

    • setStatus

      public void setStatus(String s) throws Exception
      Sets the status attribute of the StatusEntry object
      Parameters:
      s - The new status value
      Throws:
      Exception - Description of the Exception

    • getStatusNote

      public String getStatusNote() throws Exception
      Gets the statusNote attribute of the StatusEntry object
      Returns:
      The statusNote value
      Throws:
      Exception - if the entryElement does not have an "statusNote" element

    • setStatusNote

      public void setStatusNote(String s) throws Exception
      Sets the statusNote attribute of the StatusEntry object
      Parameters:
      s - The new statusNote value
      Throws:
      Exception - Description of the Exception

    • getEditor

      public String getEditor() throws Exception
      Gets the editor attribute of the StatusEntry object
      Returns:
      The editor value
      Throws:
      Exception - if the entryElement does not have an "editor" element

    • setEditor

      public void setEditor(String s) throws Exception
      Sets the editor attribute of the StatusEntry object
      Parameters:
      s - The new editor value
      Throws:
      Exception - Description of the Exception

    • getChangeDate

      public String getChangeDate() throws Exception
      Gets the changeDate attribute of the StatusEntry object
      Returns:
      The changeDate value
      Throws:
      Exception - Description of the Exception

    • setChangeDate

      public void setChangeDate(String s) throws Exception
      Sets the changeDate attribute of the StatusEntry object
      Parameters:
      s - The new changeDate value
      Throws:
      Exception - Description of the Exception

    • getDate

      public Date getDate()
      Return the changeDate attribute as a Date. If the changeDate attribute has not been set, then set it as "now" and return the corresponding date object.
      Returns:
      The date value

    • printEntry

      public void printEntry()
      Description of the Method