org.dlese.dpc.schemedit.dcs

Class StatusEntry

java.lang.Object

org.dlese.dpc.schemedit.dcs.StatusEntry

public class StatusEntry
extends java.lang.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 and Description
protected org.dom4j.Element	entryElement

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getChangeDate() Gets the changeDate attribute of the StatusEntry object
java.util.Date	getDate() Return the changeDate attribute as a Date.
java.lang.String	getEditor() Gets the editor attribute of the StatusEntry object
org.dom4j.Element	getElement() Returns clone of the entryElement attribute of the StatusEntry object.
java.lang.String	getStatus() Gets the status attribute of the StatusEntry object
java.lang.String	getStatusNote() Gets the statusNote attribute of the StatusEntry object
void	printEntry() Description of the Method
void	setChangeDate(java.lang.String s) Sets the changeDate attribute of the StatusEntry object
void	setEditor(java.lang.String s) Sets the editor attribute of the StatusEntry object
void	setStatus(java.lang.String s) Sets the status attribute of the StatusEntry object
void	setStatusNote(java.lang.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 Detail

entryElement

protected org.dom4j.Element entryElement

Constructor Detail

StatusEntry

public StatusEntry()

Constructor for the StatusEntry object

StatusEntry

public StatusEntry(java.lang.String status,
                   java.lang.String statusNote,
                   java.lang.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(java.lang.String status,
                   java.lang.String statusNote,
                   java.lang.String editor,
                   java.lang.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 Detail

getElement

public org.dom4j.Element getElement()

Returns clone of the entryElement attribute of the StatusEntry object.

Returns:

The element value

getStatus

public java.lang.String getStatus()
                           throws java.lang.Exception

Gets the status attribute of the StatusEntry object

Returns:

The status value

Throws:

java.lang.Exception - if the entryElement does not have an "status" element

setStatus

public void setStatus(java.lang.String s)
               throws java.lang.Exception

Sets the status attribute of the StatusEntry object

Parameters:

s - The new status value

Throws:

java.lang.Exception - Description of the Exception

getStatusNote

public java.lang.String getStatusNote()
                               throws java.lang.Exception

Gets the statusNote attribute of the StatusEntry object

Returns:

The statusNote value

Throws:

java.lang.Exception - if the entryElement does not have an "statusNote" element

setStatusNote

public void setStatusNote(java.lang.String s)
                   throws java.lang.Exception

Sets the statusNote attribute of the StatusEntry object

Parameters:

s - The new statusNote value

Throws:

java.lang.Exception - Description of the Exception

getEditor

public java.lang.String getEditor()
                           throws java.lang.Exception

Gets the editor attribute of the StatusEntry object

Returns:

The editor value

Throws:

java.lang.Exception - if the entryElement does not have an "editor" element

setEditor

public void setEditor(java.lang.String s)
               throws java.lang.Exception

Sets the editor attribute of the StatusEntry object

Parameters:

s - The new editor value

Throws:

java.lang.Exception - Description of the Exception

getChangeDate

public java.lang.String getChangeDate()
                               throws java.lang.Exception

Gets the changeDate attribute of the StatusEntry object

Returns:

The changeDate value

Throws:

java.lang.Exception - Description of the Exception

setChangeDate

public void setChangeDate(java.lang.String s)
                   throws java.lang.Exception

Sets the changeDate attribute of the StatusEntry object

Parameters:

s - The new changeDate value

Throws:

java.lang.Exception - Description of the Exception

getDate

public java.util.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