Merge from trunk

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

diff --git a/trunk/PLC/Methods/AddAddressType.py b/trunk/PLC/Methods/AddAddressType.py
new file mode 100644 (file)
index 0000000..9fc771b
--- /dev/null
+++ b/trunk/PLC/Methods/AddAddressType.py
@@ -0,0 +1,36 @@
+from PLC.Faults import *
+from PLC.Method import Method
+from PLC.Parameter import Parameter, Mixed
+from PLC.AddressTypes import AddressType, AddressTypes
+from PLC.Auth import Auth
+
+can_update = lambda (field, value): field not in ['address_type_id']
+
+class AddAddressType(Method):
+    """
+    Adds a new address type. Fields specified in address_type_fields
+    are used.
+
+    Returns the new address_type_id (> 0) if successful, faults otherwise.
+    """
+
+    roles = ['admin']
+
+    address_type_fields = dict(filter(can_update, AddressType.fields.items()))
+
+    accepts = [
+        Auth(),
+        address_type_fields
+        ]
+
+    returns = Parameter(int, 'New address_type_id (> 0) if successful')
+        
+
+    def call(self, auth, address_type_fields):
+        address_type_fields = dict(filter(can_update, address_type_fields.items()))
+        address_type = AddressType(self.api, address_type_fields)
+        address_type.sync()
+
+       self.event_objects = {'AddressType' : [address_type['address_type_id']]}
+        
+       return address_type['address_type_id']