org.opennms.netmgt.xml.event
Class Event

java.lang.Object
  extended by org.opennms.netmgt.xml.event.Event
All Implemented Interfaces:
Serializable

public class Event
extends Object
implements Serializable

Class Event.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
Event()
           
 
Method Summary
 void addAutoaction(Autoaction vAutoaction)
           
 void addAutoaction(int index, Autoaction vAutoaction)
           
 void addForward(Forward vForward)
           
 void addForward(int index, Forward vForward)
           
 void addLoggroup(int index, String vLoggroup)
           
 void addLoggroup(String vLoggroup)
           
 void addOperaction(int index, Operaction vOperaction)
           
 void addOperaction(Operaction vOperaction)
           
 void addScript(int index, Script vScript)
           
 void addScript(Script vScript)
           
 void deleteDbid()
           
 void deleteNodeid()
           
 Enumeration<Autoaction> enumerateAutoaction()
          Method enumerateAutoaction.
 Enumeration<Forward> enumerateForward()
          Method enumerateForward.
 Enumeration<String> enumerateLoggroup()
          Method enumerateLoggroup.
 Enumeration<Operaction> enumerateOperaction()
          Method enumerateOperaction.
 Enumeration<Script> enumerateScript()
          Method enumerateScript.
 AlarmData getAlarmData()
          Returns the value of field 'alarmData'.
 Autoacknowledge getAutoacknowledge()
          Returns the value of field 'autoacknowledge'.
 Autoaction[] getAutoaction()
          Method getAutoaction.Returns the contents of the collection in an Array.
 Autoaction getAutoaction(int index)
          Method getAutoaction.
 List<Autoaction> getAutoactionCollection()
          Method getAutoactionCollection.Returns a reference to '_autoactionList'.
 int getAutoactionCount()
          Method getAutoactionCount.
 Correlation getCorrelation()
          Returns the value of field 'correlation'.
 String getCreationTime()
          Returns the value of field 'creationTime'.
 int getDbid()
          Returns the value of field 'dbid'.
 String getDescr()
          Returns the value of field 'descr'.
 String getDistPoller()
          Returns the value of field 'distPoller'.
 Forward[] getForward()
          Method getForward.Returns the contents of the collection in an Array.
 Forward getForward(int index)
          Method getForward.
 List<Forward> getForwardCollection()
          Method getForwardCollection.Returns a reference to '_forwardList'.
 int getForwardCount()
          Method getForwardCount.
 String getHost()
          Returns the value of field 'host'.
 String getIfAlias()
          Returns the value of field 'ifAlias'.
 String getIfIndex()
          Returns the value of field 'ifIndex'.
 String getInterface()
          Returns the value of field 'interface'.
 String[] getLoggroup()
          Method getLoggroup.Returns the contents of the collection in an Array.
 String getLoggroup(int index)
          Method getLoggroup.
 List<String> getLoggroupCollection()
          Method getLoggroupCollection.Returns a reference to '_loggroupList'.
 int getLoggroupCount()
          Method getLoggroupCount.
 Logmsg getLogmsg()
          Returns the value of field 'logmsg'.
 Mask getMask()
          Returns the value of field 'mask'.
 String getMasterStation()
          Returns the value of field 'masterStation'.
 String getMouseovertext()
          Returns the value of field 'mouseovertext'.
 long getNodeid()
          Returns the value of field 'nodeid'.
 Operaction[] getOperaction()
          Method getOperaction.Returns the contents of the collection in an Array.
 Operaction getOperaction(int index)
          Method getOperaction.
 List<Operaction> getOperactionCollection()
          Method getOperactionCollection.Returns a reference to '_operactionList'.
 int getOperactionCount()
          Method getOperactionCount.
 String getOperinstruct()
          Returns the value of field 'operinstruct'.
 Parms getParms()
          Returns the value of field 'parms'.
 String getPathoutage()
          Returns the value of field 'pathoutage'.
 Script[] getScript()
          Method getScript.Returns the contents of the collection in an Array.
 Script getScript(int index)
          Method getScript.
 List<Script> getScriptCollection()
          Method getScriptCollection.Returns a reference to '_scriptList'.
 int getScriptCount()
          Method getScriptCount.
 String getService()
          Returns the value of field 'service'.
 String getSeverity()
          Returns the value of field 'severity'.
 Snmp getSnmp()
          Returns the value of field 'snmp'.
 String getSnmphost()
          Returns the value of field 'snmphost'.
 String getSource()
          Returns the value of field 'source'.
 String getTime()
          Returns the value of field 'time'.
 Tticket getTticket()
          Returns the value of field 'tticket'.
 String getUei()
          Returns the value of field 'uei'.
 String getUuid()
          Returns the value of field 'uuid'.
 boolean hasDbid()
          Method hasDbid.
 boolean hasNodeid()
          Method hasNodeid.
 boolean isValid()
          Method isValid.
 Iterator<Autoaction> iterateAutoaction()
          Method iterateAutoaction.
 Iterator<Forward> iterateForward()
          Method iterateForward.
 Iterator<String> iterateLoggroup()
          Method iterateLoggroup.
 Iterator<Operaction> iterateOperaction()
          Method iterateOperaction.
 Iterator<Script> iterateScript()
          Method iterateScript.
 void marshal(ContentHandler handler)
           
 void marshal(Writer out)
           
 void removeAllAutoaction()
           
 void removeAllForward()
           
 void removeAllLoggroup()
           
 void removeAllOperaction()
           
 void removeAllScript()
           
 boolean removeAutoaction(Autoaction vAutoaction)
          Method removeAutoaction.
 Autoaction removeAutoactionAt(int index)
          Method removeAutoactionAt.
 boolean removeForward(Forward vForward)
          Method removeForward.
 Forward removeForwardAt(int index)
          Method removeForwardAt.
 boolean removeLoggroup(String vLoggroup)
          Method removeLoggroup.
 String removeLoggroupAt(int index)
          Method removeLoggroupAt.
 boolean removeOperaction(Operaction vOperaction)
          Method removeOperaction.
 Operaction removeOperactionAt(int index)
          Method removeOperactionAt.
 boolean removeScript(Script vScript)
          Method removeScript.
 Script removeScriptAt(int index)
          Method removeScriptAt.
 void setAlarmData(AlarmData alarmData)
          Sets the value of field 'alarmData'.
 void setAutoacknowledge(Autoacknowledge autoacknowledge)
          Sets the value of field 'autoacknowledge'.
 void setAutoaction(Autoaction[] vAutoactionArray)
           
 void setAutoaction(int index, Autoaction vAutoaction)
           
 void setAutoaction(List<Autoaction> vAutoactionList)
          Sets the value of '_autoactionList' by copying the given Vector.
 void setAutoactionCollection(List<Autoaction> autoactionList)
          Deprecated.  
 void setCorrelation(Correlation correlation)
          Sets the value of field 'correlation'.
 void setCreationTime(String creationTime)
          Sets the value of field 'creationTime'.
 void setDbid(int dbid)
          Sets the value of field 'dbid'.
 void setDescr(String descr)
          Sets the value of field 'descr'.
 void setDistPoller(String distPoller)
          Sets the value of field 'distPoller'.
 void setForward(Forward[] vForwardArray)
           
 void setForward(int index, Forward vForward)
           
 void setForward(List<Forward> vForwardList)
          Sets the value of '_forwardList' by copying the given Vector.
 void setForwardCollection(List<Forward> forwardList)
          Deprecated.  
 void setHost(String host)
          Sets the value of field 'host'.
 void setIfAlias(String ifAlias)
          Sets the value of field 'ifAlias'.
 void setIfIndex(String ifIndex)
          Sets the value of field 'ifIndex'.
 void setInterface(String _interface)
          Sets the value of field 'interface'.
 void setLoggroup(int index, String vLoggroup)
           
 void setLoggroup(List<String> vLoggroupList)
          Sets the value of '_loggroupList' by copying the given Vector.
 void setLoggroup(String[] vLoggroupArray)
           
 void setLoggroupCollection(List<String> loggroupList)
          Deprecated.  
 void setLogmsg(Logmsg logmsg)
          Sets the value of field 'logmsg'.
 void setMask(Mask mask)
          Sets the value of field 'mask'.
 void setMasterStation(String masterStation)
          Sets the value of field 'masterStation'.
 void setMouseovertext(String mouseovertext)
          Sets the value of field 'mouseovertext'.
 void setNodeid(long nodeid)
          Sets the value of field 'nodeid'.
 void setOperaction(int index, Operaction vOperaction)
           
 void setOperaction(List<Operaction> vOperactionList)
          Sets the value of '_operactionList' by copying the given Vector.
 void setOperaction(Operaction[] vOperactionArray)
           
 void setOperactionCollection(List<Operaction> operactionList)
          Deprecated.  
 void setOperinstruct(String operinstruct)
          Sets the value of field 'operinstruct'.
 void setParms(Parms parms)
          Sets the value of field 'parms'.
 void setPathoutage(String pathoutage)
          Sets the value of field 'pathoutage'.
 void setScript(int index, Script vScript)
           
 void setScript(List<Script> vScriptList)
          Sets the value of '_scriptList' by copying the given Vector.
 void setScript(Script[] vScriptArray)
           
 void setScriptCollection(List<Script> scriptList)
          Deprecated.  
 void setService(String service)
          Sets the value of field 'service'.
 void setSeverity(String severity)
          Sets the value of field 'severity'.
 void setSnmp(Snmp snmp)
          Sets the value of field 'snmp'.
 void setSnmphost(String snmphost)
          Sets the value of field 'snmphost'.
 void setSource(String source)
          Sets the value of field 'source'.
 void setTime(String time)
          Sets the value of field 'time'.
 void setTticket(Tticket tticket)
          Sets the value of field 'tticket'.
 void setUei(String uei)
          Sets the value of field 'uei'.
 void setUuid(String uuid)
          Sets the value of field 'uuid'.
