move sfa package import inside of __init__()
[plcapi.git] / PLC / Methods / AddInitScript.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.InitScripts import InitScript, InitScripts
7 from PLC.Auth import Auth
8
9 can_update = lambda (field, value): field not in \
10              ['initscript_id']
11
12 class AddInitScript(Method):
13     """
14     Adds a new initscript. Any fields specified in initscript_fields
15     are used, otherwise defaults are used.
16
17     Returns the new initscript_id (> 0) if successful, faults otherwise.
18     """
19
20     roles = ['admin']
21
22     initscript_fields = dict(filter(can_update, InitScript.fields.items()))
23
24     accepts = [
25         Auth(),
26         initscript_fields
27         ]
28
29     returns = Parameter(int, 'New initscript_id (> 0) if successful')
30
31
32     def call(self, auth, initscript_fields):
33         initscript_fields = dict(filter(can_update, initscript_fields.items()))
34         initscript = InitScript(self.api, initscript_fields)
35         initscript.sync()
36
37         self.event_objects = {'InitScript': [initscript['initscript_id']]}
38
39         return initscript['initscript_id']