Merge from trunk

[plcapi.git] / trunk / PLC / Methods / GetEvents.py

diff --git a/trunk/PLC/Methods/GetEvents.py b/trunk/PLC/Methods/GetEvents.py
new file mode 100644 (file)
index 0000000..2bc989c
--- /dev/null
+++ b/trunk/PLC/Methods/GetEvents.py
@@ -0,0 +1,30 @@
+from PLC.Faults import *
+from PLC.Method import Method
+from PLC.Parameter import Parameter, Mixed
+from PLC.Filter import Filter
+from PLC.Events import Event, Events
+from PLC.Auth import Auth
+
+class GetEvents(Method):
+    """
+    Returns an array of structs containing details about events and
+    faults. If event_filter is specified and is an array of event
+    identifiers, or a struct of event attributes, only events matching
+    the filter will be returned. If return_fields is specified, only the
+    specified details will be returned.
+    """
+
+    roles = ['admin']
+
+    accepts = [
+        Auth(),
+        Mixed([Event.fields['event_id']],
+              Filter(Event.fields)),
+        Parameter([str], "List of fields to return", nullok = True)
+        ]
+
+    returns = [Event.fields]
+
+    def call(self, auth, event_filter = None, return_fields = None):
+        return Events(self.api, event_filter, return_fields)
+