Report (OpenNMS 19.1.0 API)

java.lang.Object
- org.opennms.netmgt.config.kscReports.Report

All Implemented Interfaces:

Serializable
```
public class Report
extends Object
implements Serializable
```
Class Report.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Report()

Constructors
Constructor and Description
`Report()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addGraph(Graph vGraph)`
`void`	`addGraph(int index, Graph vGraph)`
`void`	`deleteGraphsPerLine()`
`void`	`deleteId()`
`void`	`deleteShowGraphtypeButton()`
`void`	`deleteShowTimespanButton()`
`Enumeration<Graph>`	`enumerateGraph()` Method enumerateGraph.
`boolean`	`equals(Object obj)` Overrides the Object.equals method.
`Graph[]`	`getGraph()` Method getGraph.Returns the contents of the collection in an Array.
`Graph`	`getGraph(int index)` Method getGraph.
`List<Graph>`	`getGraphCollection()` Method getGraphCollection.Returns a reference to 'graphList'.
`int`	`getGraphCount()` Method getGraphCount.
`Integer`	`getGraphsPerLine()` Returns the value of field 'graphs_per_line'.
`Integer`	`getId()` Returns the value of field 'id'.
`Boolean`	`getShowGraphtypeButton()` Returns the value of field 'show_graphtype_button'.
`Boolean`	`getShowTimespanButton()` Returns the value of field 'show_timespan_button'.
`String`	`getTitle()` Returns the value of field 'title'.
`boolean`	`hasGraphsPerLine()` Method hasGraphs_per_line.
`int`	`hashCode()` Method hashCode.
`boolean`	`hasId()` Method hasId.
`boolean`	`hasShowGraphtypeButton()` Method hasShow_graphtype_button.
`boolean`	`hasShowTimespanButton()` Method hasShow_timespan_button.
`Boolean`	`isShowGraphtypeButton()` Returns the value of field 'show_graphtype_button'.
`Boolean`	`isShowTimespanButton()` Returns the value of field 'show_timespan_button'.
`Iterator<Graph>`	`iterateGraph()` Method iterateGraph.
`void`	`removeAllGraph()`
`boolean`	`removeGraph(Graph vGraph)` Method removeGraph.
`Graph`	`removeGraphAt(int index)` Method removeGraphAt.
`void`	`setGraph(Graph[] vGraphArray)`
`void`	`setGraph(int index, Graph vGraph)`
`void`	`setGraph(List<Graph> vGraphList)` Sets the value of 'graphList' by copying the given Vector.
`void`	`setGraphCollection(List<Graph> graphList)` Deprecated.
`void`	`setGraphsPerLine(Integer graphs_per_line)` Sets the value of field 'graphs_per_line'.
`void`	`setId(Integer id)` Sets the value of field 'id'.
`void`	`setShowGraphtypeButton(Boolean show_graphtype_button)` Sets the value of field 'show_graphtype_button'.
`void`	`setShowTimespanButton(Boolean show_timespan_button)` Sets the value of field 'show_timespan_button'.
`void`	`setTitle(String title)` Sets the value of field 'title'.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Report
```
public Report()
```
- Method Detail
  - addGraph
```
public void addGraph(Graph vGraph)
              throws IndexOutOfBoundsException
```
    Parameters:
    
    vGraph -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addGraph
```
public void addGraph(int index,
                     Graph vGraph)
              throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vGraph -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - deleteGraphsPerLine
```
public void deleteGraphsPerLine()
```
  - deleteId
```
public void deleteId()
```
  - deleteShowGraphtypeButton
```
public void deleteShowGraphtypeButton()
```
  - deleteShowTimespanButton
```
public void deleteShowTimespanButton()
```
  - enumerateGraph
```
public Enumeration<Graph> enumerateGraph()
```
    Method enumerateGraph.
    
    Returns:
    
    an Enumeration over all possible elements of this collection
  - equals
```
public boolean equals(Object obj)
```
    Overrides the Object.equals method.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj -
    
    Returns:
    
    true if the objects are equal.
  - getGraph
```
public Graph getGraph(int index)
               throws IndexOutOfBoundsException
