org.opennms.netmgt.config.reporting

Class DateParm

java.lang.Object

org.opennms.netmgt.config.reporting.DateParm

All Implemented Interfaces:

Serializable

public class DateParm
extends Object
implements Serializable

An offset period used as a base to determine a real date when running the report

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DateParm()

Method Summary

Modifier and Type	Method and Description
void	deleteDefaultCount()
void	deleteUseAbsoluteDate()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
int	getDefaultCount() Returns the value of field 'defaultCount'.
String	getDefaultInterval() Returns the value of field 'defaultInterval'.
DefaultTime	getDefaultTime() Returns the value of field 'defaultTime'.
String	getDisplayName() Returns the value of field 'displayName'.
String	getName() Returns the value of field 'name'.
boolean	getUseAbsoluteDate() Returns the value of field 'useAbsoluteDate'.
boolean	hasDefaultCount() Method hasDefaultCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasUseAbsoluteDate() Method hasUseAbsoluteDate.
boolean	isUseAbsoluteDate() Returns the value of field 'useAbsoluteDate'.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setDefaultCount(int defaultCount) Sets the value of field 'defaultCount'.
void	setDefaultInterval(String defaultInterval) Sets the value of field 'defaultInterval'.
void	setDefaultTime(DefaultTime defaultTime) Sets the value of field 'defaultTime'.
void	setDisplayName(String displayName) Sets the value of field 'displayName'.
void	setName(String name) Sets the value of field 'name'.
void	setUseAbsoluteDate(boolean useAbsoluteDate) Sets the value of field 'useAbsoluteDate'.
static DateParm	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

DateParm

public DateParm()

Method Detail

deleteDefaultCount

public void deleteDefaultCount()

deleteUseAbsoluteDate

public void deleteUseAbsoluteDate()

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.

getDefaultCount

public int getDefaultCount()

Returns the value of field 'defaultCount'.

Returns:

the value of field 'DefaultCount'.

getDefaultInterval

public String getDefaultInterval()

Returns the value of field 'defaultInterval'.

Returns:

the value of field 'DefaultInterval'.

getDefaultTime

public DefaultTime getDefaultTime()

Returns the value of field 'defaultTime'.

Returns:

the value of field 'DefaultTime'.

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'.

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'.

getUseAbsoluteDate

public boolean getUseAbsoluteDate()

Returns the value of field 'useAbsoluteDate'. The field 'useAbsoluteDate' has the following description: flag to use absolute date if possible

Returns:

the value of field 'UseAbsoluteDate'.

hasDefaultCount

public boolean hasDefaultCount()

Method hasDefaultCount.

Returns:

true if at least one DefaultCount has been added

hasUseAbsoluteDate

public boolean hasUseAbsoluteDate()

Method hasUseAbsoluteDate.

Returns:

true if at least one UseAbsoluteDate has been added

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.

isUseAbsoluteDate

public boolean isUseAbsoluteDate()

Returns the value of field 'useAbsoluteDate'. The field 'useAbsoluteDate' has the following description: flag to use absolute date if possible

Returns:

the value of field 'UseAbsoluteDate'.

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

setDefaultCount

public void setDefaultCount(int defaultCount)

Sets the value of field 'defaultCount'.

Parameters:

defaultCount - the value of field 'defaultCount'.

setDefaultInterval

public void setDefaultInterval(String defaultInterval)

Sets the value of field 'defaultInterval'.

Parameters:

defaultInterval - the value of field 'defaultInterval'.

setDefaultTime

public void setDefaultTime(DefaultTime defaultTime)

Sets the value of field 'defaultTime'.

Parameters:

defaultTime - the value of field 'defaultTime'.

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'.

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'.

setUseAbsoluteDate

public void setUseAbsoluteDate(boolean useAbsoluteDate)

Sets the value of field 'useAbsoluteDate'. The field 'useAbsoluteDate' has the following description: flag to use absolute date if possible

Parameters:

useAbsoluteDate - the value of field 'useAbsoluteDate'.

unmarshal

public static DateParm 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.DateParm

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