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