PLC/Methods/DeleteInterfaceSettingType.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 class DeleteInterfaceSettingType(Method):
  13     """
  14     Deletes the specified interface setting type.
  15
  16     Returns 1 if successful, faults otherwise.
  17     """
  18
  19     roles = ['admin']
  20
  21     accepts = [
  22         Auth(),
  23         Mixed(InterfaceSettingType.fields['interface_setting_type_id'],
  24               InterfaceSettingType.fields['name']),
  25         ]
  26
  27     returns = Parameter(int, '1 if successful')
  28
  29
  30     def call(self, auth, interface_setting_type_id_or_name):
  31         interface_setting_types = InterfaceSettingTypes(self.api, [interface_setting_type_id_or_name])
  32         if not interface_setting_types:
  33             raise PLCInvalidArgument, "No such interface setting type"
  34         interface_setting_type = interface_setting_types[0]
  35
  36         interface_setting_type.delete()
  37         self.object_ids = [interface_setting_type['interface_setting_type_id']]
  38
  39         return 1