PLC/Methods/UpdateMessage.py

   1 # $Id$
   2 # $URL$
   3 from PLC.Faults import *
   4 from PLC.Method import Method
   5 from PLC.Parameter import Parameter, Mixed
   6 from PLC.Messages import Message, Messages
   7 from PLC.Auth import Auth
   8
   9 can_update = lambda (field, value): field in \
  10              ['template', 'enabled']
  11
  12 class UpdateMessage(Method):
  13     """
  14     Updates the parameters of an existing message template with the
  15     values in message_fields.
  16
  17     Returns 1 if successful, faults otherwise.
  18     """
  19
  20     roles = ['admin']
  21
  22     message_fields = dict(filter(can_update, Message.fields.items()))
  23
  24     accepts = [
  25         Auth(),
  26         Message.fields['message_id'],
  27         message_fields
  28         ]
  29
  30     returns = Parameter(int, '1 if successful')
  31
  32     def call(self, auth, message_id, message_fields):
  33         message_fields = dict(filter(can_update, message_fields.items()))
  34
  35         # Get message information
  36         messages = Messages(self.api, [message_id])
  37         if not messages:
  38             raise PLCInvalidArgument, "No such message"
  39         message = messages[0]
  40
  41         message.update(message_fields)
  42         message.sync()
  43         self.event_objects = {'Message': [message['message_id']]}
  44
  45         return 1