Notification (OpenNMS 18.0.3 API)

java.lang.Object
- org.opennms.netmgt.config.notifications.Notification

All Implemented Interfaces:

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

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Notification()

Constructors
Constructor and Description
`Notification()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addParameter(int index, Parameter vParameter)`
`void`	`addParameter(Parameter vParameter)`
`Enumeration<Parameter>`	`enumerateParameter()` Method enumerateParameter.
`boolean`	`equals(Object obj)` Overrides the java.lang.Object.equals method.
`String`	`getDescription()` Returns the value of field 'description'.
`String`	`getDestinationPath()` Returns the value of field 'destinationPath'.
`String`	`getEventSeverity()` Returns the value of field 'eventSeverity'.
`String`	`getName()` Returns the value of field 'name'.
`String`	`getNoticeQueue()` Returns the value of field 'noticeQueue'.
`String`	`getNumericMessage()` Returns the value of field 'numericMessage'.
`Parameter[]`	`getParameter()` Method getParameter.Returns the contents of the collection in an Array.
`Parameter`	`getParameter(int index)` Method getParameter.
`List<Parameter>`	`getParameterCollection()` Method getParameterCollection.Returns a reference to '_parameterList'.
`int`	`getParameterCount()` Method getParameterCount.
`String`	`getRule()` Returns the value of field 'rule'.
`String`	`getStatus()` Returns the value of field 'status'.
`String`	`getSubject()` Returns the value of field 'subject'.
`String`	`getTextMessage()` Returns the value of field 'textMessage'.
`String`	`getUei()` Returns the value of field 'uei'.
`Varbind`	`getVarbind()` Returns the value of field 'varbind'.
`String`	`getWriteable()` Returns the value of field 'writeable'.
`int`	`hashCode()` Overrides the java.lang.Object.hashCode method.
`boolean`	`isValid()` Method isValid.
`Iterator<Parameter>`	`iterateParameter()` Method iterateParameter.
`void`	`marshal(ContentHandler handler)`
`void`	`marshal(Writer out)`
`void`	`removeAllParameter()`
`boolean`	`removeParameter(Parameter vParameter)` Method removeParameter.
`Parameter`	`removeParameterAt(int index)` Method removeParameterAt.
`void`	`setDescription(String description)` Sets the value of field 'description'.
`void`	`setDestinationPath(String destinationPath)` Sets the value of field 'destinationPath'.
`void`	`setEventSeverity(String eventSeverity)` Sets the value of field 'eventSeverity'.
`void`	`setName(String name)` Sets the value of field 'name'.
`void`	`setNoticeQueue(String noticeQueue)` Sets the value of field 'noticeQueue'.
`void`	`setNumericMessage(String numericMessage)` Sets the value of field 'numericMessage'.
`void`	`setParameter(int index, Parameter vParameter)`
`void`	`setParameter(List<Parameter> vParameterList)` Sets the value of '_parameterList' by copying the given Vector.
`void`	`setParameter(Parameter[] vParameterArray)`
`void`	`setParameterCollection(List<Parameter> parameterList)` Deprecated.
`void`	`setRule(String rule)` Sets the value of field 'rule'.
`void`	`setStatus(String status)` Sets the value of field 'status'.
`void`	`setSubject(String subject)` Sets the value of field 'subject'.
`void`	`setTextMessage(String textMessage)` Sets the value of field 'textMessage'.
`void`	`setUei(String uei)` Sets the value of field 'uei'.
`void`	`setVarbind(Varbind varbind)` Sets the value of field 'varbind'.
`void`	`setWriteable(String writeable)` Sets the value of field 'writeable'.
`static Notification`	`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
  - Notification
```
public Notification()
```
- Method Detail
  - addParameter
```
public void addParameter(Parameter vParameter)
                  throws IndexOutOfBoundsException
```
    Parameters:
    
    vParameter -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addParameter
```
public void addParameter(int index,
                         Parameter vParameter)
                  throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vParameter -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - enumerateParameter
```
public Enumeration<Parameter> enumerateParameter()
```
    Method enumerateParameter.
    
    Returns:
    
    an Enumeration over all possible elements of this collection
  - 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'.
    
    Returns:
    
    the value of field 'Description'.
  - getDestinationPath
```
public String getDestinationPath()
```
    Returns the value of field 'destinationPath'.
    
    Returns:
    
    the value of field 'DestinationPath'.
  - getEventSeverity
```
public String getEventSeverity()
```
    Returns the value of field 'eventSeverity'.
    
    Returns:
    
    the value of field 'EventSeverity'.
  - getName
```
public String getName()
```
    Returns the value of field 'name'.
    
    Returns:
    
    the value of field 'Name'.
  - getNoticeQueue
```
public String getNoticeQueue()
```
    Returns the value of field 'noticeQueue'.
    
    Returns:
    
    the value of field 'NoticeQueue'.
  - getNumericMessage
```
public String getNumericMessage()
```
    Returns the value of field 'numericMessage'.
    
    Returns:
    
    the value of field 'NumericMessage'.
  - getParameter
```
public Parameter getParameter(int index)
                       throws IndexOutOfBoundsException
```
    Method getParameter.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the org.opennms.netmgt.config.notifications.Parameter at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getParameter
```
public Parameter[] getParameter()
```
    Method getParameter.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
  - getParameterCollection
```
public List<Parameter> getParameterCollection()
```
    Method getParameterCollection.Returns a reference to '_parameterList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getParameterCount
```
public int getParameterCount()
```
    Method getParameterCount.
    
    Returns:
    
    the size of this collection
  - getRule