static Event 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

Event

public Event()
Method Detail

addAutoaction

public void addAutoaction(Autoaction vAutoaction)
                   throws IndexOutOfBoundsException
Parameters:
vAutoaction -
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addAutoaction

public void addAutoaction(int index,
                          Autoaction vAutoaction)
                   throws IndexOutOfBoundsException
Parameters:
index -
vAutoaction -
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addForward

public void addForward(Forward vForward)
                throws IndexOutOfBoundsException
Parameters:
vForward -
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addForward

public void addForward(int index,
                       Forward vForward)
                throws IndexOutOfBoundsException
Parameters:
index -
vForward -
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addLoggroup

public void addLoggroup(String vLoggroup)
                 throws IndexOutOfBoundsException
Parameters:
vLoggroup -
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addLoggroup

public void addLoggroup(int index,
                        String vLoggroup)
                 throws IndexOutOfBoundsException
Parameters:
index -
vLoggroup -
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addOperaction

public void addOperaction(Operaction vOperaction)
                   throws IndexOutOfBoundsException
Parameters:
vOperaction -
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addOperaction

public void addOperaction(int index,
                          Operaction vOperaction)
                   throws IndexOutOfBoundsException
Parameters:
index -
vOperaction -
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addScript

public void addScript(Script vScript)
               throws IndexOutOfBoundsException
