org.opennms.netmgt.config
Class KscReportEditor

java.lang.Object
  org.opennms.netmgt.config.KscReportEditor

All Implemented Interfaces:

Serializable

public class KscReportEditor
extends Object
implements Serializable

KscReportEditor class.

Version:

$Id: $

Author:

ranger

See Also:

Serialized Form

Constructor Summary

KscReportEditor()

Method Summary

static KscReportEditor	getFromSession(javax.servlet.http.HttpSession session, boolean required) getFromSession
Graph	getWorkingGraph() Returns the working graph object
int	getWorkingGraphIndex() Returns the working graph index
Report	getWorkingReport() Returns the working report object
void	loadNewWorkingReport() Loads a newly created report into the working report object.
void	loadWorkingGraph(int index) Loads the indexed graph from the working report into the working graph object or creates a new one if the object does not exist
void	loadWorkingReport(KSC_PerformanceReportFactory factory, int index) Loads the indexed report into the working report object.
void	loadWorkingReport(Report report) Loads the source report into the working report object as a new report.
void	loadWorkingReportDuplicate(KSC_PerformanceReportFactory factory, int index) Loads the indexed report into the working report object as a duplicate report.
static void	unloadFromSession(javax.servlet.http.HttpSession session)
void	unloadWorkingGraph(int requested_graphnum) Unloads the working graph into the working report list at the requested graph number.
void	unloadWorkingReport(KSC_PerformanceReportFactory factory) Unloads the working report into the indexed report list at the point identified by working_index (this should have been set when the working report was loaded), then create a new blank working report

Methods inherited from class java.lang.Object

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

Constructor Detail

KscReportEditor

public KscReportEditor()

Method Detail

getWorkingReport

public Report getWorkingReport()

Returns the working report object

Returns:

a Report object.

getWorkingGraph

public Graph getWorkingGraph()

Returns the working graph object

Returns:

a Graph object.

getWorkingGraphIndex

public int getWorkingGraphIndex()

Returns the working graph index

Returns:

a int.

loadWorkingGraph

public void loadWorkingGraph(int index)
                      throws org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException

Loads the indexed graph from the working report into the working graph object or creates a new one if the object does not exist

Parameters:

index - a int.

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

unloadWorkingGraph

public void unloadWorkingGraph(int requested_graphnum)
                        throws org.exolab.castor.xml.MarshalException,
                               org.exolab.castor.xml.ValidationException

Unloads the working graph into the working report list at the requested graph number. If the graph was modified from an existing graph, then the old one is replaced. A new blank working graph is then created

Parameters:

requested_graphnum - a int.

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

loadWorkingReport

public void loadWorkingReport(Report report)
                       throws org.exolab.castor.xml.MarshalException,
                              org.exolab.castor.xml.ValidationException

Loads the source report into the working report object as a new report.

Parameters:

report - a Report object.

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

loadWorkingReport

public void loadWorkingReport(KSC_PerformanceReportFactory factory,
                              int index)
                       throws org.exolab.castor.xml.MarshalException,
                              org.exolab.castor.xml.ValidationException

Loads the indexed report into the working report object.

Parameters:

factory - a KSC_PerformanceReportFactory object.

index - a int.

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

loadWorkingReportDuplicate

public void loadWorkingReportDuplicate(KSC_PerformanceReportFactory factory,
                                       int index)
                                throws org.exolab.castor.xml.MarshalException,
                                       org.exolab.castor.xml.ValidationException

Loads the indexed report into the working report object as a duplicate report. The ID in the loaded report will be removed so a new ID will be created when the duplicated report is saved.

Parameters:

factory - a KSC_PerformanceReportFactory object.

index - a int.

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

loadNewWorkingReport

public void loadNewWorkingReport()

Loads a newly created report into the working report object.

unloadWorkingReport

public void unloadWorkingReport(KSC_PerformanceReportFactory factory)
                         throws org.exolab.castor.xml.MarshalException,
                                org.exolab.castor.xml.ValidationException

Unloads the working report into the indexed report list at the point identified by working_index (this should have been set when the working report was loaded), then create a new blank working report

Parameters:

factory - a KSC_PerformanceReportFactory object.

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

getFromSession

public static KscReportEditor getFromSession(javax.servlet.http.HttpSession session,
                                             boolean required)

getFromSession

Parameters:

session - a HttpSession object.

required - a boolean.

Returns:

a KscReportEditor object.

unloadFromSession

public static void unloadFromSession(javax.servlet.http.HttpSession session)