InventoryElement2RP (OpenNMS 18.0.3 API)

java.lang.Object
- org.opennms.report.inventory.InventoryElement2RP

All Implemented Interfaces:

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

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

InventoryElement2RP()

Constructors
Constructor and Description
`InventoryElement2RP()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addInventoryMemoryRP(int index, InventoryMemoryRP vInventoryMemoryRP)`
`void`	`addInventoryMemoryRP(InventoryMemoryRP vInventoryMemoryRP)`
`void`	`addInventorySoftwareRP(int index, InventorySoftwareRP vInventorySoftwareRP)`
`void`	`addInventorySoftwareRP(InventorySoftwareRP vInventorySoftwareRP)`
`void`	`addTupleRP(int index, TupleRP vTupleRP)`
`void`	`addTupleRP(TupleRP vTupleRP)`
`Enumeration<InventoryMemoryRP>`	`enumerateInventoryMemoryRP()` Method enumerateInventoryMemoryRP.
`Enumeration<InventorySoftwareRP>`	`enumerateInventorySoftwareRP()` Method enumerateInventorySoftwareRP.
`Enumeration<TupleRP>`	`enumerateTupleRP()` Method enumerateTupleRP.
`InventoryMemoryRP[]`	`getInventoryMemoryRP()` Method getInventoryMemoryRP.Returns the contents of the collection in an Array.
`InventoryMemoryRP`	`getInventoryMemoryRP(int index)` Method getInventoryMemoryRP.
`List<InventoryMemoryRP>`	`getInventoryMemoryRPCollection()` Method getInventoryMemoryRPCollection.Returns a reference to '_inventoryMemoryRPList'.
`int`	`getInventoryMemoryRPCount()` Method getInventoryMemoryRPCount.
`InventorySoftwareRP[]`	`getInventorySoftwareRP()` Method getInventorySoftwareRP.Returns the contents of the collection in an Array.
`InventorySoftwareRP`	`getInventorySoftwareRP(int index)` Method getInventorySoftwareRP.
`List<InventorySoftwareRP>`	`getInventorySoftwareRPCollection()` Method getInventorySoftwareRPCollection.Returns a reference to '_inventorySoftwareRPList'.
`int`	`getInventorySoftwareRPCount()` Method getInventorySoftwareRPCount.
`String`	`getName()` Returns the value of field 'name'.
`TupleRP[]`	`getTupleRP()` Method getTupleRP.Returns the contents of the collection in an Array.
`TupleRP`	`getTupleRP(int index)` Method getTupleRP.
`List<TupleRP>`	`getTupleRPCollection()` Method getTupleRPCollection.Returns a reference to '_tupleRPList'.
`int`	`getTupleRPCount()` Method getTupleRPCount.
`boolean`	`isValid()` Method isValid.
`Iterator<InventoryMemoryRP>`	`iterateInventoryMemoryRP()` Method iterateInventoryMemoryRP.
`Iterator<InventorySoftwareRP>`	`iterateInventorySoftwareRP()` Method iterateInventorySoftwareRP.
`Iterator<TupleRP>`	`iterateTupleRP()` Method iterateTupleRP.
`void`	`marshal(ContentHandler handler)`
`void`	`marshal(Writer out)`
`void`	`removeAllInventoryMemoryRP()`
`void`	`removeAllInventorySoftwareRP()`
`void`	`removeAllTupleRP()`
`boolean`	`removeInventoryMemoryRP(InventoryMemoryRP vInventoryMemoryRP)` Method removeInventoryMemoryRP.
`InventoryMemoryRP`	`removeInventoryMemoryRPAt(int index)` Method removeInventoryMemoryRPAt.
`boolean`	`removeInventorySoftwareRP(InventorySoftwareRP vInventorySoftwareRP)` Method removeInventorySoftwareRP.
`InventorySoftwareRP`	`removeInventorySoftwareRPAt(int index)` Method removeInventorySoftwareRPAt.
`boolean`	`removeTupleRP(TupleRP vTupleRP)` Method removeTupleRP.
`TupleRP`	`removeTupleRPAt(int index)` Method removeTupleRPAt.
`void`	`setInventoryMemoryRP(int index, InventoryMemoryRP vInventoryMemoryRP)`
`void`	`setInventoryMemoryRP(InventoryMemoryRP[] vInventoryMemoryRPArray)`
`void`	`setInventoryMemoryRP(List<InventoryMemoryRP> vInventoryMemoryRPList)` Sets the value of '_inventoryMemoryRPList' by copying the given Vector.
`void`	`setInventoryMemoryRPCollection(List<InventoryMemoryRP> inventoryMemoryRPList)` Deprecated.
`void`	`setInventorySoftwareRP(int index, InventorySoftwareRP vInventorySoftwareRP)`
`void`	`setInventorySoftwareRP(InventorySoftwareRP[] vInventorySoftwareRPArray)`
`void`	`setInventorySoftwareRP(List<InventorySoftwareRP> vInventorySoftwareRPList)` Sets the value of '_inventorySoftwareRPList' by copying the given Vector.
`void`	`setInventorySoftwareRPCollection(List<InventorySoftwareRP> inventorySoftwareRPList)` Deprecated.
`void`	`setName(String name)` Sets the value of field 'name'.
`void`	`setTupleRP(int index, TupleRP vTupleRP)`
`void`	`setTupleRP(List<TupleRP> vTupleRPList)` Sets the value of '_tupleRPList' by copying the given Vector.
`void`	`setTupleRP(TupleRP[] vTupleRPArray)`
`void`	`setTupleRPCollection(List<TupleRP> tupleRPList)` Deprecated.
`static InventoryElement2RP`	`unmarshal(Reader reader)` Method unmarshal.
`void`	`validate()`

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

