EventProcessingPolicyRule (netxms-client 2.2.8 API)

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

```
public class EventProcessingPolicyRule
extends Object
```
This class represents single rule of event processing policy.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CREATE_TICKET`
`static int`	`DISABLED`
`static int`	`GENERATE_ALARM`
`static int`	`NEGATED_EVENTS`
`static int`	`NEGATED_SOURCE`
`static int`	`SEVERITY_ANY`
`static int`	`SEVERITY_CRITICAL`
`static int`	`SEVERITY_MAJOR`
`static int`	`SEVERITY_MINOR`
`static int`	`SEVERITY_NORMAL`
`static int`	`SEVERITY_WARNING`
`static int`	`STOP_PROCESSING`
`static int`	`TERMINATE_BY_REGEXP`

Constructor Summary

Constructors
Constructor and Description
`EventProcessingPolicyRule()` Create empty rule
`EventProcessingPolicyRule(EventProcessingPolicyRule src)` Copy constructor
`EventProcessingPolicyRule(NXCPMessage msg, int ruleNumber)` Create rule from NXCP message.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`fillMessage(NXCPMessage msg)` Fill NXCP message with rule's data
`List<ActionExecutionConfiguration>`	`getActions()`
`List<Long>`	`getAlarmCategories()`
`String`	`getAlarmKey()`
`String`	`getAlarmMessage()`
`Severity`	`getAlarmSeverity()`
`int`	`getAlarmTimeout()`
`long`	`getAlarmTimeoutEvent()`
`String`	`getComments()` Get rule's comments.
`List<Long>`	`getEvents()`
`int`	`getFlags()`
`UUID`	`getGuid()`
`List<String>`	`getPStorageDelete()`
`Map<String,String>`	`getPStorageSet()`
`int`	`getRuleNumber()` Get rule number
`String`	`getScript()`
`List<Long>`	`getSources()`
`List<String>`	`getTimerCancellations()`
`boolean`	`isDisabled()` Check rule's DISABLED flag
`boolean`	`isEventsInverted()` Check rule's NEGATED_EVENTS flag
`boolean`	`isSourceInverted()` Check rule's NEGATED_SOURCE flag
`void`	`removeAlarmCategory(Long categoryId)`
`void`	`setActions(List<ActionExecutionConfiguration> actions)`
`void`	`setAlarmCategories(List<Long> alarmCategoryIds)`
`void`	`setAlarmKey(String alarmKey)`
`void`	`setAlarmMessage(String alarmMessage)`
`void`	`setAlarmSeverity(Severity alarmSeverity)`
`void`	`setAlarmTimeout(int alarmTimeout)`
`void`	`setAlarmTimeoutEvent(long alarmTimeoutEvent)`
`void`	`setComments(String comments)` Set rule's comments.
`void`	`setEvents(List<Long> events)`
`void`	`setFlags(int flags)`
`void`	`setPStorageDelete(List<String> persistentStorageDelete)`
`void`	`setPStorageSet(Map<String,String> persistentStorageSet)`
`void`	`setRuleNumber(int ruleNumber)` Set rule number
`void`	`setScript(String script)`
`void`	`setSources(List<Long> sources)`
`void`	`setTimerCancellations(List<String> timerCancellations)`

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

- Field Detail
  - STOP_PROCESSING
```
public static final int STOP_PROCESSING
```
    See Also:
    
    Constant Field Values
  - NEGATED_SOURCE
```
public static final int NEGATED_SOURCE
```
    See Also:
    
    Constant Field Values
  - NEGATED_EVENTS
```
public static final int NEGATED_EVENTS
```
    See Also:
    
    Constant Field Values
  - GENERATE_ALARM
```
public static final int GENERATE_ALARM
```
    See Also:
    
    Constant Field Values
  - DISABLED
```
public static final int DISABLED
```
    See Also:
    
    Constant Field Values
  - TERMINATE_BY_REGEXP
```
public static final int TERMINATE_BY_REGEXP
```
    See Also:
    
    Constant Field Values
  - SEVERITY_NORMAL
```
public static final int SEVERITY_NORMAL
```
    See Also:
    
    Constant Field Values
  - SEVERITY_WARNING
```
public static final int SEVERITY_WARNING
```
    See Also:
    
    Constant Field Values
  - SEVERITY_MINOR
```
public static final int SEVERITY_MINOR
```
    See Also:
    
    Constant Field Values
  - SEVERITY_MAJOR
```
public static final int SEVERITY_MAJOR
```
    See Also:
    
    Constant Field Values
  - SEVERITY_CRITICAL
```
public static final int SEVERITY_CRITICAL
```
    See Also:
    
    Constant Field Values
  - CREATE_TICKET
```
public static final int CREATE_TICKET
```
    See Also:
    
    Constant Field Values
  - SEVERITY_ANY
```
public static final int SEVERITY_ANY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EventProcessingPolicyRule
```
public EventProcessingPolicyRule()
```
    Create empty rule
  - EventProcessingPolicyRule
