Package org.dlese.dpc.schemedit.config

Class StatusFlag

java.lang.Object

org.dlese.dpc.schemedit.config.StatusFlag

All Implemented Interfaces:

Serializable

public class StatusFlag
extends Object
implements 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	Description
StatusFlag(String label, String description)	Constructor for the StatusFlag object
StatusFlag(String label, String value, String description)	Constructor for the StatusFlag object
StatusFlag(org.dom4j.Element statusFlagElement)	Constructor for the StatusFlag object that accepts a Element and parses it into label and description values.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

StatusFlag

public StatusFlag(String label,
 String description)

Constructor for the StatusFlag object

Parameters:

label - Description of the Parameter

description - Description of the Parameter

StatusFlag

public StatusFlag(String label,
 String value,
 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 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:

Exception - if unable to parse into label and description values

Method Details

getLabel

public String getLabel()

Gets the label attribute of the StatusFlag object

Returns:

The label value

getValue

public String getValue()

Gets the value attribute of the StatusFlag object

Returns:

The value value

getDescription

public String getDescription()

Gets the description attribute of the StatusFlag object

Returns:

The description value

toString

public String toString()

Description of the Method

Overrides:

toString in class Object

Returns:

Description of the Return Value