- Constructor Detail
  - InventoryElement2RP
```
public InventoryElement2RP()
```
- Method Detail
  - addInventoryMemoryRP
```
public void addInventoryMemoryRP(InventoryMemoryRP vInventoryMemoryRP)
                          throws IndexOutOfBoundsException
```
    Parameters:
    
    vInventoryMemoryRP -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addInventoryMemoryRP
```
public void addInventoryMemoryRP(int index,
                                 InventoryMemoryRP vInventoryMemoryRP)
                          throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vInventoryMemoryRP -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addInventorySoftwareRP
```
public void addInventorySoftwareRP(InventorySoftwareRP vInventorySoftwareRP)
                            throws IndexOutOfBoundsException
```
    Parameters:
    
    vInventorySoftwareRP -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addInventorySoftwareRP
```
public void addInventorySoftwareRP(int index,
                                   InventorySoftwareRP vInventorySoftwareRP)
                            throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vInventorySoftwareRP -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addTupleRP
```
public void addTupleRP(TupleRP vTupleRP)
                throws IndexOutOfBoundsException
```
    Parameters:
    
    vTupleRP -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addTupleRP
```
public void addTupleRP(int index,
                       TupleRP vTupleRP)
                throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vTupleRP -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - enumerateInventoryMemoryRP
```
public Enumeration<InventoryMemoryRP> enumerateInventoryMemoryRP()
```
    Method enumerateInventoryMemoryRP.
    
    Returns:
    
    an Enumeration over all possible elements of this collection
  - enumerateInventorySoftwareRP
```
public Enumeration<InventorySoftwareRP> enumerateInventorySoftwareRP()
```
    Method enumerateInventorySoftwareRP.
    
    Returns:
    
    an Enumeration over all possible elements of this collection
  - enumerateTupleRP
```
public Enumeration<TupleRP> enumerateTupleRP()
```
    Method enumerateTupleRP.
    
    Returns:
    
    an Enumeration over all possible elements of this collection
  - getInventoryMemoryRP
```
public InventoryMemoryRP getInventoryMemoryRP(int index)
                                       throws IndexOutOfBoundsException
```
    Method getInventoryMemoryRP.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the org.opennms.report.inventory.InventoryMemoryRP at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getInventoryMemoryRP
```
public InventoryMemoryRP[] getInventoryMemoryRP()
```
    Method getInventoryMemoryRP.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
  - getInventoryMemoryRPCollection
```
public List<InventoryMemoryRP> getInventoryMemoryRPCollection()
```
    Method getInventoryMemoryRPCollection.Returns a reference to '_inventoryMemoryRPList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getInventoryMemoryRPCount
```
public int getInventoryMemoryRPCount()
```
    Method getInventoryMemoryRPCount.
    
    Returns:
    
    the size of this collection
  - getInventorySoftwareRP
```
public InventorySoftwareRP getInventorySoftwareRP(int index)
                                           throws IndexOutOfBoundsException
