OnmsAlarm (OpenNMS 18.0.3 API)

java.lang.Object
- org.opennms.netmgt.model.OnmsAlarm

All Implemented Interfaces:

Serializable, Acknowledgeable
```
@Entity
public class OnmsAlarm
extends Object
implements Acknowledgeable, Serializable
```
OnmsAlarm class.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int PROBLEM_TYPE
Constant PROBLEM_TYPE=1

static int RESOLUTION_TYPE
Constant RESOLUTION_TYPE=2

Fields
Modifier and Type	Field and Description
`static int`	`PROBLEM_TYPE` Constant `PROBLEM_TYPE=1`
`static int`	`RESOLUTION_TYPE` Constant `RESOLUTION_TYPE=2`

Constructor Summary

Constructors
Constructor and Description
`OnmsAlarm()` default constructor
`OnmsAlarm(Integer alarmid, String eventuei, OnmsDistPoller distPoller, Integer counter, Integer severity, Date firsteventtime, OnmsEvent event)` minimal constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acknowledge(String user)` acknowledge
`void`	`clear(String ackUser)` clear
`void`	`escalate(String ackUser)` escalate
`Integer`	`getAckId()` getAckId
`Date`	`getAckTime()` getAckTime
`String`	`getAckUser()` getAckUser
`Date`	`getAlarmAckTime()` getAlarmAckTime
`String`	`getAlarmAckUser()` getAlarmAckUser
`Integer`	`getAlarmType()` getAlarmType
`String`	`getApplicationDN()` getApplicationDN
`String`	`getClearKey()` getClearKey
`Integer`	`getCounter()` getCounter
`String`	`getDescription()` getDescription
`Map<String,String>`	`getDetails()` getDetails
`OnmsDistPoller`	`getDistPoller()` getDistPoller
`List<OnmsEventParameter>`	`getEventParameters()`
`String`	`getEventParms()` getEventParms
`Date`	`getFirstAutomationTime()` getFirstAutomationTime
`Date`	`getFirstEventTime()` getFirstEventTime
`Integer`	`getId()` getId
`Integer`	`getIfIndex()` getIfIndex
`InetAddress`	`getIpAddr()` getIpAddr
`Date`	`getLastAutomationTime()` getLastAutomationTime
`OnmsEvent`	`getLastEvent()` getLastEvent
`Date`	`getLastEventTime()` getLastEventTime
`String`	`getLogMsg()` getLogMsg
`String`	`getManagedObjectInstance()` getManagedObjectInstance
`String`	`getManagedObjectType()` getManagedObjectType
`String`	`getMouseOverText()` getMouseOverText
`OnmsNode`	`getNode()` getNode
`Integer`	`getNodeId()`
`String`	`getNodeLabel()`
`String`	`getOperInstruct()` getOperInstruct
`String`	`getOssPrimaryKey()` getOssPrimaryKey
`String`	`getQosAlarmState()` getQosAlarmState
`String`	`getReductionKey()` getReductionKey
`OnmsReductionKeyMemo`	`getReductionKeyMemo()`
`OnmsServiceType`	`getServiceType()` getServiceType
`OnmsSeverity`	`getSeverity()` getSeverity
`Integer`	`getSeverityId()` getSeverityId
`String`	`getSeverityLabel()` getSeverityLabel
`OnmsMemo`	`getStickyMemo()`
`Date`	`getSuppressedTime()` getSuppressedTime
`Date`	`getSuppressedUntil()` getSuppressedUntil
`String`	`getSuppressedUser()` getSuppressedUser
`String`	`getTTicketId()` getTTicketId
`TroubleTicketState`	`getTTicketState()` getTTicketState
`AckType`	`getType()` getType
`String`	`getUei()` getUei
`String`	`getX733AlarmType()` getX733AlarmType
`int`	`getX733ProbableCause()` getX733ProbableCause
`boolean`	`isAcknowledged()`
`void`	`setAlarmAckTime(Date alarmacktime)` setAlarmAckTime
`void`	`setAlarmAckUser(String alarmackuser)` setAlarmAckUser
`void`	`setAlarmType(Integer alarmtype)` setAlarmType
`void`	`setApplicationDN(String applicationDN)` setApplicationDN
`void`	`setClearKey(String clearKey)` setClearKey
`void`	`setCounter(Integer counter)` setCounter
`void`	`setDescription(String description)` setDescription
`void`	`setDetails(Map<String,String> alarmDetails)` setDetails
`void`	`setDistPoller(OnmsDistPoller distPoller)` setDistPoller
`void`	`setEventParms(String eventparms)` setEventParms
`void`	`setFirstAutomationTime(Date firstAutomationTime)` setFirstAutomationTime
`void`	`setFirstEventTime(Date firsteventtime)` setFirstEventTime
`void`	`setId(Integer alarmid)` setId
`void`	`setIfIndex(Integer ifIndex)` setIfIndex
`void`	`setIpAddr(InetAddress ipaddr)` setIpAddr
`void`	`setLastAutomationTime(Date lastAutomationTime)` setLastAutomationTime
`void`	`setLastEvent(OnmsEvent event)` setLastEvent
`void`	`setLastEventTime(Date lastEventTime)` setLastEventTime
`void`	`setLogMsg(String logmsg)` setLogMsg
`void`	`setManagedObjectInstance(String managedObjectInstance)` setManagedObjectInstance
`void`	`setManagedObjectType(String managedObjectType)` setManagedObjectType
`void`	`setMouseOverText(String mouseovertext)` setMouseOverText
`void`	`setNode(OnmsNode node)` setNode
`void`	`setOperInstruct(String operinstruct)` setOperInstruct
`void`	`setOssPrimaryKey(String key)` setOssPrimaryKey
`void`	`setQosAlarmState(String alarmState)` setQosAlarmState
`void`	`setReductionKey(String reductionkey)` setReductionKey
`void`	`setReductionKeyMemo(OnmsReductionKeyMemo reductionKeyMemo)`
`void`	`setServiceType(OnmsServiceType service)` setServiceType
`void`	`setSeverity(OnmsSeverity severity)` setSeverity
`void`	`setSeverityId(Integer severity)` setSeverityId
`void`	`setSeverityLabel(String label)` setSeverityLabel
`void`	`setStickyMemo(OnmsMemo stickyMemo)`
`void`	`setSuppressedTime(Date suppressedtime)` setSuppressedTime
`void`	`setSuppressedUntil(Date suppresseduntil)` setSuppressedUntil
`void`	`setSuppressedUser(String suppresseduser)` setSuppressedUser
`void`	`setTTicketId(String tticketid)` setTTicketId
`void`	`setTTicketState(TroubleTicketState tticketstate)` setTTicketState
`void`	`setUei(String eventuei)` setUei
`void`	`setX733AlarmType(String alarmType)` setX733AlarmType
`void`	`setX733ProbableCause(int cause)` setX733ProbableCause
`String`	`toString()` toString
`void`	`unacknowledge(String ackUser)` unacknowledge

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

- Field Detail
  - PROBLEM_TYPE
```
public static final int PROBLEM_TYPE
```
    Constant PROBLEM_TYPE=1
    
    See Also:
    
    Constant Field Values
  - RESOLUTION_TYPE
```
public static final int RESOLUTION_TYPE
```
    Constant RESOLUTION_TYPE=2
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OnmsAlarm
```
public OnmsAlarm()
```
    default constructor
  - OnmsAlarm
```
public OnmsAlarm(Integer alarmid,
                 String eventuei,
                 OnmsDistPoller distPoller,
                 Integer counter,
                 Integer severity,
                 Date firsteventtime,
                 OnmsEvent event)
