vigiboard / vigiboard / controllers / plugins / __init__.py @ 8d647d93
History | View | Annotate | Download (3.66 KB)
1 |
# -*- coding: utf-8 -*-
|
---|---|
2 |
# vim:set expandtab tabstop=4 shiftwidth=4:
|
3 |
################################################################################
|
4 |
#
|
5 |
# Copyright (C) 2007-2015 CS-SI
|
6 |
#
|
7 |
# This program is free software; you can redistribute it and/or modify
|
8 |
# it under the terms of the GNU General Public License version 2 as
|
9 |
# published by the Free Software Foundation.
|
10 |
#
|
11 |
# This program is distributed in the hope that it will be useful,
|
12 |
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
13 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
14 |
# GNU General Public License for more details.
|
15 |
#
|
16 |
# You should have received a copy of the GNU General Public License
|
17 |
# along with this program; if not, write to the Free Software
|
18 |
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
19 |
################################################################################
|
20 |
|
21 |
"""
|
22 |
Module complémentaire générique.
|
23 |
"""
|
24 |
|
25 |
# État lorsque les plugins sont appelés avec les sous-requêtes.
|
26 |
INNER = 0
|
27 |
# État lorsque les plugins sont appelés lorsque "items" est défini.
|
28 |
ITEMS = 1
|
29 |
|
30 |
|
31 |
class VigiboardRequestPlugin(object): |
32 |
"""
|
33 |
Classe que les plugins de VigiBoard doivent étendre.
|
34 |
"""
|
35 |
|
36 |
def get_bulk_data(self, events_ids): |
37 |
"""
|
38 |
Cette méthode est appelée par le L{RootController} : elle
|
39 |
retourne toutes les données affichées par le plugin dans le
|
40 |
tableau des évènements de la page principale de VigiBoard.
|
41 |
|
42 |
Cette méthode DEVRAIT être surchargée dans les classes dérivées.
|
43 |
|
44 |
@param events_ids: Liste des identifiants des C{CorrEvent} affichés
|
45 |
sur la page.
|
46 |
@type events_ids: C{List} of C{int}
|
47 |
@return: Dictionnaire associant à chaque identifiant
|
48 |
d'évènement les données à afficher par le plugin.
|
49 |
@rtype: C{dict}
|
50 |
"""
|
51 |
pass
|
52 |
|
53 |
def get_json_data(self, idcorrevent, *args, **kwargs): |
54 |
"""
|
55 |
Cette méthode est appelée par le template du plugin via
|
56 |
la méthode get_plugin_json_data du L{RootController} de VigiBoard.
|
57 |
|
58 |
Cette méthode DEVRAIT être surchargée dans les classes dérivées
|
59 |
si le plugin en question doit avoir recours à une requête JSON.
|
60 |
|
61 |
@param idcorrevent: Identifiant du C{CorrEvent} à interroger.
|
62 |
@type idcorrevent: C{int}
|
63 |
@return: Dictionnaire contenant la ou les valeur(s) correspondantes.
|
64 |
@rtype: C{dict}
|
65 |
"""
|
66 |
pass
|
67 |
|
68 |
def get_generated_columns_count(self): |
69 |
"""
|
70 |
Cette méthode renvoie le nombre de colonnes ajoutées dans le tableau
|
71 |
des événements par ce plugin. Par défaut, on suppose que chaque plugin
|
72 |
n'ajoute qu'une seule colonne au tableau.
|
73 |
|
74 |
Cette méthode PEUT être surchargée dans les classes dérivées.
|
75 |
|
76 |
@return: Nombre de colonnes ajoutées par ce plugin.
|
77 |
@rtype: C{int}
|
78 |
"""
|
79 |
return 1 |
80 |
|
81 |
def get_data(self, event): |
82 |
return {}
|
83 |
|
84 |
def get_search_fields(self): |
85 |
return []
|
86 |
|
87 |
def get_sort_criterion(self, query, column): |
88 |
"""
|
89 |
Cette méthode renvoie le critère à utiliser par SQLAlchemy pour trier
|
90 |
la requête alimentant le tableau des événements.
|
91 |
|
92 |
Cette méthode DEVRAIT être surchargée dans les classes dérivées
|
93 |
si le plugin en question implémente un tri.
|
94 |
|
95 |
@param query: La requête VigiBoard servant à alimenter le tableau des
|
96 |
événements.
|
97 |
@type query: L{VigiboardRequest}
|
98 |
@param column: La colonne sur laquelle l'utilisateur souhaite opérer le
|
99 |
tri.
|
100 |
@type column: C{str}
|
101 |
"""
|
102 |
pass
|
103 |
|
104 |
def handle_search_fields(self, query, search, state, subqueries): |
105 |
pass
|