```
    Method getInventorySoftwareRP.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the org.opennms.report.inventory.InventorySoftwareRP at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getInventorySoftwareRP
```
public InventorySoftwareRP[] getInventorySoftwareRP()
```
    Method getInventorySoftwareRP.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
  - getInventorySoftwareRPCollection
```
public List<InventorySoftwareRP> getInventorySoftwareRPCollection()
```
    Method getInventorySoftwareRPCollection.Returns a reference to '_inventorySoftwareRPList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getInventorySoftwareRPCount
```
public int getInventorySoftwareRPCount()
```
    Method getInventorySoftwareRPCount.
    
    Returns:
    
    the size of this collection
  - getName
```
public String getName()
```
    Returns the value of field 'name'.
    
    Returns:
    
    the value of field 'Name'.
  - getTupleRP
```
public TupleRP getTupleRP(int index)
                   throws IndexOutOfBoundsException
```
    Method getTupleRP.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the org.opennms.report.inventory.TupleRP at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getTupleRP
```
public TupleRP[] getTupleRP()
```
    Method getTupleRP.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
  - getTupleRPCollection
```
public List<TupleRP> getTupleRPCollection()
```
    Method getTupleRPCollection.Returns a reference to '_tupleRPList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getTupleRPCount
```
public int getTupleRPCount()
```
    Method getTupleRPCount.
    
    Returns:
    
    the size of this collection
  - isValid
```
public boolean isValid()
```
    Method isValid.
    
    Returns:
    
    true if this object is valid according to the schema
  - iterateInventoryMemoryRP
```
public Iterator<InventoryMemoryRP> iterateInventoryMemoryRP()
```
    Method iterateInventoryMemoryRP.
    
    Returns:
    
    an Iterator over all possible elements in this collection
  - iterateInventorySoftwareRP
```
public Iterator<InventorySoftwareRP> iterateInventorySoftwareRP()
```
    Method iterateInventorySoftwareRP.
    
    Returns:
    
    an Iterator over all possible elements in this collection
  - iterateTupleRP
```
public Iterator<TupleRP> iterateTupleRP()
```
    Method iterateTupleRP.
    
    Returns:
    
    an Iterator over all possible elements in this collection
  - 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
  - removeAllInventoryMemoryRP
```
public void removeAllInventoryMemoryRP()
```
  - removeAllInventorySoftwareRP
```
public void removeAllInventorySoftwareRP()
```
  - removeAllTupleRP
```
public void removeAllTupleRP()
```
  - removeInventoryMemoryRP
```
public boolean removeInventoryMemoryRP(InventoryMemoryRP vInventoryMemoryRP)
```
    Method removeInventoryMemoryRP.
    
    Parameters:
    
    vInventoryMemoryRP -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeInventoryMemoryRPAt
```
public InventoryMemoryRP removeInventoryMemoryRPAt(int index)
```
    Method removeInventoryMemoryRPAt.
    
    Parameters:
    
    index -
    
    Returns:
    
    the element removed from the collection
  - removeInventorySoftwareRP
```
public boolean removeInventorySoftwareRP(InventorySoftwareRP vInventorySoftwareRP)
```
    Method removeInventorySoftwareRP.
    
    Parameters:
    
    vInventorySoftwareRP -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeInventorySoftwareRPAt
```
public InventorySoftwareRP removeInventorySoftwareRPAt(int index)
```
    Method removeInventorySoftwareRPAt.
    
    Parameters:
    
    index -
    
    Returns:
    
    the element removed from the collection
  - removeTupleRP
```
public boolean removeTupleRP(TupleRP vTupleRP)
```
    Method removeTupleRP.
    
    Parameters:
    
    vTupleRP -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeTupleRPAt
```
public TupleRP removeTupleRPAt(int index)
```
    Method removeTupleRPAt.
    
    Parameters:
    
    index -
    
    Returns:
    
    the element removed from the collection
  - setInventoryMemoryRP
```
public void setInventoryMemoryRP(int index,
                                 InventoryMemoryRP vInventoryMemoryRP)
                          throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vInventoryMemoryRP -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setInventoryMemoryRP
