org.opennms.netmgt.config.databaseReports
Class Report

java.lang.Object
  org.opennms.netmgt.config.databaseReports.Report

All Implemented Interfaces:

Serializable

public class Report
extends Object
implements Serializable

Class Report.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Report()

Method Summary

void	deleteOnline()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getDescription() Returns the value of field 'description'.
String	getDisplayName() Returns the value of field 'displayName'.
String	getId() Returns the value of field 'id'.
boolean	getOnline() Returns the value of field 'online'.
String	getReportService() Returns the value of field 'reportService'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasOnline() Method hasOnline.
boolean	isOnline() Returns the value of field 'online'.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setDescription(String description) Sets the value of field 'description'.
void	setDisplayName(String displayName) Sets the value of field 'displayName'.
void	setId(String id) Sets the value of field 'id'.
void	setOnline(boolean online) Sets the value of field 'online'.
void	setReportService(String reportService) Sets the value of field 'reportService'.
static Report	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

Report

public Report()

Method Detail

deleteOnline

public void deleteOnline()

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.

getDescription

public String getDescription()

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

Returns:

the value of field 'Description'.

getDisplayName

public String getDisplayName()

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

Returns:

the value of field 'DisplayName'.

getId

public String getId()

Returns the value of field 'id'. The field 'id' has the following description: the name of this report as defined in engine configuration

Returns:

the value of field 'Id'.

getOnline

public boolean getOnline()

Returns the value of field 'online'. The field 'online' has the following description: determines if the report may be executed and immediately displayed in the browser. If not set OpenNMS assumes that the report must be executed in batch mode.

Returns:

the value of field 'Online'.

getReportService

public String getReportService()

Returns the value of field 'reportService'. The field 'reportService' has the following description: the name of the engine to use to process and render this report

Returns:

the value of field 'ReportService'.

hasOnline

public boolean hasOnline()

Method hasOnline.

Returns:

true if at least one Online 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.

isOnline

public boolean isOnline()

Returns the value of field 'online'. The field 'online' has the following description: determines if the report may be executed and immediately displayed in the browser. If not set OpenNMS assumes that the report must be executed in batch mode.

Returns:

the value of field 'Online'.

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

setDescription

public void setDescription(String description)

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

Parameters:

description - the value of field 'description'.

setDisplayName

public void setDisplayName(String displayName)

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

Parameters:

displayName - the value of field 'displayName'.

setId

public void setId(String id)

Sets the value of field 'id'. The field 'id' has the following description: the name of this report as defined in engine configuration

Parameters:

id - the value of field 'id'.

setOnline

public void setOnline(boolean online)

Sets the value of field 'online'. The field 'online' has the following description: determines if the report may be executed and immediately displayed in the browser. If not set OpenNMS assumes that the report must be executed in batch mode.

Parameters:

online - the value of field 'online'.

setReportService

public void setReportService(String reportService)

Sets the value of field 'reportService'. The field 'reportService' has the following description: the name of the engine to use to process and render this report

Parameters:

reportService - the value of field 'reportService'.

unmarshal

public static Report 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.databaseReports.Report

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