step2 : basic functions for handling nodetags and nodegroups - still highly volatile
[plcapi.git] / PLC / Methods / UpdateNodeTagType.py
1 #
2 # Thierry Parmentelat - INRIA
3 #
4 # $Revision: 9423 $
5 #
6 from PLC.Faults import *
7 from PLC.Method import Method
8 from PLC.Parameter import Parameter, Mixed
9 from PLC.NodeTagTypes import NodeTagType, NodeTagTypes
10 from PLC.Auth import Auth
11
12 can_update = lambda (field, value): field in \
13              ['name', 'description', 'category', 'min_role_id']
14
15 class UpdateNodeTagType(Method):
16     """
17     Updates the parameters of an existing tag type
18     with the values in node_tag_type_fields.
19
20     Returns 1 if successful, faults otherwise.
21     """
22
23     roles = ['admin']
24
25     node_tag_type_fields = dict(filter(can_update, NodeTagType.fields.items()))
26
27     accepts = [
28         Auth(),
29         Mixed(NodeTagType.fields['node_tag_type_id'],
30               NodeTagType.fields['name']),
31         node_tag_type_fields
32         ]
33
34     returns = Parameter(int, '1 if successful')
35
36     def call(self, auth, node_tag_type_id_or_name, node_tag_type_fields):
37         node_tag_type_fields = dict(filter(can_update, node_tag_type_fields.items()))
38
39         node_tag_types = NodeTagTypes(self.api, [node_tag_type_id_or_name])
40         if not node_tag_types:
41             raise PLCInvalidArgument, "No such tag type"
42         node_tag_type = node_tag_types[0]
43
44         node_tag_type.update(node_tag_type_fields)
45         node_tag_type.sync()
46         self.object_ids = [node_tag_type['node_tag_type_id']]
47
48         return 1