allow filters to be specified in most Get() calls
[plcapi.git] / PLC / Methods / GetConfFiles.py
index fe3cb79..d12365e 100644 (file)
@@ -1,24 +1,28 @@
 from PLC.Faults import *
 from PLC.Method import Method
 from PLC.Parameter import Parameter, Mixed
+from PLC.Filter import Filter
 from PLC.ConfFiles import ConfFile, ConfFiles
 from PLC.Auth import Auth
 
 class GetConfFiles(Method):
     """
-    Returns an array of structs containing details about node
-    configuration files. If conf_file_ids is specified, only the
-    specified configuration files will be queried.
+    Returns an array of structs containing details about configuration
+    files. If conf_file_filter is specified and is an array of
+    configuration file identifiers, or a struct of configuration file
+    attributes, only configuration files matching the filter will be
+    returned.
     """
 
     roles = ['admin']
 
     accepts = [
         Auth(),
-        [ConfFile.fields['conf_file_id']]
+        Mixed([ConfFile.fields['conf_file_id']],
+              Filter(ConfFile.fields))
         ]
 
     returns = [ConfFile.fields]
 
-    def call(self, auth, conf_file_ids = None):
-        return ConfFiles(self.api, conf_file_ids).values()
+    def call(self, auth, conf_file_filter = None):
+        return ConfFiles(self.api, conf_file_filter).values()