ActionInterface (Hyperic HQ Plugin API)
Keywords: org.hyperic.hq.events.ActionInterface 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
Interface ActionInterface

All Superinterfaces:
  ActionConfigInterface

All Known Implementing Classes:
  EmailAction, MetricAlertAction, NoOpAction, OpenNMSAction, SyslogAction

    public interface ActionInterface

extends ActionConfigInterface

Interface to be implemented by all Action classes

Method Summary
`java.lang.String` | `execute(AlertInterface alert, ActionExecutionInfo info)` Execute the action.
`void` | `setParentActionConfig(AppdefEntityID aeid, ConfigResponse config)` Inherit configuration from parent action

Methods inherited from interface org.hyperic.hq.events.ActionConfigInterface
`getConfigResponse, getConfigSchema, getImplementor, init, setImplementor`

Method Detail

### execute

    java.lang.String execute(AlertInterface alert,
                             ActionExecutionInfo info)
                             throws ActionExecuteException

  Execute the action.

  Returns:
    text which will be associated with the action execution logs. `AlertActionLog`
  Throws:
    `ActionExecuteException`

### setParentActionConfig

    void setParentActionConfig(AppdefEntityID aeid,
                               ConfigResponse config)
                               throws InvalidActionDataException

  Inherit configuration from parent action

  Throws:
    `InvalidActionDataException`

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.