9438ee38f4f41bbf10b9cc074f7e9aa38ac088e2
[plcapi.git] / PLC / Methods / DeleteSliceInstantiation.py
1 # $Id$
2 # $URL$
3 from PLC.Faults import *
4 from PLC.Method import Method
5 from PLC.Parameter import Parameter, Mixed
6 from PLC.SliceInstantiations import SliceInstantiation, SliceInstantiations
7 from PLC.Auth import Auth
8
9 class DeleteSliceInstantiation(Method):
10     """
11     Deletes a slice instantiation state.
12
13     WARNING: This will cause the deletion of all slices of this instantiation.
14
15     Returns 1 if successful, faults otherwise.
16     """
17
18     roles = ['admin']
19
20     accepts = [
21         Auth(),
22         SliceInstantiation.fields['instantiation']
23         ]
24
25     returns = Parameter(int, '1 if successful')
26
27
28     def call(self, auth, instantiation):
29         slice_instantiations = SliceInstantiations(self.api, [instantiation])
30         if not slice_instantiations:
31             raise PLCInvalidArgument, "No such slice instantiation state"
32         slice_instantiation = slice_instantiations[0]
33
34         slice_instantiation.delete()
35
36         return 1