Event (OpenNMS 16.0.1 API)

java.lang.Object
- org.opennms.netmgt.xml.eventconf.Event

All Implemented Interfaces:: Serializable, Comparable<Event>

public class Event
extends Object
implements Serializable, Comparable<Event>

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

Event()

Constructors
Constructor and Description
`Event()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAutoaction(Autoaction autoaction)`
`void`	`addAutoaction(int index, Autoaction autoaction)`
`void`	`addForward(Forward forward)`
`void`	`addForward(int index, Forward forward)`
`void`	`addLoggroup(int index, String loggroup)`
`void`	`addLoggroup(String loggroup)`
`void`	`addOperaction(int index, Operaction operaction)`
`void`	`addOperaction(Operaction operaction)`
`void`	`addScript(int index, Script script)`
`void`	`addScript(Script script)`
`void`	`addVarbindsdecode(int index, Varbindsdecode varbindsdecode)`
`void`	`addVarbindsdecode(Varbindsdecode varbindsdecode)`
`int`	`compareTo(Event o)`
`Enumeration<Autoaction>`	`enumerateAutoaction()`
`Enumeration<Forward>`	`enumerateForward()`
`Enumeration<String>`	`enumerateLoggroup()`
`Enumeration<Operaction>`	`enumerateOperaction()`
`Enumeration<Script>`	`enumerateScript()`
`Enumeration<Varbindsdecode>`	`enumerateVarbindsdecode()`
`boolean`	`equals(Object obj)`
`AlarmData`	`getAlarmData()`
`Autoacknowledge`	`getAutoacknowledge()`
`Autoaction[]`	`getAutoaction()`
`Autoaction`	`getAutoaction(int index)`
`List<Autoaction>`	`getAutoactionCollection()`
`int`	`getAutoactionCount()`
`Correlation`	`getCorrelation()`
`String`	`getDescr()`
`String`	`getEventLabel()`
`Filters`	`getFilters()`
`Forward[]`	`getForward()`
`Forward`	`getForward(int index)`
`List<Forward>`	`getForwardCollection()`
`int`	`getForwardCount()`
`EventOrdering.EventOrderIndex`	`getIndex()`
`String[]`	`getLoggroup()`
`String`	`getLoggroup(int index)`
`List<String>`	`getLoggroupCollection()`
`int`	`getLoggroupCount()`
`Logmsg`	`getLogmsg()`
`Mask`	`getMask()`
`List<String>`	`getMaskElementValues(String mename)`
`String`	`getMouseovertext()`
`Operaction[]`	`getOperaction()`
`Operaction`	`getOperaction(int index)`
`List<Operaction>`	`getOperactionCollection()`
`int`	`getOperactionCount()`
`String`	`getOperinstruct()`
`Script[]`	`getScript()`
`Script`	`getScript(int index)`
`List<Script>`	`getScriptCollection()`
`int`	`getScriptCount()`
`String`	`getSeverity()`
`Snmp`	`getSnmp()`
`Tticket`	`getTticket()`
`String`	`getUei()`
`Varbindsdecode[]`	`getVarbindsdecode()`
`Varbindsdecode`	`getVarbindsdecode(int index)`
`List<Varbindsdecode>`	`getVarbindsdecodeCollection()`
`int`	`getVarbindsdecodeCount()`
`int`	`hashCode()`
`void`	`initialize(EventOrdering.EventOrderIndex eventOrderIndex)`
`boolean`	`isValid()`
`Iterator<Autoaction>`	`iterateAutoaction()`
`Iterator<Forward>`	`iterateForward()`
`Iterator<String>`	`iterateLoggroup()`
`Iterator<Operaction>`	`iterateOperaction()`
`Iterator<Script>`	`iterateScript()`
`Iterator<Varbindsdecode>`	`iterateVarbindsdecode()`
`void`	`marshal(ContentHandler handler)`
`void`	`marshal(Writer out)`
`boolean`	`matches(Event matchingEvent)`
`void`	`removeAllAutoaction()`
`void`	`removeAllForward()`
`void`	`removeAllLoggroup()`
`void`	`removeAllOperaction()`
`void`	`removeAllScript()`
`void`	`removeAllVarbindsdecode()`
`boolean`	`removeAutoaction(Autoaction autoaction)`
`Autoaction`	`removeAutoactionAt(int index)`
`boolean`	`removeForward(Forward forward)`
`Forward`	`removeForwardAt(int index)`
`boolean`	`removeLoggroup(String loggroup)`
`String`	`removeLoggroupAt(int index)`
`boolean`	`removeOperaction(Operaction operaction)`
`Operaction`	`removeOperactionAt(int index)`
`boolean`	`removeScript(Script script)`
`Script`	`removeScriptAt(int index)`
`boolean`	`removeVarbindsdecode(Varbindsdecode decode)`
`Varbindsdecode`	`removeVarbindsdecodeAt(int index)`
`void`	`setAlarmData(AlarmData alarmData)`
`void`	`setAutoacknowledge(Autoacknowledge autoacknowledge)`
`void`	`setAutoaction(Autoaction[] autoactions)`
`void`	`setAutoaction(int index, Autoaction autoaction)`
`void`	`setAutoaction(List<Autoaction> autoactions)`
`void`	`setAutoactionCollection(List<Autoaction> autoactions)`
`void`	`setCorrelation(Correlation correlation)`
`void`	`setDescr(String descr)`
`void`	`setEventLabel(String eventLabel)`
`void`	`setFilters(Filters filters)`
`void`	`setForward(Forward[] forwards)`
`void`	`setForward(int index, Forward forward)`
`void`	`setForward(List<Forward> forwards)`
`void`	`setForwardCollection(List<Forward> forwards)`
`void`	`setIndex(EventOrdering.EventOrderIndex index)`
`void`	`setLoggroup(int index, String loggroup)`
`void`	`setLoggroup(List<String> loggroups)`
`void`	`setLoggroup(String[] loggroups)`
`void`	`setLoggroupCollection(List<String> loggroups)`
`void`	`setLogmsg(Logmsg logmsg)`
`void`	`setMask(Mask mask)`
`void`	`setMouseovertext(String mouseovertext)`
`void`	`setOperaction(int index, Operaction operaction)`
`void`	`setOperaction(List<Operaction> operactions)`
`void`	`setOperaction(Operaction[] operactions)`
`void`	`setOperactionCollection(List<Operaction> operactions)`
`void`	`setOperinstruct(String operinstruct)`
`void`	`setScript(int index, Script script)`
`void`	`setScript(List<Script> scripts)`
`void`	`setScript(Script[] scripts)`
`void`	`setScriptCollection(List<Script> scripts)`
`void`	`setSeverity(String severity)`
`void`	`setSnmp(Snmp snmp)`
`void`	`setTticket(Tticket tticket)`
`void`	`setUei(String uei)`
`void`	`setVarbindsdecode(int index, Varbindsdecode decode)`
`void`	`setVarbindsdecode(List<Varbindsdecode> decodes)`
`void`	`setVarbindsdecode(Varbindsdecode[] decodes)`
`void`	`setVarbindsdecodeCollection(List<Varbindsdecode> decodes)`
`static Event`	`unmarshal(Reader reader)`
`void`	`validate()`

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

