PLC/Methods/GetPCUProtocolTypes.py

   1 from PLC.Faults import *
   2 from PLC.Method import Method
   3 from PLC.Parameter import Parameter, Mixed
   4 from PLC.PCUProtocolTypes import PCUProtocolType, PCUProtocolTypes
   5 from PLC.Auth import Auth
   6 from PLC.Filter import Filter
   7
   8 class GetPCUProtocolTypes(Method):
   9     """
  10     Returns an array of PCU Types.
  11     """
  12
  13     roles = ['admin', 'pi', 'user', 'tech', 'node']
  14
  15     accepts = [
  16         Auth(),
  17         Mixed([PCUProtocolType.fields['pcu_type_id']],
  18                Filter(PCUProtocolType.fields)),
  19         Parameter([str], "List of fields to return", nullok = True)
  20         ]
  21
  22     returns = [PCUProtocolType.fields]
  23
  24
  25     def call(self, auth, protocol_type_filter = None, return_fields = None):
  26
  27         #Must query at least pcu_type_id
  28         if return_fields is not None and 'pcu_protocol_type_id' not in return_fields:
  29             return_fields.append('pcu_protocol_type_id')
  30             added_fields = ['pcu_protocol_type_id']
  31         else:
  32             added_fields = []
  33
  34         protocol_types = PCUProtocolTypes(self.api, protocol_type_filter, return_fields)
  35
  36         for added_field in added_fields:
  37             for protocol_type in protocol_types:
  38                 del protocol_type[added_field]
  39
  40         return protocol_types