Merge pull request #29 from fpoyer/resultset

OdooCommand#callObjectFunction returns new class Response

Author: flotho

src/main/java/com/debortoliwines/odoo/api/Field.java

@@ -21,6 +21,7 @@
 
 import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.Map;
 
 /***
  * Provides OpenERP field properties like data types, selection fields etc.
@@ -39,9 +40,9 @@ public enum FieldType {
 	}
 
 	private final String name;
-	private final HashMap<String, Object> openERPFieldData;
+	private final Map<String, Object> openERPFieldData;
 
-	public Field(String fieldName, HashMap<String, Object> openERPFieldData){
+	public Field(String fieldName, Map<String, Object> openERPFieldData) {
 		this.openERPFieldData = openERPFieldData;
 		this.name = fieldName;
 	}

src/main/java/com/debortoliwines/odoo/api/FilterCollection.java

@@ -59,14 +59,14 @@ public enum FilterOperator{
 	 * @param fieldName Name of the model that should be filtered on
 	 * @param comparison For example =, !=, >, >=, <, <=, like, ilike, in, not in, child_of, parent_left, parent_right
 	 * @param value value that will be compared to 'fieldName' using the 'comparison'
-	 * @throws OpeneERPApiException 
+	 * @throws OdooApiException 
 	 */
