PLC/Methods/DeleteMessage.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 class DeleteMessage(Method):
  10     """
  11     Deletes a message template.
  12
  13     Returns 1 if successful, faults otherwise.
  14     """
  15
  16     roles = ['admin']
  17
  18     accepts = [
  19         Auth(),
  20         Message.fields['message_id'],
  21         ]
  22
  23     returns = Parameter(int, '1 if successful')
  24
  25
  26     def call(self, auth, message_id):
  27         # Get message information
  28         messages = Messages(self.api, [message_id])
  29         if not messages:
  30             raise PLCInvalidArgument, "No such message"
  31         message = messages[0]
  32
  33         message.delete()
  34         self.event_objects = {'Message': [message['message_id']]}
  35
  36         return 1