Constructor Detail
- Event
```
public Event()
```

Method Detail

getIndex

public EventOrdering.EventOrderIndex getIndex()

setIndex

public void setIndex(EventOrdering.EventOrderIndex index)

addAutoaction

public void addAutoaction(Autoaction autoaction)
                   throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

addAutoaction

public void addAutoaction(int index,
                          Autoaction autoaction)
                   throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

addForward

public void addForward(Forward forward)
                throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

addForward

public void addForward(int index,
                       Forward forward)
                throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

addLoggroup

public void addLoggroup(String loggroup)
                 throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

addLoggroup

public void addLoggroup(int index,
                        String loggroup)
                 throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

addOperaction

public void addOperaction(Operaction operaction)
                   throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

addOperaction

public void addOperaction(int index,
                          Operaction operaction)
                   throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

addScript

public void addScript(Script script)
               throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

addScript

public void addScript(int index,
                      Script script)
               throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

addVarbindsdecode

public void addVarbindsdecode(Varbindsdecode varbindsdecode)
                       throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

addVarbindsdecode

public void addVarbindsdecode(int index,
                              Varbindsdecode varbindsdecode)
                       throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

enumerateAutoaction

public Enumeration<Autoaction> enumerateAutoaction()

enumerateForward

public Enumeration<Forward> enumerateForward()

enumerateLoggroup

public Enumeration<String> enumerateLoggroup()

enumerateOperaction

public Enumeration<Operaction> enumerateOperaction()

enumerateScript

public Enumeration<Script> enumerateScript()

enumerateVarbindsdecode

public Enumeration<Varbindsdecode> enumerateVarbindsdecode()