```
    minimal constructor
    
    Parameters:
    
    alarmid - a Integer object.
    
    eventuei - a String object.
    
    distPoller - a OnmsDistPoller object.
    
    counter - a Integer object.
    
    severity - a Integer object.
    
    firsteventtime - a Date object.
    
    event - a OnmsEvent object.
- Method Detail
  - getId
```
public Integer getId()
```
    getId
    
    Returns:
    
    a Integer object.
  - setId
```
public void setId(Integer alarmid)
```
    setId
    
    Parameters:
    
    alarmid - a Integer object.
  - getUei
```
public String getUei()
```
    getUei
    
    Returns:
    
    a String object.
  - setUei
```
public void setUei(String eventuei)
```
    setUei
    
    Parameters:
    
    eventuei - a String object.
  - getDistPoller
```
public OnmsDistPoller getDistPoller()
```
    getDistPoller
    
    Returns:
    
    a OnmsDistPoller object.
  - setDistPoller
```
public void setDistPoller(OnmsDistPoller distPoller)
```
    setDistPoller
    
    Parameters:
    
    distPoller - a OnmsDistPoller object.
  - getNode
```
public OnmsNode getNode()
```
    getNode
    
    Specified by:
    
    getNode in interface Acknowledgeable
    
    Returns:
    
    a OnmsNode object.
  - setNode
```
public void setNode(OnmsNode node)
```
    setNode
    
    Parameters:
    
    node - a OnmsNode object.
  - getNodeId
```
public Integer getNodeId()
```
  - getNodeLabel
```
public String getNodeLabel()
```
  - getIpAddr
```
public InetAddress getIpAddr()
```
    getIpAddr
    
    Returns:
    
    a String object.
  - setIpAddr
```
public void setIpAddr(InetAddress ipaddr)
```
    setIpAddr
    
    Parameters:
    
    ipaddr - a String object.
  - getServiceType
```
public OnmsServiceType getServiceType()
```
    getServiceType
    
    Returns:
    
    a OnmsServiceType object.
  - setServiceType
```
public void setServiceType(OnmsServiceType service)
```
    setServiceType
    
    Parameters:
    
    service - a OnmsServiceType object.
  - getReductionKey
```
public String getReductionKey()
```
    getReductionKey
    
    Returns:
    
    a String object.
  - setReductionKey
```
public void setReductionKey(String reductionkey)
```
    setReductionKey
    
    Parameters:
    
    reductionkey - a String object.
  - getAlarmType
```
public Integer getAlarmType()
```
    getAlarmType
    
    Returns:
    
    a Integer object.
  - setAlarmType
```
public void setAlarmType(Integer alarmtype)
```
    setAlarmType
    
    Parameters:
    
    alarmtype - a Integer object.
  - getCounter
```
public Integer getCounter()
```
    getCounter
    
    Returns:
    
    a Integer object.
  - setCounter
```
public void setCounter(Integer counter)
```
    setCounter
    
    Parameters:
    
    counter - a Integer object.
  - getSeverityLabel
```
public String getSeverityLabel()
```
    getSeverityLabel
    
    Returns:
    
    a String object.
  - setSeverityLabel
```
public void setSeverityLabel(String label)
```
    setSeverityLabel
    
    Parameters:
    
    label - a String object.
  - getSeverity
```
public OnmsSeverity getSeverity()
```
    getSeverity
    
    Returns:
    
    a OnmsSeverity object.
  - setSeverity
```
public void setSeverity(OnmsSeverity severity)
```
    setSeverity
    
    Parameters:
    
    severity - a OnmsSeverity object.
  - getSeverityId
```
public Integer getSeverityId()
```
    getSeverityId
    
    Returns:
    
    a Integer object.
  - setSeverityId
```
public void setSeverityId(Integer severity)
```
    setSeverityId
    
    Parameters:
    
    severity - a Integer object.
  - getFirstEventTime
```
public Date getFirstEventTime()
```
    getFirstEventTime
    
    Returns:
    
    a Date object.
  - setFirstEventTime
```
public void setFirstEventTime(Date firsteventtime)
```
    setFirstEventTime
    
    Parameters:
    
    firsteventtime - a Date object.
  - getDescription
```
public String getDescription()
```
    getDescription
    
    Returns:
    
    a String object.
  - setDescription
```
public void setDescription(String description)
```
    setDescription
    
    Parameters:
    
    description - a String object.
  - getLogMsg
```
public String getLogMsg()
```
    getLogMsg
    
    Returns:
    
    a String object.
  - setLogMsg
```
public void setLogMsg(String logmsg)
```
    setLogMsg
    
    Parameters:
    
    logmsg - a String object.
  - getOperInstruct
```
public String getOperInstruct()
```
    getOperInstruct
    
    Returns:
    
    a String object.
  - setOperInstruct
```
public void setOperInstruct(String operinstruct)
```
    setOperInstruct
    
    Parameters:
    
    operinstruct - a String object.
  - getTTicketId
```
public String getTTicketId()
```
    getTTicketId
    
    Returns:
    
    a String object.
  - setTTicketId
```
public void setTTicketId(String tticketid)
```
    setTTicketId
    
    Parameters:
    
    tticketid - a String object.
  - getTTicketState
```
public TroubleTicketState getTTicketState()
```
    getTTicketState
    
    Returns:
    
    a TroubleTicketState object.
  - setTTicketState
```
public void setTTicketState(TroubleTicketState tticketstate)
```
    setTTicketState
    
    Parameters:
    
    tticketstate - a TroubleTicketState object.
  - getMouseOverText
```
public String getMouseOverText()
```
    getMouseOverText
    
    Returns:
    
    a String object.
  - setMouseOverText
```
public void setMouseOverText(String mouseovertext)
```
    setMouseOverText
    
    Parameters:
    
    mouseovertext - a String object.
  - getSuppressedUntil
```
public Date getSuppressedUntil()
```
    getSuppressedUntil
    
    Returns:
    
    a Date object.
  - setSuppressedUntil
```
public void setSuppressedUntil(Date suppresseduntil)
```
    setSuppressedUntil
    
    Parameters:
    
    suppresseduntil - a Date object.
  - getSuppressedUser
```
public String getSuppressedUser()
```
    getSuppressedUser
    
    Returns:
    
    a String object.
  - setSuppressedUser
```
public void setSuppressedUser(String suppresseduser)
```
    setSuppressedUser
    
    Parameters:
    
    suppresseduser - a String object.
  - getSuppressedTime
```
public Date getSuppressedTime()
```
    getSuppressedTime
    
    Returns:
    
    a Date object.
  - setSuppressedTime
```
public void setSuppressedTime(Date suppressedtime)
```
    setSuppressedTime
    
    Parameters:
    
    suppressedtime - a Date object.
  - getAlarmAckUser
```
public String getAlarmAckUser()
```
    getAlarmAckUser
    
    Returns:
    
    a String object.
  - setAlarmAckUser
```
public void setAlarmAckUser(String alarmackuser)
```
    setAlarmAckUser
    
    Parameters:
    
    alarmackuser - a String object.
  - isAcknowledged
```
public boolean isAcknowledged()
```
  - getAlarmAckTime
```
public Date getAlarmAckTime()
```
    getAlarmAckTime
    
    Returns:
    
    a Date object.
  - setAlarmAckTime
```
public void setAlarmAckTime(Date alarmacktime)
```
    setAlarmAckTime
    
    Parameters:
    
    alarmacktime - a Date object.
  - getClearKey
```
public String getClearKey()
```
    getClearKey
    
    Returns:
    
    a String object.
  - setClearKey
```
public void setClearKey(String clearKey)
```
    setClearKey
    
    Parameters:
    
    clearKey - a String object.
  - getLastEvent
```
public OnmsEvent getLastEvent()
```
    getLastEvent
    
    Returns:
    
    a OnmsEvent object.
  - setLastEvent
```
public void setLastEvent(OnmsEvent event)
```
    setLastEvent
    
    Parameters:
    
    event - a OnmsEvent object.
  - getEventParms
```
public String getEventParms()
```
    getEventParms
    
    Returns:
    
    a String object.
  - getEventParameters
```
public List<OnmsEventParameter> getEventParameters()
```
  - setEventParms
```
public void setEventParms(String eventparms)
```
    setEventParms
    
    Parameters:
    
    eventparms - a String object.
  - toString
```
public String toString()
```
    toString
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a String object.
  - getLastEventTime
```
public Date getLastEventTime()
```
    getLastEventTime
    
    Returns:
    
    a Date object.
  - setLastEventTime
```
public void setLastEventTime(Date lastEventTime)
```
    setLastEventTime
    
    Parameters:
    
    lastEventTime - a Date object.
  - getApplicationDN
```
public String getApplicationDN()
```
    getApplicationDN
    
    Returns:
    
    a String object.
  - setApplicationDN
```
public void setApplicationDN(String applicationDN)
```
    setApplicationDN
    
    Parameters:
    
    applicationDN - a String object.
  - getManagedObjectInstance
```
public String getManagedObjectInstance()
```
    getManagedObjectInstance
    
    Returns:
    
    a String object.
  - setManagedObjectInstance
```
public void setManagedObjectInstance(String managedObjectInstance)
```
    setManagedObjectInstance
    
    Parameters:
    
    managedObjectInstance - a String object.
  - getManagedObjectType
```
public String getManagedObjectType()
```
    getManagedObjectType
    
    Returns:
    
    a String object.
  - setManagedObjectType
```
public void setManagedObjectType(String managedObjectType)
```
    setManagedObjectType
    
    Parameters:
    
    managedObjectType - a String object.
  - getOssPrimaryKey
```
public String getOssPrimaryKey()
```
    getOssPrimaryKey
    
    Returns:
    
    a String object.
  - setOssPrimaryKey
```
public void setOssPrimaryKey(String key)
```
    setOssPrimaryKey
    
    Parameters:
    
    key - a String object.
  - getX733AlarmType
```
public String getX733AlarmType()
```
    getX733AlarmType
    
    Returns:
    
    a String object.
  - setX733AlarmType
```
public void setX733AlarmType(String alarmType)
```
    setX733AlarmType
    
    Parameters:
    
    alarmType - a String object.
  - getX733ProbableCause
```
public int getX733ProbableCause()
```
    getX733ProbableCause
    
    Returns:
    
    a int.
  - setX733ProbableCause
```
public void setX733ProbableCause(int cause)
```
    setX733ProbableCause
    
    Parameters:
    
    cause - a int.
  - getQosAlarmState
```
public String getQosAlarmState()
```
    getQosAlarmState
    
    Returns:
    
    a String object.
  - setQosAlarmState
```
public void setQosAlarmState(String alarmState)
```
    setQosAlarmState
    
    Parameters:
    
    alarmState - a String object.
  - getFirstAutomationTime
```
public Date getFirstAutomationTime()
```
    getFirstAutomationTime
    
    Returns:
    
    a Date object.
  - setFirstAutomationTime
```
public void setFirstAutomationTime(Date firstAutomationTime)
```
    setFirstAutomationTime
    
    Parameters:
    
    firstAutomationTime - a Date object.
  - getLastAutomationTime
```
public Date getLastAutomationTime()
```
    getLastAutomationTime
    
    Returns:
    
    a Date object.
  - setLastAutomationTime
```
public void setLastAutomationTime(Date lastAutomationTime)
```
    setLastAutomationTime
    
    Parameters:
    
    lastAutomationTime - a Date object.
  - getDetails
```
public Map<String,String> getDetails()
```
    getDetails
    
    Returns:
    
    a Map object.
  - setDetails
```
public void setDetails(Map<String,String> alarmDetails)
```
    setDetails
    
    Parameters:
    
    alarmDetails - a Map object.
  - getIfIndex
```
public Integer getIfIndex()
```
    getIfIndex
    
    Returns:
    
    a Integer object.
  - setIfIndex
```
public void setIfIndex(Integer ifIndex)
```
    setIfIndex
    
    Parameters:
    
    ifIndex - a Integer object.
  - getReductionKeyMemo
```
public OnmsReductionKeyMemo getReductionKeyMemo()
```
  - setReductionKeyMemo
```
public void setReductionKeyMemo(OnmsReductionKeyMemo reductionKeyMemo)
```
  - getStickyMemo
```
public OnmsMemo getStickyMemo()
```
  - setStickyMemo
```
public void setStickyMemo(OnmsMemo stickyMemo)
```
  - acknowledge
```
public void acknowledge(String user)
```
    acknowledge
    
    Specified by:
    
    acknowledge in interface Acknowledgeable
    
    Parameters:
    
    user - a String object.
  - unacknowledge
```
public void unacknowledge(String ackUser)
```
    unacknowledge
    
    Specified by:
    
    unacknowledge in interface Acknowledgeable
    
    Parameters:
    
    ackUser - a String object.
  - clear
```
public void clear(String ackUser)
```
    clear
    
    Specified by:
    
    clear in interface Acknowledgeable
    
    Parameters:
    
    ackUser - a String object.
  - escalate
```
public void escalate(String ackUser)
```
    escalate
    
    Specified by:
    
    escalate in interface Acknowledgeable
    
    Parameters:
    
    ackUser - a String object.
  - getType
```
public AckType getType()
```
    getType
    
    Specified by:
    
    getType in interface Acknowledgeable
    
    Returns:
    
    a AckType object.
  - getAckId
```
public Integer getAckId()
```
    getAckId
    
    Specified by:
    
    getAckId in interface Acknowledgeable
    
    Returns:
    
    a Integer object.
  - getAckUser
```
public String getAckUser()
```
    getAckUser
    
    Specified by:
    
    getAckUser in interface Acknowledgeable
    
    Returns:
    
    a String object.
  - getAckTime
```
public Date getAckTime()
```
    getAckTime
    
    Specified by:
    
    getAckTime in interface Acknowledgeable
    
    Returns:
    
    a Date object.

Class OnmsAlarm

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROBLEM_TYPE

RESOLUTION_TYPE

Constructor Detail

OnmsAlarm

OnmsAlarm

Method Detail

getId

setId

getUei

setUei

getDistPoller

setDistPoller

getNode

setNode

getNodeId

getNodeLabel

getIpAddr

setIpAddr

getServiceType

setServiceType

getReductionKey

setReductionKey

getAlarmType

setAlarmType

getCounter

setCounter

getSeverityLabel

setSeverityLabel

getSeverity

setSeverity

getSeverityId

setSeverityId

getFirstEventTime

setFirstEventTime

getDescription

setDescription

getLogMsg

setLogMsg

getOperInstruct

setOperInstruct

getTTicketId

setTTicketId

getTTicketState

setTTicketState

getMouseOverText

setMouseOverText

getSuppressedUntil

setSuppressedUntil

getSuppressedUser

setSuppressedUser

getSuppressedTime

setSuppressedTime

getAlarmAckUser

setAlarmAckUser

isAcknowledged

getAlarmAckTime

setAlarmAckTime

getClearKey

setClearKey

getLastEvent

setLastEvent

getEventParms

getEventParameters

setEventParms

toString

getLastEventTime

setLastEventTime

getApplicationDN

setApplicationDN

getManagedObjectInstance

setManagedObjectInstance

getManagedObjectType

setManagedObjectType

getOssPrimaryKey