Parameters:
vScript -
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addScript

public void addScript(int index,
                      Script vScript)
               throws IndexOutOfBoundsException
Parameters:
index -
vScript -
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

deleteDbid

public void deleteDbid()

deleteNodeid

public void deleteNodeid()

enumerateAutoaction

public Enumeration<Autoaction> enumerateAutoaction()
Method enumerateAutoaction.

Returns:
an Enumeration over all possible elements of this collection

enumerateForward

public Enumeration<Forward> enumerateForward()
Method enumerateForward.

Returns:
an Enumeration over all possible elements of this collection

enumerateLoggroup

public Enumeration<String> enumerateLoggroup()
Method enumerateLoggroup.

Returns:
an Enumeration over all possible elements of this collection

enumerateOperaction

public Enumeration<Operaction> enumerateOperaction()
Method enumerateOperaction.

Returns:
an Enumeration over all possible elements of this collection

enumerateScript

public Enumeration<Script> enumerateScript()
Method enumerateScript.

Returns:
an Enumeration over all possible elements of this collection

getAlarmData

public AlarmData getAlarmData()
Returns the value of field 'alarmData'. The field 'alarmData' has the following description: Data used to create an event.

Returns:
the value of field 'AlarmData'.

getAutoacknowledge

public Autoacknowledge getAutoacknowledge()
Returns the value of field 'autoacknowledge'. The field 'autoacknowledge' has the following description: The autoacknowledge information for the user

