1   /**
2    * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portlet.workflow.service.http;
24  
25  import com.liferay.portlet.workflow.service.WorkflowDefinitionServiceUtil;
26  
27  import org.json.JSONObject;
28  
29  /**
30   * <a href="WorkflowDefinitionServiceJSON.java.html"><b><i>View Source</i></b></a>
31   *
32   * <p>
33   * ServiceBuilder generated this class. Modifications in this class will be
34   * overwritten the next time is generated.
35   * </p>
36   *
37   * <p>
38   * This class provides a JSON utility for the
39   * <code>com.liferay.portlet.workflow.service.WorkflowDefinitionServiceUtil</code>
40   * service utility. The static methods of this class calls the same methods of
41   * the service utility. However, the signatures are different because it is
42   * difficult for JSON to support certain types.
43   * </p>
44   *
45   * <p>
46   * ServiceBuilder follows certain rules in translating the methods. For example,
47   * if the method in the service utility returns a <code>java.util.List</code>,
48   * that is translated to a <code>org.json.JSONArray</code>. If the method in the
49   * service utility returns a <code>com.liferay.portlet.workflow.model.WorkflowDefinition</code>,
50   * that is translated to a <code>org.json.JSONObject</code>. Methods that JSON
51   * cannot safely use are skipped. The logic for the translation is encapsulated
52   * in <code>com.liferay.portlet.workflow.service.http.WorkflowDefinitionJSONSerializer</code>.
53   * </p>
54   *
55   * <p>
56   * This allows you to call the the backend services directly from JavaScript.
57   * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
58   * reference of how that portlet uses the generated JavaScript in
59   * <code>portal-web/docroot/html/js/service.js</code> to call the backend
60   * services directly from JavaScript.
61   * </p>
62   *
63   * <p>
64   * The JSON utility is only generated for remote services.
65   * </p>
66   *
67   * @author Brian Wing Shun Chan
68   *
69   * @see com.liferay.portlet.workflow.service.WorkflowDefinitionServiceUtil
70   * @see com.liferay.portlet.workflow.service.http.WorkflowDefinitionJSONSerializer
71   *
72   */
73  public class WorkflowDefinitionServiceJSON {
74      public static JSONObject addDefinition(java.lang.String xml,
75          boolean addCommunityPermissions, boolean addGuestPermissions)
76          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
77              com.liferay.portal.PortalException {
78          com.liferay.portlet.workflow.model.WorkflowDefinition returnValue = WorkflowDefinitionServiceUtil.addDefinition(xml,
79                  addCommunityPermissions, addGuestPermissions);
80  
81          return WorkflowDefinitionJSONSerializer.toJSONObject(returnValue);
82      }
83  
84      public static JSONObject addDefinition(java.lang.String xml,
85          java.lang.String[] communityPermissions,
86          java.lang.String[] guestPermissions)
87          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
88              com.liferay.portal.PortalException {
89          com.liferay.portlet.workflow.model.WorkflowDefinition returnValue = WorkflowDefinitionServiceUtil.addDefinition(xml,
90                  communityPermissions, guestPermissions);
91  
92          return WorkflowDefinitionJSONSerializer.toJSONObject(returnValue);
93      }
94  
95      public static JSONObject addDefinition(java.lang.String xml,
96          java.lang.Boolean addCommunityPermissions,
97          java.lang.Boolean addGuestPermissions,
98          java.lang.String[] communityPermissions,
99          java.lang.String[] guestPermissions)
100         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
101             com.liferay.portal.PortalException {
102         com.liferay.portlet.workflow.model.WorkflowDefinition returnValue = WorkflowDefinitionServiceUtil.addDefinition(xml,
103                 addCommunityPermissions, addGuestPermissions,
104                 communityPermissions, guestPermissions);
105 
106         return WorkflowDefinitionJSONSerializer.toJSONObject(returnValue);
107     }
108 
109     public static void addDefinitionResources(
110         com.liferay.portal.model.User user, long definitionId,
111         boolean addCommunityPermissions, boolean addGuestPermissions)
112         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
113             com.liferay.portal.PortalException {
114         WorkflowDefinitionServiceUtil.addDefinitionResources(user,
115             definitionId, addCommunityPermissions, addGuestPermissions);
116     }
117 
118     public static void addDefinitionResources(
119         com.liferay.portal.model.User user, long definitionId,
120         java.lang.String[] communityPermissions,
121         java.lang.String[] guestPermissions)
122         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
123             com.liferay.portal.PortalException {
124         WorkflowDefinitionServiceUtil.addDefinitionResources(user,
125             definitionId, communityPermissions, guestPermissions);
126     }
127 
128     public static JSONObject getDefinition(long definitionId)
129         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
130             com.liferay.portal.PortalException {
131         com.liferay.portlet.workflow.model.WorkflowDefinition returnValue = WorkflowDefinitionServiceUtil.getDefinition(definitionId);
132 
133         return WorkflowDefinitionJSONSerializer.toJSONObject(returnValue);
134     }
135 }