```
public EventProcessingPolicyRule(EventProcessingPolicyRule src)
```
    Copy constructor
  - EventProcessingPolicyRule
```
public EventProcessingPolicyRule(NXCPMessage msg,
                                 int ruleNumber)
```
    Create rule from NXCP message.
    
    Parameters:
    
    msg - NXCP message
- Method Detail
  - fillMessage
```
public void fillMessage(NXCPMessage msg)
```
    Fill NXCP message with rule's data
    
    Parameters:
    
    msg - NXCP message
  - getComments
```
public String getComments()
```
    Get rule's comments.
    
    Returns:
    
    Rule's comments
  - setComments
```
public void setComments(String comments)
```
    Set rule's comments.
    
    Parameters:
    
    comments - New comments
  - getScript
```
public String getScript()
```
    Returns:
    
    the script
  - setScript
```
public void setScript(String script)
```
    Parameters:
    
    script - the script to set
  - getFlags
```
public int getFlags()
```
    Returns:
    
    the flags
  - setFlags
```
public void setFlags(int flags)
```
    Parameters:
    
    flags - the flags to set
  - getAlarmKey
```
public String getAlarmKey()
```
    Returns:
    
    the alarmKey
  - setAlarmKey
```
public void setAlarmKey(String alarmKey)
```
    Parameters:
    
    alarmKey - the alarmKey to set
  - getAlarmMessage
```
public String getAlarmMessage()
```
    Returns:
    
    the alarmMessage
  - setAlarmMessage
```
public void setAlarmMessage(String alarmMessage)
```
    Parameters:
    
    alarmMessage - the alarmMessage to set
  - getAlarmSeverity
```
public Severity getAlarmSeverity()
```
    Returns:
    
    the alarmSeverity
  - setAlarmSeverity
```
public void setAlarmSeverity(Severity alarmSeverity)
```
    Parameters:
    
    alarmSeverity - the alarmSeverity to set
  - getAlarmTimeout
```
public int getAlarmTimeout()
```
    Returns:
    
    the alarmTimeout
  - setAlarmTimeout
```
public void setAlarmTimeout(int alarmTimeout)
```
    Parameters:
    
    alarmTimeout - the alarmTimeout to set
  - getAlarmTimeoutEvent
```
public long getAlarmTimeoutEvent()
```
    Returns:
    
    the alarmTimeoutEvent
  - setAlarmTimeoutEvent
```
public void setAlarmTimeoutEvent(long alarmTimeoutEvent)
```
    Parameters:
    
    alarmTimeoutEvent - the alarmTimeoutEvent to set
  - getAlarmCategories
```
public List<Long> getAlarmCategories()
```
    Returns:
    
    alarmCategoryIds the alarm category ids
  - setAlarmCategories
```
public void setAlarmCategories(List<Long> alarmCategoryIds)
```
    Parameters:
    
    alarmCategoryIds - the alarm category ids to set
  - removeAlarmCategory
```
public void removeAlarmCategory(Long categoryId)
```
  - getSources
```
public List<Long> getSources()
```
    Returns:
    
    the sources
  - getEvents
```
public List<Long> getEvents()
```
    Returns:
    
    the events
  - getActions
```
public List<ActionExecutionConfiguration> getActions()
```
    Returns:
    
    the actions
  - getPStorageSet
```
public Map<String,String> getPStorageSet()
```
    Returns:
    
    the persistentStorageSet
  - getPStorageDelete
```
public List<String> getPStorageDelete()
```
    Returns:
    
    the persistentStorageDelete
  - setSources
```
public void setSources(List<Long> sources)
```
    Parameters:
    
    sources - the sources to set
  - setEvents
```
public void setEvents(List<Long> events)
```
    Parameters:
    
    events - the events to set
  - setActions
```
public void setActions(List<ActionExecutionConfiguration> actions)
```
    Parameters:
    
    actions - the actions to set
  - getTimerCancellations
```
public List<String> getTimerCancellations()
```
    Returns:
    
    the timerCancellations
  - setTimerCancellations
```
public void setTimerCancellations(List<String> timerCancellations)
```
    Parameters:
    
    timerCancellations - the timerCancellations to set
  - setPStorageSet
```
public void setPStorageSet(Map<String,String> persistentStorageSet)
```
    Parameters:
    
    persistentStorageSet - the persistentStorageSet to set
  - setPStorageDelete
```
public void setPStorageDelete(List<String> persistentStorageDelete)
```
    Parameters:
    
    persistentStorageDelete - the persistentStorageDelete to set
  - isDisabled
```
public boolean isDisabled()
```
    Check rule's DISABLED flag
    
    Returns:
    
    true if DISABLED flag set
  - isSourceInverted
```
public boolean isSourceInverted()
```
    Check rule's NEGATED_SOURCE flag
    
    Returns:
    
    true if NEGATED_SOURCE flag set
  - isEventsInverted
```
public boolean isEventsInverted()
```
    Check rule's NEGATED_EVENTS flag
    
    Returns:
    
    true if NEGATED_EVENTS flag set
  - getGuid
```
public UUID getGuid()
```
    Returns:
    
    the guid
  - getRuleNumber
```
public int getRuleNumber()
```
    Get rule number
    
    Returns:
    
    rule number
  - setRuleNumber
```
public void setRuleNumber(int ruleNumber)
```
    Set rule number
    
    Parameters:
    
    ruleNumber - to set

Class EventProcessingPolicyRule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STOP_PROCESSING

NEGATED_SOURCE

NEGATED_EVENTS

GENERATE_ALARM

DISABLED

TERMINATE_BY_REGEXP

SEVERITY_NORMAL

SEVERITY_WARNING

SEVERITY_MINOR

SEVERITY_MAJOR

SEVERITY_CRITICAL

CREATE_TICKET

SEVERITY_ANY

Constructor Detail

EventProcessingPolicyRule

EventProcessingPolicyRule

EventProcessingPolicyRule

Method Detail

fillMessage

getComments

setComments

getScript

setScript

getFlags

setFlags

getAlarmKey

setAlarmKey

getAlarmMessage

setAlarmMessage

getAlarmSeverity

setAlarmSeverity

getAlarmTimeout

setAlarmTimeout

getAlarmTimeoutEvent

setAlarmTimeoutEvent

getAlarmCategories

setAlarmCategories

removeAlarmCategory

getSources

getEvents

getActions

getPStorageSet

getPStorageDelete

setSources

setEvents

setActions

getTimerCancellations

setTimerCancellations

setPStorageSet

setPStorageDelete

isDisabled

isSourceInverted

isEventsInverted

getGuid

getRuleNumber

setRuleNumber