PLC/Methods/AddTagType.py

   1 #
   2 # Thierry Parmentelat - INRIA
   3 #
   4 # $Revision: 9423 $
   5 #
   6
   7
   8 from PLC.Faults import *
   9 from PLC.Method import Method
  10 from PLC.Parameter import Parameter, Mixed
  11 from PLC.TagTypes import TagType, TagTypes
  12 from PLC.Auth import Auth
  13
  14 can_update = lambda (field, value): field in \
  15              ['tagname', 'description', 'category', 'min_role_id']
  16
  17 class AddTagType(Method):
  18     """
  19     Adds a new type of node tag.
  20     Any fields specified are used, otherwise defaults are used.
  21
  22     Returns the new node_tag_id (> 0) if successful,
  23     faults otherwise.
  24     """
  25
  26     roles = ['admin']
  27
  28     tag_type_fields = dict(filter(can_update, TagType.fields.items()))
  29
  30     accepts = [
  31         Auth(),
  32         tag_type_fields
  33         ]
  34
  35     returns = Parameter(int, 'New node_tag_id (> 0) if successful')
  36
  37
  38     def call(self, auth, tag_type_fields):
  39         tag_type_fields = dict(filter(can_update, tag_type_fields.items()))
  40         tag_type = TagType(self.api, tag_type_fields)
  41         tag_type.sync()
  42
  43         self.object_ids = [tag_type['tag_type_id']]
  44
  45         return tag_type['tag_type_id']