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;
24  
25  
26  /**
27   * <a href="WorkflowComponentService.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This interface defines the service. The default implementation is
36   * <code>com.liferay.portlet.workflow.service.impl.WorkflowComponentServiceImpl</code>.
37   * Modify methods in that class and rerun ServiceBuilder to populate this class
38   * and all other generated classes.
39   * </p>
40   *
41   * <p>
42   * This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
43   * </p>
44   *
45   * @author Brian Wing Shun Chan
46   *
47   * @see com.liferay.portlet.workflow.service.WorkflowComponentServiceUtil
48   *
49   */
50  public interface WorkflowComponentService {
51      public java.util.List getCurrentTasks(long instanceId, long tokenId)
52          throws java.rmi.RemoteException,
53              com.liferay.portal.kernel.jbi.WorkflowComponentException;
54  
55      public java.lang.String getCurrentTasksXml(long instanceId, long tokenId)
56          throws java.rmi.RemoteException,
57              com.liferay.portal.kernel.jbi.WorkflowComponentException;
58  
59      public java.lang.String deploy(java.lang.String xml)
60          throws java.rmi.RemoteException,
61              com.liferay.portal.kernel.jbi.WorkflowComponentException;
62  
63      public java.lang.Object getDefinition(long definitionId)
64          throws java.rmi.RemoteException,
65              com.liferay.portal.kernel.jbi.WorkflowComponentException;
66  
67      public java.util.List getDefinitions(long definitionId,
68          java.lang.String name, int start, int end)
69          throws java.rmi.RemoteException,
70              com.liferay.portal.kernel.jbi.WorkflowComponentException;
71  
72      public java.lang.String getDefinitionsXml(long definitionId,
73          java.lang.String name, int start, int end)
74          throws java.rmi.RemoteException,
75              com.liferay.portal.kernel.jbi.WorkflowComponentException;
76  
77      public int getDefinitionsCount(long definitionId, java.lang.String name)
78          throws java.rmi.RemoteException,
79              com.liferay.portal.kernel.jbi.WorkflowComponentException;
80  
81      public java.lang.String getDefinitionsCountXml(long definitionId,
82          java.lang.String name)
83          throws java.rmi.RemoteException,
84              com.liferay.portal.kernel.jbi.WorkflowComponentException;
85  
86      public java.lang.String getDefinitionXml(long definitionId)
87          throws java.rmi.RemoteException,
88              com.liferay.portal.kernel.jbi.WorkflowComponentException;
89  
90      public java.util.List getInstances(long definitionId, long instanceId,
91          java.lang.String definitionName, java.lang.String definitionVersion,
92          java.lang.String startDateGT, java.lang.String startDateLT,
93          java.lang.String endDateGT, java.lang.String endDateLT,
94          boolean hideEndedTasks, boolean retrieveUserInstances,
95          boolean andOperator, int start, int end)
96          throws java.rmi.RemoteException,
97              com.liferay.portal.kernel.jbi.WorkflowComponentException;
98  
99      public int getInstancesCount(long definitionId, long instanceId,
100         java.lang.String definitionName, java.lang.String definitionVersion,
101         java.lang.String startDateGT, java.lang.String startDateLT,
102         java.lang.String endDateGT, java.lang.String endDateLT,
103         boolean hideEndedTasks, boolean retrieveUserInstances,
104         boolean andOperator)
105         throws java.rmi.RemoteException,
106             com.liferay.portal.kernel.jbi.WorkflowComponentException;
107 
108     public java.lang.String getInstancesCountXml(long definitionId,
109         long instanceId, java.lang.String definitionName,
110         java.lang.String definitionVersion, java.lang.String startDateGT,
111         java.lang.String startDateLT, java.lang.String endDateGT,
112         java.lang.String endDateLT, boolean hideEndedTasks,
113         boolean retrieveUserInstances, boolean andOperator)
114         throws java.rmi.RemoteException,
115             com.liferay.portal.kernel.jbi.WorkflowComponentException;
116 
117     public java.lang.String getInstancesXml(long definitionId, long instanceId,
118         java.lang.String definitionName, java.lang.String definitionVersion,
119         java.lang.String startDateGT, java.lang.String startDateLT,
120         java.lang.String endDateGT, java.lang.String endDateLT,
121         boolean hideEndedTasks, boolean retrieveUserInstances,
122         boolean andOperator, int start, int end)
123         throws java.rmi.RemoteException,
124             com.liferay.portal.kernel.jbi.WorkflowComponentException;
125 
126     public com.liferay.portlet.workflow.model.WorkflowTask getTask(long taskId)
127         throws java.rmi.RemoteException,
128             com.liferay.portal.kernel.jbi.WorkflowComponentException;
129 
130     public java.lang.String getTaskXml(long taskId)
131         throws java.rmi.RemoteException,
132             com.liferay.portal.kernel.jbi.WorkflowComponentException;
133 
134     public java.util.List getTaskFormElements(long taskId)
135         throws java.rmi.RemoteException,
136             com.liferay.portal.kernel.jbi.WorkflowComponentException;
137 
138     public java.lang.String getTaskFormElementsXml(long taskId)
139         throws java.rmi.RemoteException,
140             com.liferay.portal.kernel.jbi.WorkflowComponentException;
141 
142     public java.util.List getTaskTransitions(long taskId)
143         throws java.rmi.RemoteException,
144             com.liferay.portal.kernel.jbi.WorkflowComponentException;
145 
146     public java.lang.String getTaskTransitionsXml(long taskId)
147         throws java.rmi.RemoteException,
148             com.liferay.portal.kernel.jbi.WorkflowComponentException;
149 
150     public java.util.List getUserTasks(long instanceId,
151         java.lang.String taskName, java.lang.String definitionName,
152         java.lang.String assignedTo, java.lang.String createDateGT,
153         java.lang.String createDateLT, java.lang.String startDateGT,
154         java.lang.String startDateLT, java.lang.String endDateGT,
155         java.lang.String endDateLT, boolean hideEndedTasks,
156         boolean andOperator, int start, int end)
157         throws java.rmi.RemoteException,
158             com.liferay.portal.kernel.jbi.WorkflowComponentException;
159 
160     public int getUserTasksCount(long instanceId, java.lang.String taskName,
161         java.lang.String definitionName, java.lang.String assignedTo,
162         java.lang.String createDateGT, java.lang.String createDateLT,
163         java.lang.String startDateGT, java.lang.String startDateLT,
164         java.lang.String endDateGT, java.lang.String endDateLT,
165         boolean hideEndedTasks, boolean andOperator)
166         throws java.rmi.RemoteException,
167             com.liferay.portal.kernel.jbi.WorkflowComponentException;
168 
169     public java.lang.String getUserTasksCountXml(long instanceId,
170         java.lang.String taskName, java.lang.String definitionName,
171         java.lang.String assignedTo, java.lang.String createDateGT,
172         java.lang.String createDateLT, java.lang.String startDateGT,
173         java.lang.String startDateLT, java.lang.String endDateGT,
174         java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator)
175         throws java.rmi.RemoteException,
176             com.liferay.portal.kernel.jbi.WorkflowComponentException;
177 
178     public java.lang.String getUserTasksXml(long instanceId,
179         java.lang.String taskName, java.lang.String definitionName,
180         java.lang.String assignedTo, java.lang.String createDateGT,
181         java.lang.String createDateLT, java.lang.String startDateGT,
182         java.lang.String startDateLT, java.lang.String endDateGT,
183         java.lang.String endDateLT, boolean hideEndedTasks,
184         boolean andOperator, int start, int end)
185         throws java.rmi.RemoteException,
186             com.liferay.portal.kernel.jbi.WorkflowComponentException;
187 
188     public void signalInstance(long instanceId)
189         throws java.rmi.RemoteException,
190             com.liferay.portal.kernel.jbi.WorkflowComponentException;
191 
192     public void signalToken(long instanceId, long tokenId)
193         throws java.rmi.RemoteException,
194             com.liferay.portal.kernel.jbi.WorkflowComponentException;
195 
196     public java.lang.String startWorkflow(long definitionId)
197         throws java.rmi.RemoteException,
198             com.liferay.portal.kernel.jbi.WorkflowComponentException;
199 
200     public java.util.Map updateTask(long taskId, java.lang.String transition,
201         java.util.Map parameterMap)
202         throws java.rmi.RemoteException,
203             com.liferay.portal.kernel.jbi.WorkflowComponentException;
204 
205     public java.lang.String updateTaskXml(long taskId,
206         java.lang.String transition, java.util.Map parameterMap)
207         throws java.rmi.RemoteException,
208             com.liferay.portal.kernel.jbi.WorkflowComponentException;
209 }