Returns:
the value of field 'Autoacknowledge'.

getAutoaction

public Autoaction getAutoaction(int index)
                         throws IndexOutOfBoundsException
Method getAutoaction.

Parameters:
index -
Returns:
the value of the org.opennms.netmgt.xml.event.Autoaction at the given index
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getAutoaction

public Autoaction[] getAutoaction()
Method getAutoaction.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

getAutoactionCollection

public List<Autoaction> getAutoactionCollection()
Method getAutoactionCollection.Returns a reference to '_autoactionList'. No type checking is performed on any modifications to the Vector.

Returns:
a reference to the Vector backing this class

getAutoactionCount

public int getAutoactionCount()
Method getAutoactionCount.

Returns:
the size of this collection

getCorrelation

public Correlation getCorrelation()
Returns the value of field 'correlation'. The field 'correlation' has the following description: The event correlation information

Returns:
the value of field 'Correlation'.

getCreationTime

public String getCreationTime()
Returns the value of field 'creationTime'. The field 'creationTime' has the following description: from header

Returns:
the value of field 'CreationTime'.

getDbid

public int getDbid()
Returns the value of field 'dbid'. The field 'dbid' has the following description: The event database id

Returns:
the value of field 'Dbid'.

getDescr

public String getDescr()
Returns the value of field 'descr'. The field 'descr' has the following description: The event description

Returns:
the value of field 'Descr'.

getDistPoller

public String getDistPoller()
Returns the value of field 'distPoller'.

Returns:
the value of field 'DistPoller'.

getForward

public Forward getForward(int index)
                   throws IndexOutOfBoundsException
Method getForward.

Parameters:
index -
Returns:
the value of the org.opennms.netmgt.xml.event.Forward at the given index
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getForward

public Forward[] getForward()
Method getForward.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

getForwardCollection

public List<Forward> getForwardCollection()
Method getForwardCollection.Returns a reference to '_forwardList'. No type checking is performed on any modifications to the Vector.

Returns:
a reference to the Vector backing this class

getForwardCount

public int getForwardCount()
Method getForwardCount.

Returns:
the size of this collection

getHost

public String getHost()
Returns the value of field 'host'. The field 'host' has the following description: The host at which the event is generated

Returns:
the value of field 'Host'.

getIfAlias

public String getIfAlias()
Returns the value of field 'ifAlias'. The field 'ifAlias' has the following description: The ifAlias to which this event is pertinent

Returns:
the value of field 'IfAlias'.

getIfIndex

public String getIfIndex()
Returns the value of field 'ifIndex'. The field 'ifIndex' has the following description: The ifIndex to which this event is pertinent

Returns:
the value of field 'IfIndex'.

getInterface

public String getInterface()
Returns the value of field 'interface'. The field 'interface' has the following description: The interface to which this event is pertinent

Returns:
the value of field 'Interface'.

getLoggroup

public String getLoggroup(int index)
                   throws IndexOutOfBoundsException
Method getLoggroup.

Parameters:
index -
Returns:
the value of the java.lang.String at the given index
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getLoggroup

public String[] getLoggroup()
Method getLoggroup.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

getLoggroupCollection

public List<String> getLoggroupCollection()
Method getLoggroupCollection.Returns a reference to '_loggroupList'. No type checking is performed on any modifications to the Vector.

Returns:
a reference to the Vector backing this class

getLoggroupCount

public int getLoggroupCount()
Method getLoggroupCount.

Returns:
the size of this collection

getLogmsg

