Package Products :: Package ZenModel :: Module interfaces :: Class IAction |
[hide private]
[frames] | no frames]

# Class IAction

source code

    zope.interface.Interface --+
                               |
                              IAction

Instance Methods | [hide private]
getDefaultData(dmd) Return a dictionary of the default data for the notification content | source code
configure(options) | source code
execute(notification, signal) | source code
getInfo(notification) Given a notification, adapt it to it's appropriate ActionContentInfo object. | source code
generateJavascriptContent(notification) Generate a block of JS that will be used to render this action's content tab in the UI. | source code
updateContent(content, **kwargs) Update the notification's content. | source code

Class Variables | [hide private]
| id = `Attribute("The unique identifier for this action.")`
| name = `Attribute("The human-friendly name of this action.")`
| actionContentInfo = `Attribute("The class that adapts a notific`...``

Method Details | [hide private]

### configure(options) | source code
Parameters: `options` (Dictionary.) - Options to configure the specified action.

### execute(notification, signal) | source code
Parameters: `notification` (NotificationSubscription) - The notification that should be sent. `signal` (zenoss.protocols.protobufs.zep_pb2.Signal) - The signal that caused this notification to be executed.

### getInfo(notification) | source code
Given a notification, adapt it to it's appropriate ActionContentInfo object. Parameters: `notificaiton` - The notification to adapt `notification` (NotificationSubscription)

### generateJavascriptContent(notification) | source code
Generate a block of JS that will be used to render this action's content tab in the UI. Parameters: `notification` (NotificationSubscription) - The notification providing the data.

### updateContent(content, **kwargs) | source code
Update the notification's content. Parameters: `content` (dict) - This is the NotificationSubscription.content container for this action's data. `kwargs` (dict) - key word arguments passed to the update method. Contains all update params.

Class Variable Details | [hide private]

  ### actionContentInfo Value:
      Attribute("The class that adapts a notification to an " "IInfo object
      for this class.")