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.WorkflowComponentServiceUtil;
26  
27  /**
28   * <a href="WorkflowComponentServiceJSON.java.html"><b><i>View Source</i></b></a>
29   *
30   * <p>
31   * ServiceBuilder generated this class. Modifications in this class will be
32   * overwritten the next time is generated.
33   * </p>
34   *
35   * <p>
36   * This class provides a JSON utility for the
37   * <code>com.liferay.portlet.workflow.service.WorkflowComponentServiceUtil</code>
38   * service utility. The static methods of this class calls the same methods of
39   * the service utility. However, the signatures are different because it is
40   * difficult for JSON to support certain types.
41   * </p>
42   *
43   * <p>
44   * ServiceBuilder follows certain rules in translating the methods. For example,
45   * if the method in the service utility returns a <code>java.util.List</code>,
46   * that is translated to a
47   * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the
48   * service utility returns a <code>com.liferay.portlet.workflow.model.WorkflowComponent</code>,
49   * that is translated to a
50   * <code>com.liferay.portal.kernel.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.WorkflowComponentJSONSerializer</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.WorkflowComponentServiceUtil
70   * @see com.liferay.portlet.workflow.service.http.WorkflowComponentJSONSerializer
71   *
72   */
73  public class WorkflowComponentServiceJSON {
74      public static java.util.List getCurrentTasks(long instanceId, long tokenId)
75          throws java.rmi.RemoteException,
76              com.liferay.portal.kernel.jbi.WorkflowComponentException {
77          java.util.List returnValue = WorkflowComponentServiceUtil.getCurrentTasks(instanceId,
78                  tokenId);
79  
80          return returnValue;
81      }
82  
83      public static java.lang.String getCurrentTasksXml(long instanceId,
84          long tokenId)
85          throws java.rmi.RemoteException,
86              com.liferay.portal.kernel.jbi.WorkflowComponentException {
87          java.lang.String returnValue = WorkflowComponentServiceUtil.getCurrentTasksXml(instanceId,
88                  tokenId);
89  
90          return returnValue;
91      }
92  
93      public static java.lang.String deploy(java.lang.String xml)
94          throws java.rmi.RemoteException,
95              com.liferay.portal.kernel.jbi.WorkflowComponentException {
96          java.lang.String returnValue = WorkflowComponentServiceUtil.deploy(xml);
97  
98          return returnValue;
99      }
100 
101     public static java.lang.Object getDefinition(long definitionId)
102         throws java.rmi.RemoteException,
103             com.liferay.portal.kernel.jbi.WorkflowComponentException {
104         java.lang.Object returnValue = WorkflowComponentServiceUtil.getDefinition(definitionId);
105 
106         return returnValue;
107     }
108 
109     public static java.util.List getDefinitions(long definitionId,
110         java.lang.String name, int start, int end)
111         throws java.rmi.RemoteException,
112             com.liferay.portal.kernel.jbi.WorkflowComponentException {
113         java.util.List returnValue = WorkflowComponentServiceUtil.getDefinitions(definitionId,
114                 name, start, end);
115 
116         return returnValue;
117     }
118 
119     public static java.lang.String getDefinitionsXml(long definitionId,
120         java.lang.String name, int start, int end)
121         throws java.rmi.RemoteException,
122             com.liferay.portal.kernel.jbi.WorkflowComponentException {
123         java.lang.String returnValue = WorkflowComponentServiceUtil.getDefinitionsXml(definitionId,
124                 name, start, end);
125 
126         return returnValue;
127     }
128 
129     public static int getDefinitionsCount(long definitionId,
130         java.lang.String name)
131         throws java.rmi.RemoteException,
132             com.liferay.portal.kernel.jbi.WorkflowComponentException {
133         int returnValue = WorkflowComponentServiceUtil.getDefinitionsCount(definitionId,
134                 name);
135 
136         return returnValue;
137     }
138 
139     public static java.lang.String getDefinitionsCountXml(long definitionId,
140         java.lang.String name)
141         throws java.rmi.RemoteException,
142             com.liferay.portal.kernel.jbi.WorkflowComponentException {
143         java.lang.String returnValue = WorkflowComponentServiceUtil.getDefinitionsCountXml(definitionId,
144                 name);
145 
146         return returnValue;
147     }
148 
149     public static java.lang.String getDefinitionXml(long definitionId)
150         throws java.rmi.RemoteException,
151             com.liferay.portal.kernel.jbi.WorkflowComponentException {
152         java.lang.String returnValue = WorkflowComponentServiceUtil.getDefinitionXml(definitionId);
153 
154         return returnValue;
155     }
156 
157     public static java.util.List getInstances(long definitionId,
158         long instanceId, java.lang.String definitionName,
159         java.lang.String definitionVersion, java.lang.String startDateGT,
160         java.lang.String startDateLT, java.lang.String endDateGT,
161         java.lang.String endDateLT, boolean hideEndedTasks,
162         boolean retrieveUserInstances, boolean andOperator, int start, int end)
163         throws java.rmi.RemoteException,
164             com.liferay.portal.kernel.jbi.WorkflowComponentException {
165         java.util.List returnValue = WorkflowComponentServiceUtil.getInstances(definitionId,
166                 instanceId, definitionName, definitionVersion, startDateGT,
167                 startDateLT, endDateGT, endDateLT, hideEndedTasks,
168                 retrieveUserInstances, andOperator, start, end);
169 
170         return returnValue;
171     }
172 
173     public static int getInstancesCount(long definitionId, long instanceId,
174         java.lang.String definitionName, java.lang.String definitionVersion,
175         java.lang.String startDateGT, java.lang.String startDateLT,
176         java.lang.String endDateGT, java.lang.String endDateLT,
177         boolean hideEndedTasks, boolean retrieveUserInstances,
178         boolean andOperator)
179         throws java.rmi.RemoteException,
180             com.liferay.portal.kernel.jbi.WorkflowComponentException {
181         int returnValue = WorkflowComponentServiceUtil.getInstancesCount(definitionId,
182                 instanceId, definitionName, definitionVersion, startDateGT,
183                 startDateLT, endDateGT, endDateLT, hideEndedTasks,
184                 retrieveUserInstances, andOperator);
185 
186         return returnValue;
187     }
188 
189     public static java.lang.String getInstancesCountXml(long definitionId,
190         long instanceId, java.lang.String definitionName,
191         java.lang.String definitionVersion, java.lang.String startDateGT,
192         java.lang.String startDateLT, java.lang.String endDateGT,
193         java.lang.String endDateLT, boolean hideEndedTasks,
194         boolean retrieveUserInstances, boolean andOperator)
195         throws java.rmi.RemoteException,
196             com.liferay.portal.kernel.jbi.WorkflowComponentException {
197         java.lang.String returnValue = WorkflowComponentServiceUtil.getInstancesCountXml(definitionId,
198                 instanceId, definitionName, definitionVersion, startDateGT,
199                 startDateLT, endDateGT, endDateLT, hideEndedTasks,
200                 retrieveUserInstances, andOperator);
201 
202         return returnValue;
203     }
204 
205     public static java.lang.String getInstancesXml(long definitionId,
206         long instanceId, java.lang.String definitionName,
207         java.lang.String definitionVersion, java.lang.String startDateGT,
208         java.lang.String startDateLT, java.lang.String endDateGT,
209         java.lang.String endDateLT, boolean hideEndedTasks,
210         boolean retrieveUserInstances, boolean andOperator, int start, int end)
211         throws java.rmi.RemoteException,
212             com.liferay.portal.kernel.jbi.WorkflowComponentException {
213         java.lang.String returnValue = WorkflowComponentServiceUtil.getInstancesXml(definitionId,
214                 instanceId, definitionName, definitionVersion, startDateGT,
215                 startDateLT, endDateGT, endDateLT, hideEndedTasks,
216                 retrieveUserInstances, andOperator, start, end);
217 
218         return returnValue;
219     }
220 
221     public static com.liferay.portlet.workflow.model.WorkflowTask getTask(
222         long taskId)
223         throws java.rmi.RemoteException,
224             com.liferay.portal.kernel.jbi.WorkflowComponentException {
225         com.liferay.portlet.workflow.model.WorkflowTask returnValue = WorkflowComponentServiceUtil.getTask(taskId);
226 
227         return returnValue;
228     }
229 
230     public static java.lang.String getTaskXml(long taskId)
231         throws java.rmi.RemoteException,
232             com.liferay.portal.kernel.jbi.WorkflowComponentException {
233         java.lang.String returnValue = WorkflowComponentServiceUtil.getTaskXml(taskId);
234 
235         return returnValue;
236     }
237 
238     public static java.util.List getTaskFormElements(long taskId)
239         throws java.rmi.RemoteException,
240             com.liferay.portal.kernel.jbi.WorkflowComponentException {
241         java.util.List returnValue = WorkflowComponentServiceUtil.getTaskFormElements(taskId);
242 
243         return returnValue;
244     }
245 
246     public static java.lang.String getTaskFormElementsXml(long taskId)
247         throws java.rmi.RemoteException,
248             com.liferay.portal.kernel.jbi.WorkflowComponentException {
249         java.lang.String returnValue = WorkflowComponentServiceUtil.getTaskFormElementsXml(taskId);
250 
251         return returnValue;
252     }
253 
254     public static java.util.List getTaskTransitions(long taskId)
255         throws java.rmi.RemoteException,
256             com.liferay.portal.kernel.jbi.WorkflowComponentException {
257         java.util.List returnValue = WorkflowComponentServiceUtil.getTaskTransitions(taskId);
258 
259         return returnValue;
260     }
261 
262     public static java.lang.String getTaskTransitionsXml(long taskId)
263         throws java.rmi.RemoteException,
264             com.liferay.portal.kernel.jbi.WorkflowComponentException {
265         java.lang.String returnValue = WorkflowComponentServiceUtil.getTaskTransitionsXml(taskId);
266 
267         return returnValue;
268     }
269 
270     public static java.util.List getUserTasks(long instanceId,
271         java.lang.String taskName, java.lang.String definitionName,
272         java.lang.String assignedTo, java.lang.String createDateGT,
273         java.lang.String createDateLT, java.lang.String startDateGT,
274         java.lang.String startDateLT, java.lang.String endDateGT,
275         java.lang.String endDateLT, boolean hideEndedTasks,
276         boolean andOperator, int start, int end)
277         throws java.rmi.RemoteException,
278             com.liferay.portal.kernel.jbi.WorkflowComponentException {
279         java.util.List returnValue = WorkflowComponentServiceUtil.getUserTasks(instanceId,
280                 taskName, definitionName, assignedTo, createDateGT,
281                 createDateLT, startDateGT, startDateLT, endDateGT, endDateLT,
282                 hideEndedTasks, andOperator, start, end);
283 
284         return returnValue;
285     }
286 
287     public static int getUserTasksCount(long instanceId,
288         java.lang.String taskName, java.lang.String definitionName,
289         java.lang.String assignedTo, java.lang.String createDateGT,
290         java.lang.String createDateLT, java.lang.String startDateGT,
291         java.lang.String startDateLT, java.lang.String endDateGT,
292         java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator)
293         throws java.rmi.RemoteException,
294             com.liferay.portal.kernel.jbi.WorkflowComponentException {
295         int returnValue = WorkflowComponentServiceUtil.getUserTasksCount(instanceId,
296                 taskName, definitionName, assignedTo, createDateGT,
297                 createDateLT, startDateGT, startDateLT, endDateGT, endDateLT,
298                 hideEndedTasks, andOperator);
299 
300         return returnValue;
301     }
302 
303     public static java.lang.String getUserTasksCountXml(long instanceId,
304         java.lang.String taskName, java.lang.String definitionName,
305         java.lang.String assignedTo, java.lang.String createDateGT,
306         java.lang.String createDateLT, java.lang.String startDateGT,
307         java.lang.String startDateLT, java.lang.String endDateGT,
308         java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator)
309         throws java.rmi.RemoteException,
310             com.liferay.portal.kernel.jbi.WorkflowComponentException {
311         java.lang.String returnValue = WorkflowComponentServiceUtil.getUserTasksCountXml(instanceId,
312                 taskName, definitionName, assignedTo, createDateGT,
313                 createDateLT, startDateGT, startDateLT, endDateGT, endDateLT,
314                 hideEndedTasks, andOperator);
315 
316         return returnValue;
317     }
318 
319     public static java.lang.String getUserTasksXml(long instanceId,
320         java.lang.String taskName, java.lang.String definitionName,
321         java.lang.String assignedTo, java.lang.String createDateGT,
322         java.lang.String createDateLT, java.lang.String startDateGT,
323         java.lang.String startDateLT, java.lang.String endDateGT,
324         java.lang.String endDateLT, boolean hideEndedTasks,
325         boolean andOperator, int start, int end)
326         throws java.rmi.RemoteException,
327             com.liferay.portal.kernel.jbi.WorkflowComponentException {
328         java.lang.String returnValue = WorkflowComponentServiceUtil.getUserTasksXml(instanceId,
329                 taskName, definitionName, assignedTo, createDateGT,
330                 createDateLT, startDateGT, startDateLT, endDateGT, endDateLT,
331                 hideEndedTasks, andOperator, start, end);
332 
333         return returnValue;
334     }
335 
336     public static void signalInstance(long instanceId)
337         throws java.rmi.RemoteException,
338             com.liferay.portal.kernel.jbi.WorkflowComponentException {
339         WorkflowComponentServiceUtil.signalInstance(instanceId);
340     }
341 
342     public static void signalToken(long instanceId, long tokenId)
343         throws java.rmi.RemoteException,
344             com.liferay.portal.kernel.jbi.WorkflowComponentException {
345         WorkflowComponentServiceUtil.signalToken(instanceId, tokenId);
346     }
347 
348     public static java.lang.String startWorkflow(long definitionId)
349         throws java.rmi.RemoteException,
350             com.liferay.portal.kernel.jbi.WorkflowComponentException {
351         java.lang.String returnValue = WorkflowComponentServiceUtil.startWorkflow(definitionId);
352 
353         return returnValue;
354     }
355 }