public Logmsg getLogmsg()
Returns the value of field 'logmsg'. The field 'logmsg' has the following description: The event logmsg

Returns:
the value of field 'Logmsg'.

getMask

public Mask getMask()
Returns the value of field 'mask'. The field 'mask' has the following description: The event mask which helps to uniquely identify an event

Returns:
the value of field 'Mask'.

getMasterStation

public String getMasterStation()
Returns the value of field 'masterStation'. The field 'masterStation' has the following description: from header

Returns:
the value of field 'MasterStation'.

getMouseovertext

public String getMouseovertext()
Returns the value of field 'mouseovertext'. The field 'mouseovertext' has the following description: The text to be displayed on a 'mouseOver' event when this event is displayed in the event browser

Returns:
the value of field 'Mouseovertext'.

getNodeid

public long getNodeid()
Returns the value of field 'nodeid'. The field 'nodeid' has the following description: The nodeid to which this event pertains

Returns:
the value of field 'Nodeid'.

getOperaction

public Operaction getOperaction(int index)
                         throws IndexOutOfBoundsException
Method getOperaction.

Parameters:
index -
Returns:
the value of the org.opennms.netmgt.xml.event.Operaction at the given index
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getOperaction

public Operaction[] getOperaction()
Method getOperaction.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

getOperactionCollection

public List<Operaction> getOperactionCollection()
Method getOperactionCollection.Returns a reference to '_operactionList'. No type checking is performed on any modifications to the Vector.

Returns:
a reference to the Vector backing this class

getOperactionCount

public int getOperactionCount()
Method getOperactionCount.

Returns:
the size of this collection

getOperinstruct

public String getOperinstruct()
Returns the value of field 'operinstruct'. The field 'operinstruct' has the following description: The operator instruction for this event

Returns:
the value of field 'Operinstruct'.

getParms

public Parms getParms()
Returns the value of field 'parms'. The field 'parms' has the following description: The varbinds from the trap

Returns:
the value of field 'Parms'.

getPathoutage

public String getPathoutage()
Returns the value of field 'pathoutage'. The field 'pathoutage' has the following description: The path outage information

Returns:
the value of field 'Pathoutage'.

getScript

public Script getScript(int index)
                 throws IndexOutOfBoundsException
Method getScript.

Parameters:
index -
Returns:
the value of the org.opennms.netmgt.xml.event.Script at the given index
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getScript

public Script[] getScript()
Method getScript.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

getScriptCollection

public List<Script> getScriptCollection()
Method getScriptCollection.Returns a reference to '_scriptList'. No type checking is performed on any modifications to the Vector.

Returns:
a reference to the Vector backing this class

getScriptCount

public int getScriptCount()
Method getScriptCount.

Returns:
the size of this collection

getService

public String getService()
Returns the value of field 'service'. The field 'service' has the following description: The service to which this event is pertinent

Returns:
the value of field 'Service'.

getSeverity

public String getSeverity()
Returns the value of field 'severity'. The field 'severity' has the following description: The event severity

Returns:
the value of field 'Severity'.

getSnmp

public Snmp getSnmp()
Returns the value of field 'snmp'. The field 'snmp' has the following description: The snmp information from the trap

Returns:
the value of field 'Snmp'.

getSnmphost

public String getSnmphost()
Returns the value of field 'snmphost'. The field 'snmphost' has the following description: The snmp host of the trap

Returns:
the value of field 'Snmphost'.

getSource

public String getSource()
Returns the value of field 'source'.

Returns:
the value of field 'Source'.

getTime

public String getTime()
Returns the value of field 'time'. The field 'time' has the following description: The time at which this event was generated. The time is in the format generated by the java.text.DateFormat using the DateFormat.FULL style for the default locale. For example: "Monday, February 18, 2002 3:01:58 PM EST"

Returns:
the value of field 'Time'.

getTticket

public Tticket getTticket()
Returns the value of field 'tticket'. The field 'tticket' has the following description: The trouble ticket info

Returns:
the value of field 'Tticket'.

getUei

