Setting tag plcapi-5.4-2
[plcapi.git] / PLC / SiteTags.py
1 #
2 # Thierry Parmentelat - INRIA
3 #
4 from PLC.Faults import *
5 from PLC.Parameter import Parameter
6 from PLC.Filter import Filter
7 from PLC.Table import Row, Table
8 from PLC.TagTypes import TagType, TagTypes
9 from PLC.Sites import Site
10
11 class SiteTag(Row):
12     """
13     Representation of a row in the site_tag.
14     To use, instantiate with a dict of values.
15     """
16
17     table_name = 'site_tag'
18     primary_key = 'site_tag_id'
19     fields = {
20         'site_tag_id': Parameter(int, "Site setting identifier"),
21         'site_id': Site.fields['site_id'],
22         'login_base': Site.fields['login_base'],
23         'tag_type_id': TagType.fields['tag_type_id'],
24         'tagname': TagType.fields['tagname'],
25         'description': TagType.fields['description'],
26         'category': TagType.fields['category'],
27         'value': Parameter(str, "Site setting value"),
28         ### relations
29
30         }
31
32 class SiteTags(Table):
33     """
34     Representation of row(s) from the site_tag table in the
35     database.
36     """
37
38     def __init__(self, api, site_tag_filter = None, columns = None):
39         Table.__init__(self, api, SiteTag, columns)
40
41         sql = "SELECT %s FROM view_site_tags WHERE True" % \
42               ", ".join(self.columns)
43
44         if site_tag_filter is not None:
45             if isinstance(site_tag_filter, (list, tuple, set, int, long)):
46                 site_tag_filter = Filter(SiteTag.fields, {'site_tag_id': site_tag_filter})
47             elif isinstance(site_tag_filter, dict):
48                 site_tag_filter = Filter(SiteTag.fields, site_tag_filter)
49             else:
50                 raise PLCInvalidArgument, "Wrong site setting filter %r"%site_tag_filter
51             sql += " AND (%s) %s" % site_tag_filter.sql(api)
52
53
54         self.selectall(sql)