org.dlese.dpc.schemedit.config

Class StatusFlag

java.lang.Object

org.dlese.dpc.schemedit.config.StatusFlag

All Implemented Interfaces:

java.io.Serializable

public class StatusFlag
extends java.lang.Object
implements java.io.Serializable

Hold a tuple of status value, label and accompanying decription.

For all but "Final status flags", the value and label are the same. For Final flags, the value is an encoded string that allows the system to identify the flag as a Final (see StatusFlags).

Author:

ostwald

$Id $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StatusFlag(org.dom4j.Element statusFlagElement) Constructor for the StatusFlag object that accepts a Element and parses it into label and description values.
StatusFlag(java.lang.String label, java.lang.String description) Constructor for the StatusFlag object
StatusFlag(java.lang.String label, java.lang.String value, java.lang.String description) Constructor for the StatusFlag object

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Gets the description attribute of the StatusFlag object
java.lang.String	getLabel() Gets the label attribute of the StatusFlag object
java.lang.String	getValue() Gets the value attribute of the StatusFlag object
java.lang.String	toString() Description of the Method

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusFlag

public StatusFlag(java.lang.String label,
                  java.lang.String description)

Constructor for the StatusFlag object

Parameters:

label - Description of the Parameter

description - Description of the Parameter

StatusFlag

public StatusFlag(java.lang.String label,
                  java.lang.String value,
                  java.lang.String description)

Constructor for the StatusFlag object

Parameters:

label - Description of the Parameter

value - Description of the Parameter

description - Description of the Parameter

StatusFlag

public StatusFlag(org.dom4j.Element statusFlagElement)
           throws java.lang.Exception

Constructor for the StatusFlag object that accepts a Element and parses it into label and description values.

Parameters:

statusFlagElement - Description of the Parameter

Throws:

java.lang.Exception - if unable to parse into label and description values

Method Detail

getLabel

public java.lang.String getLabel()

Gets the label attribute of the StatusFlag object

Returns:

The label value

getValue

public java.lang.String getValue()

Gets the value attribute of the StatusFlag object

Returns:

The value value

getDescription

public java.lang.String getDescription()

Gets the description attribute of the StatusFlag object

Returns:

The description value

toString

public java.lang.String toString()

Description of the Method

Overrides:

toString in class java.lang.Object

Returns:

Description of the Return Value