getAlarmData
```
public AlarmData getAlarmData()
```

getAutoacknowledge

public Autoacknowledge getAutoacknowledge()

getAutoaction

public Autoaction getAutoaction(int index)
                         throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

getAutoaction
```
public Autoaction[] getAutoaction()
```

getAutoactionCollection

public List<Autoaction> getAutoactionCollection()

getAutoactionCount
```
public int getAutoactionCount()
```

getCorrelation
```
public Correlation getCorrelation()
```

getDescr
```
public String getDescr()
```

getEventLabel
```
public String getEventLabel()
```

getForward

public Forward getForward(int index)
                   throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

getFilters
```
public Filters getFilters()
```

getForward
```
public Forward[] getForward()
```

getForwardCollection

public List<Forward> getForwardCollection()

getForwardCount
```
public int getForwardCount()
```

getLoggroup

public String getLoggroup(int index)
                   throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

getLoggroup
```
public String[] getLoggroup()
```

getLoggroupCollection

public List<String> getLoggroupCollection()

getLoggroupCount
```
public int getLoggroupCount()
```

getLogmsg
```
public Logmsg getLogmsg()
```

getMask
```
public Mask getMask()
```

getMouseovertext
```
public String getMouseovertext()
```

getOperaction

public Operaction getOperaction(int index)
                         throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

getOperaction
```
public Operaction[] getOperaction()
```

getOperactionCollection

public List<Operaction> getOperactionCollection()

getOperactionCount
```
public int getOperactionCount()
```

getOperinstruct
```
public String getOperinstruct()
```

getScript

public Script getScript(int index)
                 throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

getScript
```
public Script[] getScript()
```

getScriptCollection

public List<Script> getScriptCollection()

getScriptCount
```
public int getScriptCount()
```

getSeverity
```
public String getSeverity()
```

getSnmp
```
public Snmp getSnmp()
```

getTticket
```
public Tticket getTticket()
```

getUei
```
public String getUei()
```

getVarbindsdecode

public Varbindsdecode getVarbindsdecode(int index)
                                 throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

getVarbindsdecode

public Varbindsdecode[] getVarbindsdecode()

getVarbindsdecodeCollection

public List<Varbindsdecode> getVarbindsdecodeCollection()

getVarbindsdecodeCount
```
public int getVarbindsdecodeCount()
```

isValid
```
public boolean isValid()
```
Returns:

true if this object is valid according to the schema

iterateAutoaction

public Iterator<Autoaction> iterateAutoaction()

iterateForward

public Iterator<Forward> iterateForward()

iterateLoggroup

public Iterator<String> iterateLoggroup()

iterateOperaction

public Iterator<Operaction> iterateOperaction()

iterateScript

public Iterator<Script> iterateScript()

iterateVarbindsdecode

public Iterator<Varbindsdecode> iterateVarbindsdecode()

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Throws:: org.exolab.castor.xml.MarshalException; org.exolab.castor.xml.ValidationException

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Throws:: IOException; org.exolab.castor.xml.MarshalException; org.exolab.castor.xml.ValidationException

removeAllAutoaction
```
public void removeAllAutoaction()
```

removeAllForward
```
public void removeAllForward()
```

removeAllLoggroup
```
public void removeAllLoggroup()
```

removeAllOperaction
```
public void removeAllOperaction()
```

removeAllScript
```
public void removeAllScript()
```

removeAllVarbindsdecode
```
public void removeAllVarbindsdecode()
```

removeAutoaction

public boolean removeAutoaction(Autoaction autoaction)

removeAutoactionAt

public Autoaction removeAutoactionAt(int index)

removeForward

public boolean removeForward(Forward forward)

removeForwardAt

public Forward removeForwardAt(int index)

removeLoggroup

public boolean removeLoggroup(String loggroup)

removeLoggroupAt

public String removeLoggroupAt(int index)

removeOperaction

public boolean removeOperaction(Operaction operaction)

removeOperactionAt

public Operaction removeOperactionAt(int index)

removeScript

public boolean removeScript(Script script)

removeScriptAt

public Script removeScriptAt(int index)

removeVarbindsdecode

public boolean removeVarbindsdecode(Varbindsdecode decode)

removeVarbindsdecodeAt

public Varbindsdecode removeVarbindsdecodeAt(int index)

setAlarmData

public void setAlarmData(AlarmData alarmData)

setAutoacknowledge

public void setAutoacknowledge(Autoacknowledge autoacknowledge)

setAutoaction