public String getUei()
Returns the value of field 'uei'. The field 'uei' has the following description: The Universal Event Identifier

Returns:
the value of field 'Uei'.

getUuid

public String getUuid()
Returns the value of field 'uuid'.

Returns:
the value of field 'Uuid'.

hasDbid

public boolean hasDbid()
Method hasDbid.

Returns:
true if at least one Dbid has been added

hasNodeid

public boolean hasNodeid()
Method hasNodeid.

Returns:
true if at least one Nodeid has been added

isValid

public boolean isValid()
Method isValid.

Returns:
true if this object is valid according to the schema

iterateAutoaction

public Iterator<Autoaction> iterateAutoaction()
Method iterateAutoaction.

Returns:
an Iterator over all possible elements in this collection

iterateForward

public Iterator<Forward> iterateForward()
Method iterateForward.

Returns:
an Iterator over all possible elements in this collection

iterateLoggroup

public Iterator<String> iterateLoggroup()
Method iterateLoggroup.

Returns:
an Iterator over all possible elements in this collection

iterateOperaction

public Iterator<Operaction> iterateOperaction()
Method iterateOperaction.

Returns:
an Iterator over all possible elements in this collection

iterateScript

public Iterator<Script> iterateScript()
Method iterateScript.

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

removeAllAutoaction

public void removeAllAutoaction()

removeAllForward

public void removeAllForward()

removeAllLoggroup

public void removeAllLoggroup()

removeAllOperaction

public void removeAllOperaction()

removeAllScript

public void removeAllScript()

removeAutoaction

public boolean removeAutoaction(Autoaction vAutoaction)
Method removeAutoaction.

Parameters:
vAutoaction -
Returns:
true if the object was removed from the collection.

removeAutoactionAt

public Autoaction removeAutoactionAt(int index)
Method removeAutoactionAt.

Parameters:
index -
Returns:
the element removed from the collection

removeForward

public boolean removeForward(Forward vForward)
Method removeForward.

Parameters:
vForward -
Returns:
true if the object was removed from the collection.

removeForwardAt

public Forward removeForwardAt(int index)
Method removeForwardAt.

Parameters:
index -
Returns:
the element removed from the collection

removeLoggroup

public boolean removeLoggroup(String vLoggroup)
Method removeLoggroup.

Parameters:
vLoggroup -
Returns:
true if the object was removed from the collection.

removeLoggroupAt

public String removeLoggroupAt(int index)
Method removeLoggroupAt.

Parameters:
index -
Returns:
the element removed from the collection

removeOperaction

public boolean removeOperaction(Operaction vOperaction)
Method removeOperaction.

Parameters:
vOperaction -
Returns:
true if the object was removed from the collection.

removeOperactionAt

public Operaction removeOperactionAt(int index)
Method removeOperactionAt.

Parameters:
index -
Returns:
the element removed from the collection

removeScript

public boolean removeScript(Script vScript)
Method removeScript.

Parameters:
vScript -
Returns:
true if the object was removed from the collection.

removeScriptAt

public Script removeScriptAt(int index)
Method removeScriptAt.

Parameters:
index -
Returns:
the element removed from the collection

setAlarmData

public void setAlarmData(AlarmData alarmData)
Sets the value of field 'alarmData'. The field 'alarmData' has the following description: Data used to create an event.

Parameters:
alarmData - the value of field 'alarmData'.

setAutoacknowledge

public void setAutoacknowledge(Autoacknowledge autoacknowledge)
Sets the value of field 'autoacknowledge'. The field 'autoacknowledge' has the following description: The autoacknowledge information for the user

Parameters:
autoacknowledge - the value of field 'autoacknowledge'.

setAutoaction

public void setAutoaction(int index,
                          Autoaction vAutoaction)
                   throws IndexOutOfBoundsException
Parameters:
index -
vAutoaction -
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setAutoaction

public void setAutoaction(Autoaction[] vAutoactionArray)
Parameters:
vAutoactionArray -

setAutoaction

public void setAutoaction(List<Autoaction> vAutoactionList)
Sets the value of '_autoactionList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vAutoactionList - the Vector to copy.

setAutoactionCollection

