org.opennms.netmgt.config.reporting

Class StringParm

java.lang.Object

org.opennms.netmgt.config.reporting.StringParm

All Implemented Interfaces:

Serializable

public class StringParm
extends Object
implements Serializable

A string parameter passed to the report engine

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StringParm()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getDefault() Returns the value of field 'default'.
String	getDisplayName() Returns the value of field 'displayName'.
String	getInputType() Returns the value of field 'inputType'.
String	getName() Returns the value of field 'name'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setDefault(String _default) Sets the value of field 'default'.
void	setDisplayName(String displayName) Sets the value of field 'displayName'.
void	setInputType(String inputType) Sets the value of field 'inputType'.
void	setName(String name) Sets the value of field 'name'.
static StringParm	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

StringParm

public StringParm()

Method Detail

equals

public boolean equals(Object obj)

Overrides the java.lang.Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getDefault

public String getDefault()

Returns the value of field 'default'. The field 'default' has the following description: value

Returns:

the value of field 'Default'.

getDisplayName

public String getDisplayName()

Returns the value of field 'displayName'. The field 'displayName' has the following description: the name of this parameter as displayed in the webui

Returns:

the value of field 'DisplayName'.

getInputType

public String getInputType()

Returns the value of field 'inputType'. The field 'inputType' has the following description: the type of input field used. Allows the webUI to use pre-filled drop-down boxes (reportCategorySelector) or freeText

Returns:

the value of field 'InputType'.

getName

public String getName()

Returns the value of field 'name'. The field 'name' has the following description: the name of this parameter as passed to the report engine

Returns:

the value of field 'Name'.

hashCode

public int hashCode()

Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

setDefault

public void setDefault(String _default)

Sets the value of field 'default'. The field 'default' has the following description: value

Parameters:

_default -

default - the value of field 'default'.

setDisplayName

public void setDisplayName(String displayName)

Sets the value of field 'displayName'. The field 'displayName' has the following description: the name of this parameter as displayed in the webui

Parameters:

displayName - the value of field 'displayName'.

setInputType

public void setInputType(String inputType)

Sets the value of field 'inputType'. The field 'inputType' has the following description: the type of input field used. Allows the webUI to use pre-filled drop-down boxes (reportCategorySelector) or freeText

Parameters:

inputType - the value of field 'inputType'.

setName

public void setName(String name)

Sets the value of field 'name'. The field 'name' has the following description: the name of this parameter as passed to the report engine

Parameters:

name - the value of field 'name'.

unmarshal

public static StringParm unmarshal(Reader reader)
                            throws org.exolab.castor.xml.MarshalException,
                                   org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.reporting.StringParm

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema