RegisterableTriggerRepository (Hyperic HQ Plugin API)
Keywords: org.hyperic.hq.events.ext.RegisterableTriggerRepository interface

Overview | Package | Class | Tree | Deprecated | Index | Help
| Hyperic HQ Plugin API v. 4.4.0.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.hyperic.hq.events.ext
Interface RegisterableTriggerRepository

All Known Implementing Classes:
  RegisteredTriggers

    public interface RegisterableTriggerRepository

Repository of in-memory representations of alert triggers

Method Summary
`void` | `addTrigger(RegisterableTriggerInterface trigger)`
`java.util.Collection` | `getInterestedTriggers(java.lang.Class eventClass, java.lang.Integer instanceId)`
`RegisterableTriggerInterface` | `getTriggerById(java.lang.Integer triggerId)`
`boolean` | `isInitialized()`
`void` | `removeTrigger(java.lang.Integer triggerId)`
`void` | `setTriggersEnabled(java.util.Collection triggerIds, boolean enabled)` Enables or disables triggers.

Method Detail

### addTrigger

    void addTrigger(RegisterableTriggerInterface trigger)

  Parameters:
    `trigger` - The trigger to add to the repository

### getInterestedTriggers

    java.util.Collection getInterestedTriggers(java.lang.Class eventClass,
                                               java.lang.Integer instanceId)

  Parameters:
    `eventClass` - The event class
    `instanceId` - The id of the source instance of the event
  Returns:
    The `RegisterableTriggerInterface`s interested in the event

### getTriggerById

    RegisterableTriggerInterface getTriggerById(java.lang.Integer triggerId)

  Parameters:
    `triggerId` - The trigger ID
  Returns:
    The `RegisterableTriggerInterface` with the specified ID or null if none exists

### isInitialized

    boolean isInitialized()

  Returns:
    true if the repository has been intialized. This typically occurs shortly after server startup, before the event is processed. Repository contents should be re-created from database.

### removeTrigger

    void removeTrigger(java.lang.Integer triggerId)

  Parameters:
    `triggerId` - The trigger to remove from the repository

### setTriggersEnabled

    void setTriggersEnabled(java.util.Collection triggerIds,
                            boolean enabled)

  Enables or disables triggers. Should be called when the alert definition is enabled or disabled. Disabled triggers will not be returned from calls to getInterestedTriggers, and therefore will not receive events from the RegisteredDispatcher

  Parameters:
    `triggerIds` - The triggers that should be enabled or disabled
    `enabled` - true if triggers should be enabled

Overview | Package | Class | Tree | Deprecated | Index | Help
| Hyperic HQ Plugin API v. 4.4.0.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2004-2006 Hyperic, Inc. support@hyperic.net, All Rights Reserved.