java.lang.Object
- org.netxms.client.events.Alarm

```
public class Alarm
extends Object
```
Alarm

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`HELPDESK_STATE_CLOSED`
`static int`	`HELPDESK_STATE_IGNORED`
`static int`	`HELPDESK_STATE_OPEN`
`static int`	`STATE_ACKNOWLEDGED`
`static int`	`STATE_MASK`
`static int`	`STATE_OUTSTANDING`
`static int`	`STATE_RESOLVED`
`static int`	`STATE_TERMINATED`

Constructor Summary

Constructors
Constructor Description

Alarm(org.netxms.base.NXCPMessage msg)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getAcknowledgedByUser()`	Get id of user that acknowledged this alarm (or 0 if alarm is not acknowledged).
`int`	`getAckTime()`	Get time when alarm was acknowledged
`long[]`	`getCategories()`	Get list of categories this alarm belongs to.
`int`	`getCommentsCount()`
`Date`	`getCreationTime()`
`Severity`	`getCurrentSeverity()`
`long`	`getDciId()`
`String`	`getHelpdeskReference()`
`int`	`getHelpdeskState()`
`long`	`getId()`
`String`	`getKey()`
`Date`	`getLastChangeTime()`
`String`	`getMessage()`
`Severity`	`getOriginalSeverity()`
`long`	`getParentId()`
`int`	`getRepeatCount()`
`int`	`getResolvedByUser()`	Get id of user that resolved this alarm (or 0 if alarm is not resolved).
`int`	`getSourceEventCode()`
`long`	`getSourceEventId()`
`long`	`getSourceObjectId()`
`int`	`getState()`
`long[]`	`getSubordinateAlarms()`	Get list of subordinate alarm identifiers.
`int`	`getTerminatedByUser()`	Get id of user that terminated this alarm (or 0 if alarm is not terminated).
`int`	`getTimeout()`
`int`	`getTimeoutEvent()`
`boolean`	`hasSubordinatedAlarms()`	Check if this alarm has any subordinated alarms.
`boolean`	`isSticky()`
`void`	`setResolved(int userId, Date changeTime)`	Mark alarm as resolved.
`String`	`toString()`

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

- Field Detail
  - STATE_OUTSTANDING
```
public static final int STATE_OUTSTANDING
```
    See Also:
    
    Constant Field Values
  - STATE_ACKNOWLEDGED
```
public static final int STATE_ACKNOWLEDGED
```
    See Also:
    
    Constant Field Values
  - STATE_RESOLVED
```
public static final int STATE_RESOLVED
```
    See Also:
    
    Constant Field Values
  - STATE_TERMINATED
```
public static final int STATE_TERMINATED
```
    See Also:
    
    Constant Field Values
  - STATE_MASK
```
public static final int STATE_MASK
```
    See Also:
    
    Constant Field Values
  - HELPDESK_STATE_IGNORED
```
public static final int HELPDESK_STATE_IGNORED
```
    See Also:
    
    Constant Field Values
  - HELPDESK_STATE_OPEN
```
public static final int HELPDESK_STATE_OPEN
```
    See Also:
    
    Constant Field Values
  - HELPDESK_STATE_CLOSED
```
public static final int HELPDESK_STATE_CLOSED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Alarm
```
public Alarm(org.netxms.base.NXCPMessage msg)
```
    Parameters:
    
    msg - Source NXCP message
- Method Detail
  - setResolved
```
public void setResolved(int userId,
                        Date changeTime)
```
    Mark alarm as resolved. This call only updates local object state and do not change actual alarm state on server. It can be used to update local alarm objects after receiving bulk alarm state change notification.
    
    Parameters:
    
    userId -
    
    changeTime -
  - getId
```
public long getId()
```
    Returns:
    
    the id
  - getParentId
```
public long getParentId()
```
    Returns:
    
    the parentId
  - getCurrentSeverity
```
public Severity getCurrentSeverity()
```
    Returns:
    
    the currentSeverity
  - getOriginalSeverity
