Merge from trunk

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

diff --git a/trunk/PLC/Methods/DeleteSliceInstantiation.py b/trunk/PLC/Methods/DeleteSliceInstantiation.py
new file mode 100644 (file)
index 0000000..5098a9d
--- /dev/null
+++ b/trunk/PLC/Methods/DeleteSliceInstantiation.py
@@ -0,0 +1,34 @@
+from PLC.Faults import *
+from PLC.Method import Method
+from PLC.Parameter import Parameter, Mixed
+from PLC.SliceInstantiations import SliceInstantiation, SliceInstantiations
+from PLC.Auth import Auth
+
+class DeleteSliceInstantiation(Method):
+    """
+    Deletes a slice instantiation state.
+
+    WARNING: This will cause the deletion of all slices of this instantiation.
+
+    Returns 1 if successful, faults otherwise.
+    """
+
+    roles = ['admin']
+
+    accepts = [
+        Auth(),
+        SliceInstantiation.fields['instantiation']
+        ]
+
+    returns = Parameter(int, '1 if successful')
+
+
+    def call(self, auth, instantiation):
+        slice_instantiations = SliceInstantiations(self.api, [instantiation])
+        if not slice_instantiations:
+            raise PLCInvalidArgument, "No such slice instantiation state"
+        slice_instantiation = slice_instantiations[0]
+
+        slice_instantiation.delete()
+
+        return 1