public void setAutoaction(int index,
                          Autoaction autoaction)
                   throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

setAutoaction

public void setAutoaction(Autoaction[] autoactions)

setAutoaction

public void setAutoaction(List<Autoaction> autoactions)

setAutoactionCollection

public void setAutoactionCollection(List<Autoaction> autoactions)

setCorrelation

public void setCorrelation(Correlation correlation)

setDescr
```
public void setDescr(String descr)
```

setEventLabel

public void setEventLabel(String eventLabel)

setFilters

public void setFilters(Filters filters)

setForward

public void setForward(int index,
                       Forward forward)
                throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

setForward

public void setForward(Forward[] forwards)

setForward

public void setForward(List<Forward> forwards)

setForwardCollection

public void setForwardCollection(List<Forward> forwards)

setLoggroup

public void setLoggroup(int index,
                        String loggroup)
                 throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

setLoggroup

public void setLoggroup(String[] loggroups)

setLoggroup

public void setLoggroup(List<String> loggroups)

setLoggroupCollection

public void setLoggroupCollection(List<String> loggroups)

setLogmsg
```
public void setLogmsg(Logmsg logmsg)
```

setMask
```
public void setMask(Mask mask)
```

setMouseovertext

public void setMouseovertext(String mouseovertext)

setOperaction

public void setOperaction(int index,
                          Operaction operaction)
                   throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

setOperaction

public void setOperaction(Operaction[] operactions)

setOperaction

public void setOperaction(List<Operaction> operactions)

setOperactionCollection

public void setOperactionCollection(List<Operaction> operactions)

setOperinstruct

public void setOperinstruct(String operinstruct)

setScript

public void setScript(int index,
                      Script script)
               throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

setScript

public void setScript(Script[] scripts)

setScript

public void setScript(List<Script> scripts)

setScriptCollection

public void setScriptCollection(List<Script> scripts)

setSeverity

public void setSeverity(String severity)

setSnmp
```
public void setSnmp(Snmp snmp)
```

setTticket

public void setTticket(Tticket tticket)

setUei
```
public void setUei(String uei)
```

setVarbindsdecode

public void setVarbindsdecode(int index,
                              Varbindsdecode decode)
                       throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

setVarbindsdecode

public void setVarbindsdecode(Varbindsdecode[] decodes)

setVarbindsdecode

public void setVarbindsdecode(List<Varbindsdecode> decodes)

setVarbindsdecodeCollection

public void setVarbindsdecodeCollection(List<Varbindsdecode> decodes)

unmarshal

public static Event unmarshal(Reader reader)
                       throws org.exolab.castor.xml.MarshalException,
                              org.exolab.castor.xml.ValidationException

Throws:: org.exolab.castor.xml.MarshalException; org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:: org.exolab.castor.xml.ValidationException

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

matches

public boolean matches(Event matchingEvent)

initialize

public void initialize(EventOrdering.EventOrderIndex eventOrderIndex)

getMaskElementValues

public List<String> getMaskElementValues(String mename)

compareTo
```
public int compareTo(Event o)
```
Specified by:

compareTo in interface Comparable<Event>

Class Event

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Event

Method Detail

getIndex

setIndex

addAutoaction

addAutoaction

addForward

addForward

addLoggroup

addLoggroup

addOperaction

addOperaction

addScript

addScript

addVarbindsdecode

addVarbindsdecode

enumerateAutoaction

enumerateForward

enumerateLoggroup

enumerateOperaction

enumerateScript

enumerateVarbindsdecode

getAlarmData

getAutoacknowledge

getAutoaction

getAutoaction

getAutoactionCollection

getAutoactionCount

getCorrelation

getDescr

getEventLabel

getForward

getFilters

getForward

getForwardCollection

getForwardCount

getLoggroup

getLoggroup

getLoggroupCollection

getLoggroupCount

getLogmsg

getMask

getMouseovertext

getOperaction

getOperaction

getOperactionCollection

getOperactionCount

getOperinstruct

getScript

getScript

getScriptCollection

getScriptCount

getSeverity

getSnmp

getTticket

getUei

getVarbindsdecode

getVarbindsdecode

getVarbindsdecodeCollection

getVarbindsdecodeCount

isValid

iterateAutoaction

iterateForward

iterateLoggroup

iterateOperaction

iterateScript

iterateVarbindsdecode

marshal

marshal

removeAllAutoaction

removeAllForward

removeAllLoggroup

removeAllOperaction

removeAllScript

removeAllVarbindsdecode