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