PLC/Methods/UpdatePCUProtocolType.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.PCUProtocolTypes import PCUProtocolType, PCUProtocolTypes
   7 from PLC.Auth import Auth
   8
   9 can_update = lambda (field, value): field in \
  10              ['pcu_type_id', 'port', 'protocol', 'supported']
  11
  12 class UpdatePCUProtocolType(Method):
  13     """
  14     Updates a pcu protocol type. Only the fields specified in
  15     port_typee_fields are updated, all other fields are left untouched.
  16
  17     Returns 1 if successful, faults otherwise.
  18     """
  19
  20     roles = ['admin']
  21
  22     protocol_type_fields = dict(filter(can_update, PCUProtocolType.fields.items()))
  23
  24     accepts = [
  25         Auth(),
  26         PCUProtocolType.fields['pcu_protocol_type_id'],
  27         protocol_type_fields
  28         ]
  29
  30     returns = Parameter(int, '1 if successful')
  31
  32     def call(self, auth, protocol_type_id, protocol_type_fields):
  33         protocol_type_fields = dict(filter(can_update, protocol_type_fields.items()))
  34
  35         protocol_types = PCUProtocolTypes(self.api, [protocol_type_id])
  36         if not protocol_types:
  37             raise PLCInvalidArgument, "No such pcu protocol type"
  38
  39         protocol_type = protocol_types[0]
  40         protocol_type.update(protocol_type_fields)
  41         protocol_type.sync()
  42         self.event_objects = {'PCUProtocolType': [protocol_type['pcu_protocol_type_id']]}
  43         return 1