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.portal.kernel.json.JSONObject;
26  
27  import com.liferay.portlet.workflow.service.WorkflowDefinitionServiceUtil;
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
49   * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the
50   * service utility returns a <code>com.liferay.portlet.workflow.model.WorkflowDefinition</code>,
51   * that is translated to a
52   * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON
53   * cannot safely use are skipped. The logic for the translation is encapsulated
54   * in <code>com.liferay.portlet.workflow.service.http.WorkflowDefinitionJSONSerializer</code>.
55   * </p>
56   *
57   * <p>
58   * This allows you to call the the backend services directly from JavaScript.
59   * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
60   * reference of how that portlet uses the generated JavaScript in
61   * <code>portal-web/docroot/html/js/service.js</code> to call the backend
62   * services directly from JavaScript.
63   * </p>
64   *
65   * <p>
66   * The JSON utility is only generated for remote services.
67   * </p>
68   *
69   * @author Brian Wing Shun Chan
70   *
71   * @see com.liferay.portlet.workflow.service.WorkflowDefinitionServiceUtil
72   * @see com.liferay.portlet.workflow.service.http.WorkflowDefinitionJSONSerializer
73   *
74   */
75  public class WorkflowDefinitionServiceJSON {
76      public static JSONObject addDefinition(java.lang.String xml,
77          boolean addCommunityPermissions, boolean addGuestPermissions)
78          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
79              com.liferay.portal.SystemException {
80          com.liferay.portlet.workflow.model.WorkflowDefinition returnValue = WorkflowDefinitionServiceUtil.addDefinition(xml,
81                  addCommunityPermissions, addGuestPermissions);
82  
83          return WorkflowDefinitionJSONSerializer.toJSONObject(returnValue);
84      }
85  
86      public static JSONObject addDefinition(java.lang.String xml,
87          java.lang.String[] communityPermissions,
88          java.lang.String[] guestPermissions)
89          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
90              com.liferay.portal.SystemException {
91          com.liferay.portlet.workflow.model.WorkflowDefinition returnValue = WorkflowDefinitionServiceUtil.addDefinition(xml,
92                  communityPermissions, guestPermissions);
93  
94          return WorkflowDefinitionJSONSerializer.toJSONObject(returnValue);
95      }
96  
97      public static JSONObject addDefinition(java.lang.String xml,
98          java.lang.Boolean addCommunityPermissions,
99          java.lang.Boolean addGuestPermissions,
100         java.lang.String[] communityPermissions,
101         java.lang.String[] guestPermissions)
102         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
103             com.liferay.portal.SystemException {
104         com.liferay.portlet.workflow.model.WorkflowDefinition returnValue = WorkflowDefinitionServiceUtil.addDefinition(xml,
105                 addCommunityPermissions, addGuestPermissions,
106                 communityPermissions, guestPermissions);
107 
108         return WorkflowDefinitionJSONSerializer.toJSONObject(returnValue);
109     }
110 
111     public static void addDefinitionResources(
112         com.liferay.portal.model.User user, long definitionId,
113         boolean addCommunityPermissions, boolean addGuestPermissions)
114         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
115             com.liferay.portal.SystemException {
116         WorkflowDefinitionServiceUtil.addDefinitionResources(user,
117             definitionId, addCommunityPermissions, addGuestPermissions);
118     }
119 
120     public static void addDefinitionResources(
121         com.liferay.portal.model.User user, long definitionId,
122         java.lang.String[] communityPermissions,
123         java.lang.String[] guestPermissions)
124         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
125             com.liferay.portal.SystemException {
126         WorkflowDefinitionServiceUtil.addDefinitionResources(user,
127             definitionId, communityPermissions, guestPermissions);
128     }
129 
130     public static JSONObject getDefinition(long definitionId)
131         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
132             com.liferay.portal.SystemException {
133         com.liferay.portlet.workflow.model.WorkflowDefinition returnValue = WorkflowDefinitionServiceUtil.getDefinition(definitionId);
134 
135         return WorkflowDefinitionJSONSerializer.toJSONObject(returnValue);
136     }
137 }