```
public Severity getOriginalSeverity()
```
    Returns:
    
    the originalSeverity
  - getRepeatCount
```
public int getRepeatCount()
```
    Returns:
    
    the repeatCount
  - getState
```
public int getState()
```
    Returns:
    
    the state
  - getAcknowledgedByUser
```
public int getAcknowledgedByUser()
```
    Get id of user that acknowledged this alarm (or 0 if alarm is not acknowledged).
    
    Returns:
    
    id of user that acknowledged this alarm (or 0 if alarm is not acknowledged)
  - getTerminatedByUser
```
public int getTerminatedByUser()
```
    Get id of user that terminated this alarm (or 0 if alarm is not terminated).
    
    Returns:
    
    id of user that terminated this alarm (or 0 if alarm is not terminated)
  - getSourceEventId
```
public long getSourceEventId()
```
    Returns:
    
    the sourceEventId
  - getSourceEventCode
```
public int getSourceEventCode()
```
    Returns:
    
    the sourceEventCode
  - getSourceObjectId
```
public long getSourceObjectId()
```
    Returns:
    
    the sourceObjectId
  - getDciId
```
public long getDciId()
```
    Returns:
    
    the dciId
  - getCreationTime
```
public Date getCreationTime()
```
    Returns:
    
    the creationTime
  - getLastChangeTime
```
public Date getLastChangeTime()
```
    Returns:
    
    the lastChangeTime
  - getMessage
```
public String getMessage()
```
    Returns:
    
    the message
  - getKey
```
public String getKey()
```
    Returns:
    
    the key
  - getHelpdeskState
```
public int getHelpdeskState()
```
    Returns:
    
    the helpdeskState
  - getHelpdeskReference
```
public String getHelpdeskReference()
```
    Returns:
    
    the helpdeskReference
  - getTimeout
```
public int getTimeout()
```
    Returns:
    
    the timeout
  - getTimeoutEvent
```
public int getTimeoutEvent()
```
    Returns:
    
    the timeoutEvent
  - getCommentsCount
```
public int getCommentsCount()
```
    Returns:
    
    the commentsCount
  - getResolvedByUser
```
public int getResolvedByUser()
```
    Get id of user that resolved this alarm (or 0 if alarm is not resolved).
    
    Returns:
    
    id of user that resolved this alarm (or 0 if alarm is not resolved)
  - isSticky
```
public boolean isSticky()
```
    Returns:
    
    the sticky
  - getAckTime
```
public int getAckTime()
```
    Get time when alarm was acknowledged
    
    Returns:
    
    time when alarm was acknowledged
  - getCategories
```
public long[] getCategories()
```
    Get list of categories this alarm belongs to.
    
    Returns:
    
    list of categories this alarm belongs to
  - getSubordinateAlarms
```
public long[] getSubordinateAlarms()
```
    Get list of subordinate alarm identifiers.
    
    Returns:
    
    list of subordinate alarm identifiers
  - hasSubordinatedAlarms
```
public boolean hasSubordinatedAlarms()
```
    Check if this alarm has any subordinated alarms.
    
    Returns:
    
    true if this alarm has any subordinated alarms
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()

Class Alarm

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATE_OUTSTANDING

STATE_ACKNOWLEDGED

STATE_RESOLVED

STATE_TERMINATED

STATE_MASK

HELPDESK_STATE_IGNORED

HELPDESK_STATE_OPEN

HELPDESK_STATE_CLOSED

Constructor Detail

Alarm

Method Detail

setResolved

getId

getParentId

getCurrentSeverity

getOriginalSeverity

getRepeatCount

getState

getAcknowledgedByUser

getTerminatedByUser

getSourceEventId

getSourceEventCode

getSourceObjectId

getDciId

getCreationTime

getLastChangeTime

getMessage

getKey

getHelpdeskState

getHelpdeskReference

getTimeout

getTimeoutEvent

getCommentsCount

getResolvedByUser

isSticky

getAckTime

getCategories

getSubordinateAlarms

hasSubordinatedAlarms

toString