public void setAutoactionCollection(List<Autoaction> autoactionList)
Deprecated. 

Sets the value of '_autoactionList' by setting it to the given Vector. No type checking is performed.

Parameters:
autoactionList - the Vector to set.

setCorrelation

public void setCorrelation(Correlation correlation)
Sets the value of field 'correlation'. The field 'correlation' has the following description: The event correlation information

Parameters:
correlation - the value of field 'correlation'.

setCreationTime

public void setCreationTime(String creationTime)
Sets the value of field 'creationTime'. The field 'creationTime' has the following description: from header

Parameters:
creationTime - the value of field 'creationTime'.

setDbid

public void setDbid(int dbid)
Sets the value of field 'dbid'. The field 'dbid' has the following description: The event database id

Parameters:
dbid - the value of field 'dbid'.

setDescr

public void setDescr(String descr)
Sets the value of field 'descr'. The field 'descr' has the following description: The event description

Parameters:
descr - the value of field 'descr'.

setDistPoller

public void setDistPoller(String distPoller)
Sets the value of field 'distPoller'.

Parameters:
distPoller - the value of field 'distPoller'.

setForward

public void setForward(int index,
                       Forward vForward)
                throws IndexOutOfBoundsException
Parameters:
index -
vForward -
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setForward

public void setForward(Forward[] vForwardArray)
Parameters:
vForwardArray -

setForward

public void setForward(List<Forward> vForwardList)
Sets the value of '_forwardList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vForwardList - the Vector to copy.

setForwardCollection

public void setForwardCollection(List<Forward> forwardList)
Deprecated. 

Sets the value of '_forwardList' by setting it to the given Vector. No type checking is performed.

Parameters:
forwardList - the Vector to set.

setHost

public void setHost(String host)
Sets the value of field 'host'. The field 'host' has the following description: The host at which the event is generated

Parameters:
host - the value of field 'host'.

setIfAlias

public void setIfAlias(String ifAlias)
Sets the value of field 'ifAlias'. The field 'ifAlias' has the following description: The ifAlias to which this event is pertinent

Parameters:
ifAlias - the value of field 'ifAlias'.

setIfIndex

public void setIfIndex(String ifIndex)
Sets the value of field 'ifIndex'. The field 'ifIndex' has the following description: The ifIndex to which this event is pertinent

Parameters:
ifIndex - the value of field 'ifIndex'.

setInterface

public void setInterface(String _interface)
Sets the value of field 'interface'. The field 'interface' has the following description: The interface to which this event is pertinent

Parameters:
_interface -
interface - the value of field 'interface'.

setLoggroup

public void setLoggroup(int index,
                        String vLoggroup)
                 throws IndexOutOfBoundsException
Parameters:
index -
vLoggroup -
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setLoggroup

public void setLoggroup(String[] vLoggroupArray)
Parameters:
vLoggroupArray -

setLoggroup

public void setLoggroup(List<String> vLoggroupList)
Sets the value of '_loggroupList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vLoggroupList - the Vector to copy.

setLoggroupCollection

public void setLoggroupCollection(List<String> loggroupList)
Deprecated. 

Sets the value of '_loggroupList' by setting it to the given Vector. No type checking is performed.

Parameters:
loggroupList - the Vector to set.

setLogmsg

public void setLogmsg(Logmsg logmsg)
Sets the value of field 'logmsg'. The field 'logmsg' has the following description: The event logmsg

Parameters:
logmsg - the value of field 'logmsg'.

setMask

public void setMask(Mask mask)
Sets the value of field 'mask'. The field 'mask' has the following description: The event mask which helps to uniquely identify an event

Parameters:
mask - the value of field 'mask'.

setMasterStation

public void setMasterStation(String masterStation)
Sets the value of field 'masterStation'. The field 'masterStation' has the following description: from header

Parameters:
masterStation - the value of field 'masterStation'.

setMouseovertext

public void setMouseovertext(String mouseovertext)
Sets the value of field 'mouseovertext'. The field 'mouseovertext' has the following description: The text to be displayed on a 'mouseOver' event when this event is displayed in the event browser

