PLC/Methods/GetIlinks.py

   1 # $Id$
   2 #
   3 # Thierry Parmentelat - INRIA
   4 #
   5 # $Revision: 9423 $
   6 #
   7 from PLC.Faults import *
   8 from PLC.Method import Method
   9 from PLC.Parameter import Parameter, Mixed
  10 from PLC.Filter import Filter
  11 from PLC.Auth import Auth
  12
  13 from PLC.Ilinks import Ilink, Ilinks
  14 from PLC.Sites import Site, Sites
  15 from PLC.Nodes import Node, Nodes
  16
  17 class GetIlinks(Method):
  18     """
  19     Returns an array of structs containing details about
  20     nodes and related tags.
  21
  22     If ilink_filter is specified and is an array of
  23     ilink identifiers, only ilinks matching
  24     the filter will be returned. If return_fields is specified, only
  25     the specified details will be returned.
  26     """
  27
  28     roles = ['admin', 'pi', 'user', 'node']
  29
  30     accepts = [
  31         Auth(),
  32         Mixed([Ilink.fields['ilink_id']],
  33               Parameter(int,"ilink id"),
  34               Filter(Ilink.fields)),
  35         Parameter([str], "List of fields to return", nullok = True)
  36         ]
  37
  38     returns = [Ilink.fields]
  39
  40
  41     def call(self, auth, ilink_filter = None, return_fields = None):
  42
  43         ilinks = Ilinks(self.api, ilink_filter, return_fields)
  44
  45         return ilinks