vigiboard / vigiboard / controllers / plugins / __init__.py @ e181e86c
History | View | Annotate | Download (1.68 KB)
1 |
# -*- coding: utf-8 -*-
|
---|---|
2 |
# vim:set expandtab tabstop=4 shiftwidth=4:
|
3 |
"""
|
4 |
Module complémentaire générique.
|
5 |
"""
|
6 |
|
7 |
from pylons.i18n import ugettext as _ |
8 |
|
9 |
class VigiboardRequestPlugin(object): |
10 |
"""
|
11 |
Classe que les plugins de VigiBoard doivent étendre.
|
12 |
"""
|
13 |
|
14 |
def __init__ (self, table = None, join = None, outerjoin = None, |
15 |
filters = None, groupby = None, orderby = None, name = '', |
16 |
style = None, object_name = ""): |
17 |
self.table = table
|
18 |
self.join = join
|
19 |
self.outerjoin = outerjoin
|
20 |
self.filter = filters
|
21 |
self.orderby = orderby
|
22 |
self.name = name
|
23 |
self.groupby = groupby
|
24 |
self.style = style
|
25 |
self.object_name = object_name
|
26 |
|
27 |
def get_value(self, idcorrevent, *args, **kwargs): |
28 |
"""
|
29 |
Cette méthode est appelée lorsque l'on demande la valeur du plugin
|
30 |
grâce à la méthode get_plugin_value du L{RootController} de VigiBoard.
|
31 |
|
32 |
Cette méthode DEVRAIT être surchargée dans les classes dérivées.
|
33 |
|
34 |
@param idcorrevent: Identifiant du C{CorrEvent} à interroger.
|
35 |
@type idcorrevent: C{int}
|
36 |
@return: Dictionnaire contenant la ou les valeur(s) correspondantes.
|
37 |
@rtype: C{dict}
|
38 |
"""
|
39 |
pass
|
40 |
|
41 |
def get_generated_columns_count(self): |
42 |
"""
|
43 |
Cette méthode renvoie le nombre de colonnes ajoutées dans le tableau
|
44 |
des événements par ce plugin. Par défaut, on suppose que chaque plugin
|
45 |
n'ajoute qu'une seule colonne au tableau.
|
46 |
|
47 |
Cette méthode PEUT être surchargée dans les classes dérivées.
|
48 |
|
49 |
@return: Nombre de colonnes ajoutées par ce plugin.
|
50 |
@rtype: C{int}
|
51 |
"""
|
52 |
return 1 |
53 |
|