```
public void setInventoryMemoryRP(InventoryMemoryRP[] vInventoryMemoryRPArray)
```
    Parameters:
    
    vInventoryMemoryRPArray -
  - setInventoryMemoryRP
```
public void setInventoryMemoryRP(List<InventoryMemoryRP> vInventoryMemoryRPList)
```
    Sets the value of '_inventoryMemoryRPList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vInventoryMemoryRPList - the Vector to copy.
  - setInventoryMemoryRPCollection
```
public void setInventoryMemoryRPCollection(List<InventoryMemoryRP> inventoryMemoryRPList)
```
    Deprecated.
    
    Sets the value of '_inventoryMemoryRPList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    
    inventoryMemoryRPList - the Vector to set.
  - setInventorySoftwareRP
```
public void setInventorySoftwareRP(int index,
                                   InventorySoftwareRP vInventorySoftwareRP)
                            throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vInventorySoftwareRP -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setInventorySoftwareRP
```
public void setInventorySoftwareRP(InventorySoftwareRP[] vInventorySoftwareRPArray)
```
    Parameters:
    
    vInventorySoftwareRPArray -
  - setInventorySoftwareRP
```
public void setInventorySoftwareRP(List<InventorySoftwareRP> vInventorySoftwareRPList)
```
    Sets the value of '_inventorySoftwareRPList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vInventorySoftwareRPList - the Vector to copy.
  - setInventorySoftwareRPCollection
```
public void setInventorySoftwareRPCollection(List<InventorySoftwareRP> inventorySoftwareRPList)
```
    Deprecated.
    
    Sets the value of '_inventorySoftwareRPList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    
    inventorySoftwareRPList - the Vector to set.
  - setName
```
public void setName(String name)
```
    Sets the value of field 'name'.
    
    Parameters:
    
    name - the value of field 'name'.
  - setTupleRP
```
public void setTupleRP(int index,
                       TupleRP vTupleRP)
                throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vTupleRP -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setTupleRP
```
public void setTupleRP(TupleRP[] vTupleRPArray)
```
    Parameters:
    
    vTupleRPArray -
  - setTupleRP
```
public void setTupleRP(List<TupleRP> vTupleRPList)
```
    Sets the value of '_tupleRPList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vTupleRPList - the Vector to copy.
  - setTupleRPCollection
```
public void setTupleRPCollection(List<TupleRP> tupleRPList)
```
    Deprecated.
    
    Sets the value of '_tupleRPList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    
    tupleRPList - the Vector to set.
  - unmarshal
```
public static InventoryElement2RP unmarshal(Reader reader)
                                     throws org.exolab.castor.xml.MarshalException,
                                            org.exolab.castor.xml.ValidationException
```
    Method unmarshal.
    
    Parameters:
    
    reader -
    
    Returns:
    
    the unmarshaled org.opennms.report.inventory.InventoryElement2RP
    
    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

Class InventoryElement2RP

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InventoryElement2RP

Method Detail

addInventoryMemoryRP

addInventoryMemoryRP

addInventorySoftwareRP

addInventorySoftwareRP

addTupleRP

addTupleRP

enumerateInventoryMemoryRP

enumerateInventorySoftwareRP

enumerateTupleRP

getInventoryMemoryRP

getInventoryMemoryRP

getInventoryMemoryRPCollection

getInventoryMemoryRPCount

getInventorySoftwareRP

getInventorySoftwareRP

getInventorySoftwareRPCollection

getInventorySoftwareRPCount

getName

getTupleRP

getTupleRP

getTupleRPCollection

getTupleRPCount

isValid

iterateInventoryMemoryRP

iterateInventorySoftwareRP

iterateTupleRP

marshal

marshal

removeAllInventoryMemoryRP

removeAllInventorySoftwareRP

removeAllTupleRP

removeInventoryMemoryRP

removeInventoryMemoryRPAt

removeInventorySoftwareRP

removeInventorySoftwareRPAt

removeTupleRP

removeTupleRPAt

setInventoryMemoryRP

setInventoryMemoryRP

setInventoryMemoryRP

setInventoryMemoryRPCollection

setInventorySoftwareRP

setInventorySoftwareRP

setInventorySoftwareRP

setInventorySoftwareRPCollection

setName

setTupleRP

setTupleRP

setTupleRP

setTupleRPCollection

unmarshal

validate