PLC/Methods/DeleteAddressType.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.AddressTypes import AddressType, AddressTypes
   7 from PLC.Auth import Auth
   8
   9 class DeleteAddressType(Method):
  10     """
  11     Deletes an address type.
  12
  13     Returns 1 if successful, faults otherwise.
  14     """
  15
  16     roles = ['admin']
  17
  18     accepts = [
  19         Auth(),
  20         Mixed(AddressType.fields['address_type_id'],
  21               AddressType.fields['name'])
  22         ]
  23
  24     returns = Parameter(int, '1 if successful')
  25
  26
  27     def call(self, auth, address_type_id_or_name):
  28         address_types = AddressTypes(self.api, [address_type_id_or_name])
  29         if not address_types:
  30             raise PLCInvalidArgument, "No such address type"
  31         address_type = address_types[0]
  32         address_type.delete()
  33         self.event_objects = {'AddressType': [address_type['address_type_id']]}
  34
  35         return 1