-	public void add(int index, String fieldName, String comparison, Object value) throws OpeneERPApiException{
+	public void add(int index, String fieldName, String comparison, Object value) throws OdooApiException{
 		if (fieldName == null)
-			throw new OpeneERPApiException("First filter parameter is mandatory.  Please read the OpenERP help.");
+			throw new OdooApiException("First filter parameter is mandatory.  Please read the OpenERP help.");
 
 		if (comparison == null)
-			throw new OpeneERPApiException("Second filter parameter is mandatory.  Please read the OpenERP help.");
+			throw new OdooApiException("Second filter parameter is mandatory.  Please read the OpenERP help.");
 
 		Object [] filter = new Object[] {fieldName,comparison,value};
 		filters.add(index, filter);
@@ -77,9 +77,9 @@ public void add(int index, String fieldName, String comparison, Object value) th
 	 * @param fieldName Name of the model that should be filtered on
 	 * @param comparison For example =, !=, >, >=, <, <=, like, ilike, in, not in, child_of, parent_left, parent_right
 	 * @param value value that will be compared to 'fieldName' using the 'comparison'
-	 * @throws OpeneERPApiException 
+	 * @throws OdooApiException 
 	 */
-	public void add(String fieldName, String comparison, Object value) throws OpeneERPApiException{
+	public void add(String fieldName, String comparison, Object value) throws OdooApiException{
 		add(filters.size(), fieldName, comparison, value);
 	}
 

src/main/java/com/debortoliwines/odoo/api/ObjectAdapter.java

@@ -1,7 +1,7 @@
 /*
  *   Copyright 2011, 2014 De Bortoli Wines Pty Limited (Australia)
  *
- *   This file is part of OpenERPJavaAPI.
+ *   This file is part of OdooJavaAPI.
  *
  *   Licensed under the Apache License, Version 2.0 (the "License");
  *   you may not use this file except in compliance with the License.
@@ -20,27 +20,25 @@
 package com.debortoliwines.odoo.api;
 
 /**
- * Exception class for OpenERP API errors
+ * Exception class for Odoo API errors
+ * 
  * @author Pieter van der Merwe
  *
  */
-public class OpeneERPApiException extends Exception {
+public class OdooApiException extends Exception {
 
 	private static final long serialVersionUID = 3148147969903379455L;
 
-	public OpeneERPApiException(String message) {
+	public OdooApiException(String message) {
 		super(message);
-		// TODO Auto-generated constructor stub
 	}
 
-	public OpeneERPApiException(Throwable cause) {
+	public OdooApiException(Throwable cause) {
 		super(cause);
-		// TODO Auto-generated constructor stub
 	}
 
-	public OpeneERPApiException(String message, Throwable cause) {
+	public OdooApiException(String message, Throwable cause) {
 		super(message, cause);
-		// TODO Auto-generated constructor stub
 	}
 
 }

…wines/odoo/api/OpeneERPApiException.java …toliwines/odoo/api/OdooApiException.javasrc/main/java/com/debortoliwines/odoo/api/OpeneERPApiException.java renamed to src/main/java/com/debortoliwines/odoo/api/OdooApiException.java src/main/java/com/debortoliwines/odoo/api/OpeneERPApiException.java renamed to src/main/java/com/debortoliwines/odoo/api/OdooApiException.java

@@ -1,7 +1,7 @@
 /*
  *   Copyright 2011, 2013-2014 De Bortoli Wines Pty Limited (Australia)
  *
- *   This file is part of OpenERPJavaAPI.
+ *   This file is part of OdooJavaAPI.
  *
  *   Licensed under the Apache License, Version 2.0 (the "License");
  *   you may not use this file except in compliance with the License.
@@ -19,25 +19,28 @@
 
 package com.debortoliwines.odoo.api;
 
-import java.util.HashMap;
 import java.util.Map;
 
 import org.apache.xmlrpc.XmlRpcException;
 
 /**
- * Wrapper class for OpenERP commands.  It uses the session object to make the call, but builds the parameters in this class
+ * Wrapper class for Odoo commands. It uses the session object to make the call,
+ * but builds the parameters in this class
+ * 
  * @author Pieter van der Merwe
  *
  */
-public class OpenERPCommand {
+public class OdooCommand {
 
 	private final Session session;
 
 	/**
 	 * Main constructor
-	 * @param session Session object that will be used to make the calls to OpenERP.
+	 * 
+	 * @param session
+	 *            Session object that will be used to make the calls to Odoo.
 	 */
-	public OpenERPCommand(Session session){
+	public OdooCommand(Session session){
 		this.session = session;
 	}
 
@@ -64,28 +67,40 @@ public Object[] searchObject(String objectName, Object [] filter) throws XmlRpcE
 	 * @throws XmlRpcException
 	 */
 	public Object searchObject(String objectName, Object [] filter, int offset, int limit, String order, boolean count) throws XmlRpcException {
-		Object[] params = new Object[] {filter, (offset < 0 ? false : offset), (limit < 0 ? false : limit), (order == null || order.length() == 0 ? false : order), session.getContext(), count};
+		Object offsetParam = offset < 0 ? false : offset;
+		Object limitParam = limit < 0 ? false : limit;
+		Object orderParam = order == null || order.length() == 0 ? false : order;
+		Object[] params = new Object[] {filter, offsetParam, limitParam, orderParam, session.getContext(), count};
 		return session.executeCommand(objectName, "search", params);
 	}
 
 	/**
-	 * Fetches field information for an object n OpenERP
-	 * @param objectName Object or model name to fetch field information for
-	 * @param filterFields Only return data for files in the filter list
+	 * Fetches field information for an object n Odoo
+	 * 
+	 * @param objectName
+	 *            Object or model name to fetch field information for
+	 * @param filterFields
+	 *            Only return data for files in the filter list
 	 * @return A HashMap of field-value pairs.
 	 * @throws XmlRpcException
 	 */
 	@SuppressWarnings("unchecked")
-	public HashMap<String, Object> getFields(String objectName, String[] filterFields) throws XmlRpcException {
-		return (HashMap<String, Object>) session.executeCommand(objectName, "fields_get", new Object[]{filterFields, session.getContext() });
+	public Map<String, Object> getFields(String objectName, String[] filterFields) throws XmlRpcException {
+		return (Map<String, Object>) session.executeCommand(objectName, "fields_get",
+				new Object[] { filterFields, session.getContext() });
 	}
 
 	/**
-	 * Reads object data from the OpenERP server
-	 * @param objectName Name of the object to return data for
-	 * @param ids List of id to fetch data for.  Call searchObject to get a potential list
-	 * @param fields List of fields to return data for
-	 * @returnA collection of rows for an OpenERP object
+	 * Reads object data from the Odoo server
+	 * 
+	 * @param objectName
+	 *            Name of the object to return data for
+	 * @param ids
+	 *            List of id to fetch data for. Call searchObject to get a
+	 *            potential list
+	 * @param fields
+	 *            List of fields to return data for
+	 * @returnA collection of rows for an Odoo object
 	 * @throws XmlRpcException
 	 */
 	public Object[] readObject(String objectName, Object [] ids, String [] fields) throws XmlRpcException {
@@ -101,8 +116,7 @@ public Object[] readObject(String objectName, Object [] ids, String [] fields) t
 	 * @throws XmlRpcException
 	 */
 	public boolean writeObject(String objectName, int id, Map<String, Object> valueList) throws XmlRpcException {
-		boolean result = (Boolean) session.executeCommand(objectName, "write", new Object[] { id, valueList });
-		return result;
+		return (Boolean) session.executeCommand(objectName, "write", new Object[] { id, valueList });
 	}
 
 	/**
@@ -111,7 +125,6 @@ public boolean writeObject(String objectName, int id, Map<String, Object> valueL
 	 * @param fieldList List of fields to update.  The import function has some specific naming conventions.  Consider using the ObjectAdapter
 	 * @param rows Rows to import.  Fields must be in the same order as the 'fieldList' parameter
 	 * @return The result returned from the server.  Either returns the number of successfully imported rows or returns the error.
-	 * @throws OpeneERPApiException
 	 * @throws XmlRpcException
 	 */
 
@@ -120,26 +133,33 @@ public boolean writeObject(String objectName, int id, Map<String, Object> valueL
 	}
 
 	@SuppressWarnings("unchecked")
-  public HashMap<String, Object> Load(String objectName, String[] fieldList, Object [][] rows) throws XmlRpcException {
+	public Map<String, Object> load(String objectName, String[] fieldList, Object[][] rows) throws XmlRpcException {
 	  Object o = session.executeCommand(objectName, "load", new Object[] {fieldList, rows});
-    return (HashMap<String, Object>) o;
+		return (Map<String, Object>) o;
   }
 
 	/**
-	 * Returns the name_get result of an object in the OpenERP server.
-	 * @param objectName Object name to invoke the name_get on
-	 * @param ids Database IDs to invoke the name_get for
-	 * @return An Object[] with an entry for each ID.  Each entry is another Object [] with index 0 being the ID and index 1 being the Name
+	 * Returns the name_get result of an object in the Odoo server.
+	 * 
+	 * @param objectName
+	 *            Object name to invoke the name_get on
+	 * @param ids
+	 *            Database IDs to invoke the name_get for
+	 * @return An Object[] with an entry for each ID. Each entry is another
+	 *         Object [] with index 0 being the ID and index 1 being the Name
 	 * @throws XmlRpcException
 	 */
 	public Object[] nameGet(String objectName, Object[] ids) throws XmlRpcException{
 		return (Object[]) session.executeCommand(objectName, "name_get", new Object[] {ids});
 	}
 
 	/**
-	 * Deletes objects from the OpenERP Server
-	 * @param objectName Object name to delete rows from
-	 * @param ids List of ids to delete data from
+	 * Deletes objects from the Odoo Server
+	 * 
+	 * @param objectName
+	 *            Object name to delete rows from
+	 * @param ids
+	 *            List of ids to delete data from
 	 * @return If the command was successful
 	 * @throws XmlRpcException
 	 */
@@ -149,27 +169,38 @@ public boolean unlinkObject(String objectName, Object [] ids) throws XmlRpcExcep
 
 	/**
 	 * Creates a single object
-	 * @param objectName Name of the object to create
-	 * @param values HashMap of values to assign to the new object
+	 * 
+	 * @param objectName
+	 *            Name of the object to create
+	 * @param values
+	 *            Map of values to assign to the new object
 	 * @return The database ID of the new object
 	 * @throws XmlRpcException
 	 */
-	public Object createObject(String objectName, HashMap<String, Object> values) throws XmlRpcException{
+	public Object createObject(String objectName, Map<String, Object> values) throws XmlRpcException {
 		return session.executeCommand(objectName, "create", new Object[] {values, session.getContext()});
 	}
 
 	/**
-	 * Calls any function on an object.  
-	 * The function OpenERP must have the signature like (self, cr, uid, *param) and return a dictionary or object.
-	 * *param can be replaced by separate parameters if you are sure of the number of parameters expected
-	 * @param objectName Object name where the function exists
-	 * @param functionName function to call
-	 * @param parameters Additional parameters that will be passed to the object 
+	 * Calls any function on an object. The function Odoo must have the
+	 * signature like (self, cr, uid, *param) and return a dictionary or object.
+	 * *param can be replaced by separate parameters if you are sure of the
+	 * number of parameters expected
+	 * 
+	 * @param objectName
+	 *            Object name where the function exists
+	 * @param functionName
+	 *            function to call
+	 * @param parameters
+	 *            Additional parameters that will be passed to the object
 	 * @return An Object array of values
-	 * @throws XmlRpcException
 	 */
-	public Object[] callObjectFunction(String objectName, String functionName, Object[] parameters) throws XmlRpcException {
-		return (Object[]) session.executeCommand(objectName, functionName, parameters);
+	public Response callObjectFunction(String objectName, String functionName, Object[] parameters) {
+		try {
+			return new Response( session.executeCommand(objectName, functionName, parameters) );
+		} catch (XmlRpcException e) {
+			return new Response(e);
+		}
 	}
 
 	/**
@@ -184,33 +215,5 @@ public Object[] callObjectFunction(String objectName, String functionName, Objec
   public void executeWorkflow(final String objectName, final String signal, final int objectID) throws XmlRpcException {
     session.executeWorkflow(objectName, signal, objectID);   
   }
-	
-	/***
-	 * Left here for later use if required
-	
-	public void nameSearch() throws XmlRpcException{
-		Object result = null;
-		
-		OpenERPClient objectClient = new OpenERPClient(host, port, RPCServices.RPC_OBJECT);
-		HashMap<Object, String> values = new HashMap<Object, String> ();
-		values.put("user_email", "[email protected]");
-		
-		HashMap<String, Object> rows = new HashMap<String, Object> ();
-		rows.put("28", values);
-		
-		Object[] params = new Object[] {databaseName, userID, password, "res.users", "name_search", "Pieter van der Merwe"};
-		result = objectClient.execute("execute", params);
-		
-		//return result;
-	}
-	
-	public Object getDefaults() throws XmlRpcException{
-		Object result = null;
-		OpenERPClient objectClient = new OpenERPClient(host, port, RPCServices.RPC_OBJECT);
-		Object[] params = new Object[] {databaseName, userID, password, "res.users", "default_get", new Object[]{"active"}};
-		result = objectClient.execute("execute", params);
-		return result;	}
-		
-    ***/
 
 }

…ortoliwines/odoo/api/OpenERPCommand.java …debortoliwines/odoo/api/OdooCommand.javasrc/main/java/com/debortoliwines/odoo/api/OpenERPCommand.java renamed to src/main/java/com/debortoliwines/odoo/api/OdooCommand.java src/main/java/com/debortoliwines/odoo/api/OpenERPCommand.java renamed to src/main/java/com/debortoliwines/odoo/api/OdooCommand.java

@@ -0,0 +1,43 @@
+package com.debortoliwines.odoo.api;
+
+public class Response {
+
+	private final boolean isSuccessful;
+	private final Exception errorCause;
+	private final Object responseObject;
+	private final Object[] responseObjectAsArray;
+
+	public Response(final Exception errorCause) {
+		this.isSuccessful = false;
+		this.errorCause = errorCause;
+		this.responseObject = null;
+		this.responseObjectAsArray = new Object[0];
+	}
+
+	public Response(final Object responseObject) {
+		this.isSuccessful = true;
+		this.errorCause = null;
+		this.responseObject = responseObject;
+		if (responseObject instanceof Object[]) {
+			this.responseObjectAsArray = (Object[]) responseObject;
+		} else {
+			this.responseObjectAsArray = new Object[] { responseObject };
+		}
+	}
+
+	public boolean isSuccessful() {
+		return isSuccessful;
+	}
+
+	public Throwable getErrorCause() {
+		return errorCause;
+	}
+
+	public Object getResponseObject() {
+		return responseObject;
+	}
+
+	public Object[] getResponseObjectAsArray() {
+		return responseObjectAsArray;
+	}
+}