Parameters:
mouseovertext - the value of field 'mouseovertext'.

setNodeid

public void setNodeid(long nodeid)
Sets the value of field 'nodeid'. The field 'nodeid' has the following description: The nodeid to which this event pertains

Parameters:
nodeid - the value of field 'nodeid'.

setOperaction

public void setOperaction(int index,
                          Operaction vOperaction)
                   throws IndexOutOfBoundsException
Parameters:
index -
vOperaction -
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setOperaction

public void setOperaction(Operaction[] vOperactionArray)
Parameters:
vOperactionArray -

setOperaction

public void setOperaction(List<Operaction> vOperactionList)
Sets the value of '_operactionList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vOperactionList - the Vector to copy.

setOperactionCollection

public void setOperactionCollection(List<Operaction> operactionList)
Deprecated. 

Sets the value of '_operactionList' by setting it to the given Vector. No type checking is performed.

Parameters:
operactionList - the Vector to set.

setOperinstruct

public void setOperinstruct(String operinstruct)
Sets the value of field 'operinstruct'. The field 'operinstruct' has the following description: The operator instruction for this event

Parameters:
operinstruct - the value of field 'operinstruct'.

setParms

public void setParms(Parms parms)
Sets the value of field 'parms'. The field 'parms' has the following description: The varbinds from the trap

Parameters:
parms - the value of field 'parms'.

setPathoutage

public void setPathoutage(String pathoutage)
Sets the value of field 'pathoutage'. The field 'pathoutage' has the following description: The path outage information

Parameters:
pathoutage - the value of field 'pathoutage'.

setScript

public void setScript(int index,
                      Script vScript)
               throws IndexOutOfBoundsException
Parameters:
index -
vScript -
Throws:
IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setScript

public void setScript(Script[] vScriptArray)
Parameters:
vScriptArray -

setScript

public void setScript(List<Script> vScriptList)
Sets the value of '_scriptList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vScriptList - the Vector to copy.

setScriptCollection

public void setScriptCollection(List<Script> scriptList)
Deprecated. 

Sets the value of '_scriptList' by setting it to the given Vector. No type checking is performed.

Parameters:
scriptList - the Vector to set.

setService

public void setService(String service)
Sets the value of field 'service'. The field 'service' has the following description: The service to which this event is pertinent

Parameters:
service - the value of field 'service'.

setSeverity

public void setSeverity(String severity)
Sets the value of field 'severity'. The field 'severity' has the following description: The event severity

Parameters:
severity - the value of field 'severity'.

setSnmp

public void setSnmp(Snmp snmp)
Sets the value of field 'snmp'. The field 'snmp' has the following description: The snmp information from the trap

Parameters:
snmp - the value of field 'snmp'.

setSnmphost

public void setSnmphost(String snmphost)
Sets the value of field 'snmphost'. The field 'snmphost' has the following description: The snmp host of the trap

Parameters:
snmphost - the value of field 'snmphost'.

setSource

public void setSource(String source)
Sets the value of field 'source'.

Parameters:
source - the value of field 'source'.

setTime

public void setTime(String time)
Sets the value of field 'time'. The field 'time' has the following description: The time at which this event was generated. The time is in the format generated by the java.text.DateFormat using the DateFormat.FULL style for the default locale. For example: "Monday, February 18, 2002 3:01:58 PM EST"

Parameters:
time - the value of field 'time'.

setTticket

public void setTticket(Tticket tticket)
Sets the value of field 'tticket'. The field 'tticket' has the following description: The trouble ticket info

Parameters:
tticket - the value of field 'tticket'.

setUei

public void setUei(String uei)
Sets the value of field 'uei'. The field 'uei' has the following description: The Universal Event Identifier

Parameters:
uei - the value of field 'uei'.

setUuid

public void setUuid(String uuid)
Sets the value of field 'uuid'.

Parameters:
uuid - the value of field 'uuid'.

unmarshal

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

Parameters:
reader -
Returns:
the unmarshaled org.opennms.netmgt.xml.event.Event
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


Copyright © 2009. All Rights Reserved.