```
    Method getGraph.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the Graph at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getGraph
```
public Graph[] getGraph()
```
    Method getGraph.Returns the contents of the collection in an Array.
    Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
    
    Returns:
    
    this collection as an Array
  - getGraphCollection
```
public List<Graph> getGraphCollection()
```
    Method getGraphCollection.Returns a reference to 'graphList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getGraphCount
```
public int getGraphCount()
```
    Method getGraphCount.
    
    Returns:
    
    the size of this collection
  - getGraphsPerLine
```
public Integer getGraphsPerLine()
```
    Returns the value of field 'graphs_per_line'.
    
    Returns:
    
    the value of field 'Graphs_per_line'.
  - getId
```
public Integer getId()
```
    Returns the value of field 'id'.
    
    Returns:
    
    the value of field 'Id'.
  - getShowGraphtypeButton
```
public Boolean getShowGraphtypeButton()
```
    Returns the value of field 'show_graphtype_button'.
    
    Returns:
    
    the value of field 'Show_graphtype_button'.
  - getShowTimespanButton
```
public Boolean getShowTimespanButton()
```
    Returns the value of field 'show_timespan_button'.
    
    Returns:
    
    the value of field 'Show_timespan_button'.
  - getTitle
```
public String getTitle()
```
    Returns the value of field 'title'.
    
    Returns:
    
    the value of field 'Title'.
  - hasGraphsPerLine
```
public boolean hasGraphsPerLine()
```
    Method hasGraphs_per_line.
    
    Returns:
    
    true if at least one Graphs_per_line has been added
  - hasId
```
public boolean hasId()
```
    Method hasId.
    
    Returns:
    
    true if at least one Id has been added
  - hasShowGraphtypeButton
```
public boolean hasShowGraphtypeButton()
```
    Method hasShow_graphtype_button.
    
    Returns:
    
    true if at least one Show_graphtype_button has been added
  - hasShowTimespanButton
```
public boolean hasShowTimespanButton()
```
    Method hasShow_timespan_button.
    
    Returns:
    
    true if at least one Show_timespan_button has been added
  - hashCode
```
public int hashCode()
```
    Method hashCode.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for the object.
  - isShowGraphtypeButton
```
public Boolean isShowGraphtypeButton()
```
    Returns the value of field 'show_graphtype_button'.
    
    Returns:
    
    the value of field 'Show_graphtype_button'.
  - isShowTimespanButton
```
public Boolean isShowTimespanButton()
```
    Returns the value of field 'show_timespan_button'.
    
    Returns:
    
    the value of field 'Show_timespan_button'.
  - iterateGraph
```
public Iterator<Graph> iterateGraph()
```
    Method iterateGraph.
    
    Returns:
    
    an Iterator over all possible elements in this collection
  - removeAllGraph
```
public void removeAllGraph()
```
  - removeGraph
```
public boolean removeGraph(Graph vGraph)
```
    Method removeGraph.
    
    Parameters:
    
    vGraph -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeGraphAt
```
public Graph removeGraphAt(int index)
```
    Method removeGraphAt.
    
    Parameters:
    
    index -
    
    Returns:
    
    the element removed from the collection
  - setGraph
```
public void setGraph(int index,
                     Graph vGraph)
              throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vGraph -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setGraph
```
public void setGraph(Graph[] vGraphArray)
```
    Parameters:
    
    vGraphArray -
  - setGraph
```
public void setGraph(List<Graph> vGraphList)
```
    Sets the value of 'graphList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vGraphList - the Vector to copy.
  - setGraphCollection
```
public void setGraphCollection(List<Graph> graphList)
```
    Deprecated.
    
    Sets the value of 'graphList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    
    graphList - the Vector to set.
  - setGraphsPerLine
```
public void setGraphsPerLine(Integer graphs_per_line)
```
    Sets the value of field 'graphs_per_line'.
    
    Parameters:
    
    graphs_per_line - the value of field 'graphs_per_line'.
  - setId
```
public void setId(Integer id)
```
    Sets the value of field 'id'.
    
    Parameters:
    
    id - the value of field 'id'.
  - setShowGraphtypeButton
```
public void setShowGraphtypeButton(Boolean show_graphtype_button)
```
    Sets the value of field 'show_graphtype_button'.
    
    Parameters:
    
    show_graphtype_button - the value of field 'show_graphtype_button'.
  - setShowTimespanButton
```
public void setShowTimespanButton(Boolean show_timespan_button)
```
    Sets the value of field 'show_timespan_button'.
    
    Parameters:
    
    show_timespan_button - the value of field 'show_timespan_button'.
  - setTitle
```
public void setTitle(String title)
```
    Sets the value of field 'title'.
    
    Parameters:
    
    title - the value of field 'title'.

Class Report

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Report

Method Detail

addGraph

addGraph

deleteGraphsPerLine

deleteId

deleteShowGraphtypeButton

deleteShowTimespanButton

enumerateGraph

equals

getGraph

getGraph

getGraphCollection

getGraphCount

getGraphsPerLine

getId

getShowGraphtypeButton

getShowTimespanButton

getTitle

hasGraphsPerLine

hasId

hasShowGraphtypeButton

hasShowTimespanButton

hashCode

isShowGraphtypeButton

isShowTimespanButton

iterateGraph

removeAllGraph

removeGraph

removeGraphAt

setGraph

setGraph

setGraph

setGraphCollection

setGraphsPerLine

setId

setShowGraphtypeButton

setShowTimespanButton

setTitle