PLC/Methods/UpdateInterfaceSettingType.py

   1 #
   2 # Thierry Parmentelat - INRIA
   3 #
   4 # $Revision$
   5 #
   6 from PLC.Faults import *
   7 from PLC.Method import Method
   8 from PLC.Parameter import Parameter, Mixed
   9 from PLC.InterfaceSettingTypes import InterfaceSettingType, InterfaceSettingTypes
  10 from PLC.Auth import Auth
  11
  12 can_update = lambda (field, value): field in \
  13              ['name', 'description', 'category', 'min_role_id']
  14
  15 class UpdateInterfaceSettingType(Method):
  16     """
  17     Updates the parameters of an existing setting type
  18     with the values in interface_setting_type_fields.
  19
  20     Returns 1 if successful, faults otherwise.
  21     """
  22
  23     roles = ['admin']
  24
  25     interface_setting_type_fields = dict(filter(can_update, InterfaceSettingType.fields.items()))
  26
  27     accepts = [
  28         Auth(),
  29         Mixed(InterfaceSettingType.fields['interface_setting_type_id'],
  30               InterfaceSettingType.fields['name']),
  31         interface_setting_type_fields
  32         ]
  33
  34     returns = Parameter(int, '1 if successful')
  35
  36     def call(self, auth, interface_setting_type_id_or_name, interface_setting_type_fields):
  37         interface_setting_type_fields = dict(filter(can_update, interface_setting_type_fields.items()))
  38
  39         interface_setting_types = InterfaceSettingTypes(self.api, [interface_setting_type_id_or_name])
  40         if not interface_setting_types:
  41             raise PLCInvalidArgument, "No such setting type"
  42         interface_setting_type = interface_setting_types[0]
  43
  44         interface_setting_type.update(interface_setting_type_fields)
  45         interface_setting_type.sync()
  46         self.object_ids = [interface_setting_type['interface_setting_type_id']]
  47
  48         return 1