```
public String getRule()
```
    Returns the value of field 'rule'.
    
    Returns:
    
    the value of field 'Rule'.
  - getStatus
```
public String getStatus()
```
    Returns the value of field 'status'.
    
    Returns:
    
    the value of field 'Status'.
  - getSubject
```
public String getSubject()
```
    Returns the value of field 'subject'.
    
    Returns:
    
    the value of field 'Subject'.
  - getTextMessage
```
public String getTextMessage()
```
    Returns the value of field 'textMessage'.
    
    Returns:
    
    the value of field 'TextMessage'.
  - getUei
```
public String getUei()
```
    Returns the value of field 'uei'.
    
    Returns:
    
    the value of field 'Uei'.
  - getVarbind
```
public Varbind getVarbind()
```
    Returns the value of field 'varbind'. The field 'varbind' has the following description: The varbind element
    
    Returns:
    
    the value of field 'Varbind'.
  - getWriteable
```
public String getWriteable()
```
    Returns the value of field 'writeable'.
    
    Returns:
    
    the value of field 'Writeable'.
  - 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.
  - isValid
```
public boolean isValid()
```
    Method isValid.
    
    Returns:
    
    true if this object is valid according to the schema
  - iterateParameter
```
public Iterator<Parameter> iterateParameter()
```
    Method iterateParameter.
    
    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
  - removeAllParameter
```
public void removeAllParameter()
```
  - removeParameter
```
public boolean removeParameter(Parameter vParameter)
```
    Method removeParameter.
    
    Parameters:
    
    vParameter -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeParameterAt
```
public Parameter removeParameterAt(int index)
```
    Method removeParameterAt.
    
    Parameters:
    
    index -
    
    Returns:
    
    the element removed from the collection
  - setDescription
```
public void setDescription(String description)
```
    Sets the value of field 'description'.
    
    Parameters:
    
    description - the value of field 'description'.
  - setDestinationPath
```
public void setDestinationPath(String destinationPath)
```
    Sets the value of field 'destinationPath'.
    
    Parameters:
    
    destinationPath - the value of field 'destinationPath'.
  - setEventSeverity
```
public void setEventSeverity(String eventSeverity)
```
    Sets the value of field 'eventSeverity'.
    
    Parameters:
    
    eventSeverity - the value of field 'eventSeverity'.
  - setName
```
public void setName(String name)
```
    Sets the value of field 'name'.
    
    Parameters:
    
    name - the value of field 'name'.
  - setNoticeQueue
```
public void setNoticeQueue(String noticeQueue)
```
    Sets the value of field 'noticeQueue'.
    
    Parameters:
    
    noticeQueue - the value of field 'noticeQueue'.
  - setNumericMessage
```
public void setNumericMessage(String numericMessage)
```
    Sets the value of field 'numericMessage'.
    
    Parameters:
    
    numericMessage - the value of field 'numericMessage'.
  - setParameter
```
public void setParameter(int index,
                         Parameter vParameter)
                  throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vParameter -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setParameter
```
public void setParameter(Parameter[] vParameterArray)
```
    Parameters:
    
    vParameterArray -
  - setParameter
```
public void setParameter(List<Parameter> vParameterList)
```
    Sets the value of '_parameterList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vParameterList - the Vector to copy.
  - setParameterCollection
```
public void setParameterCollection(List<Parameter> parameterList)
```
    Deprecated.
    
    Sets the value of '_parameterList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    
    parameterList - the Vector to set.
  - setRule
```
public void setRule(String rule)
```
    Sets the value of field 'rule'.
    
    Parameters:
    
    rule - the value of field 'rule'.
  - setStatus
```
public void setStatus(String status)
```
    Sets the value of field 'status'.
    
    Parameters:
    
    status - the value of field 'status'.
  - setSubject
```
public void setSubject(String subject)
```
    Sets the value of field 'subject'.
    
    Parameters:
    
    subject - the value of field 'subject'.
  - setTextMessage
```
public void setTextMessage(String textMessage)
```
    Sets the value of field 'textMessage'.
    
    Parameters:
    
    textMessage - the value of field 'textMessage'.
  - setUei
```
public void setUei(String uei)
```
    Sets the value of field 'uei'.
    
    Parameters:
    
    uei - the value of field 'uei'.
  - setVarbind
```
public void setVarbind(Varbind varbind)
```
    Sets the value of field 'varbind'. The field 'varbind' has the following description: The varbind element
    
    Parameters:
    
    varbind - the value of field 'varbind'.
  - setWriteable
```
public void setWriteable(String writeable)
```
    Sets the value of field 'writeable'.
    
    Parameters:
    
    writeable - the value of field 'writeable'.
  - unmarshal
```
public static Notification 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.notifications.Notification
    
    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 Notification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Notification

Method Detail

addParameter

addParameter

enumerateParameter

equals

getDescription

getDestinationPath

getEventSeverity

getName

getNoticeQueue

getNumericMessage

getParameter

getParameter

getParameterCollection

getParameterCount

getRule

getStatus

getSubject

getTextMessage

getUei

getVarbind

getWriteable

hashCode

isValid

iterateParameter

marshal

marshal

removeAllParameter

removeParameter

removeParameterAt

setDescription

setDestinationPath

setEventSeverity

setName

setNoticeQueue

setNumericMessage

setParameter

setParameter

setParameter

setParameterCollection

setRule

setStatus

setSubject

setTextMessage

setUei

setVarbind

setWriteable

unmarshal

validate