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.WorkflowComponentServiceFactory
48   * @see com.liferay.portlet.workflow.service.WorkflowComponentServiceUtil
49   *
50   */
51  public interface WorkflowComponentService {
52      public java.util.List getCurrentTasks(long instanceId, long tokenId)
53          throws java.rmi.RemoteException,
54              com.liferay.portal.kernel.jbi.WorkflowComponentException;
55  
56      public java.lang.String getCurrentTasksXml(long instanceId, long tokenId)
57          throws java.rmi.RemoteException,
58              com.liferay.portal.kernel.jbi.WorkflowComponentException;
59  
60      public java.lang.String deploy(java.lang.String xml)
61          throws java.rmi.RemoteException,
62              com.liferay.portal.kernel.jbi.WorkflowComponentException;
63  
64      public java.lang.Object getDefinition(long definitionId)
65          throws java.rmi.RemoteException,
66              com.liferay.portal.kernel.jbi.WorkflowComponentException;
67  
68      public java.util.List getDefinitions(long definitionId,
69          java.lang.String name, int begin, int end)
70          throws java.rmi.RemoteException,
71              com.liferay.portal.kernel.jbi.WorkflowComponentException;
72  
73      public java.lang.String getDefinitionsXml(long definitionId,
74          java.lang.String name, int begin, int end)
75          throws java.rmi.RemoteException,
76              com.liferay.portal.kernel.jbi.WorkflowComponentException;
77  
78      public int getDefinitionsCount(long definitionId, java.lang.String name)
79          throws java.rmi.RemoteException,
80              com.liferay.portal.kernel.jbi.WorkflowComponentException;
81  
82      public java.lang.String getDefinitionsCountXml(long definitionId,
83          java.lang.String name)
84          throws java.rmi.RemoteException,
85              com.liferay.portal.kernel.jbi.WorkflowComponentException;
86  
87      public java.lang.String getDefinitionXml(long definitionId)
88          throws java.rmi.RemoteException,
89              com.liferay.portal.kernel.jbi.WorkflowComponentException;
90  
91      public java.util.List getInstances(long definitionId, long instanceId,
92          java.lang.String definitionName, java.lang.String definitionVersion,
93          java.lang.String startDateGT, java.lang.String startDateLT,
94          java.lang.String endDateGT, java.lang.String endDateLT,
95          boolean hideEndedTasks, boolean retrieveUserInstances,
96          boolean andOperator, int begin, int end)
97          throws java.rmi.RemoteException,
98              com.liferay.portal.kernel.jbi.WorkflowComponentException;
99  
100     public int getInstancesCount(long definitionId, long instanceId,
101         java.lang.String definitionName, java.lang.String definitionVersion,
102         java.lang.String startDateGT, java.lang.String startDateLT,
103         java.lang.String endDateGT, java.lang.String endDateLT,
104         boolean hideEndedTasks, boolean retrieveUserInstances,
105         boolean andOperator)
106         throws java.rmi.RemoteException,
107             com.liferay.portal.kernel.jbi.WorkflowComponentException;
108 
109     public java.lang.String getInstancesCountXml(long definitionId,
110         long instanceId, java.lang.String definitionName,
111         java.lang.String definitionVersion, java.lang.String startDateGT,
112         java.lang.String startDateLT, java.lang.String endDateGT,
113         java.lang.String endDateLT, boolean hideEndedTasks,
114         boolean retrieveUserInstances, boolean andOperator)
115         throws java.rmi.RemoteException,
116             com.liferay.portal.kernel.jbi.WorkflowComponentException;
117 
118     public java.lang.String getInstancesXml(long definitionId, long instanceId,
119         java.lang.String definitionName, java.lang.String definitionVersion,
120         java.lang.String startDateGT, java.lang.String startDateLT,
121         java.lang.String endDateGT, java.lang.String endDateLT,
122         boolean hideEndedTasks, boolean retrieveUserInstances,
123         boolean andOperator, int begin, int end)
124         throws java.rmi.RemoteException,
125             com.liferay.portal.kernel.jbi.WorkflowComponentException;
126 
127     public com.liferay.portlet.workflow.model.WorkflowTask getTask(long taskId)
128         throws java.rmi.RemoteException,
129             com.liferay.portal.kernel.jbi.WorkflowComponentException;
130 
131     public java.lang.String getTaskXml(long taskId)
132         throws java.rmi.RemoteException,
133             com.liferay.portal.kernel.jbi.WorkflowComponentException;
134 
135     public java.util.List getTaskFormElements(long taskId)
136         throws java.rmi.RemoteException,
137             com.liferay.portal.kernel.jbi.WorkflowComponentException;
138 
139     public java.lang.String getTaskFormElementsXml(long taskId)
140         throws java.rmi.RemoteException,
141             com.liferay.portal.kernel.jbi.WorkflowComponentException;
142 
143     public java.util.List getTaskTransitions(long taskId)
144         throws java.rmi.RemoteException,
145             com.liferay.portal.kernel.jbi.WorkflowComponentException;
146 
147     public java.lang.String getTaskTransitionsXml(long taskId)
148         throws java.rmi.RemoteException,
149             com.liferay.portal.kernel.jbi.WorkflowComponentException;
150 
151     public java.util.List getUserTasks(long instanceId,
152         java.lang.String taskName, java.lang.String definitionName,
153         java.lang.String assignedTo, java.lang.String createDateGT,
154         java.lang.String createDateLT, java.lang.String startDateGT,
155         java.lang.String startDateLT, java.lang.String endDateGT,
156         java.lang.String endDateLT, boolean hideEndedTasks,
157         boolean andOperator, int begin, int end)
158         throws java.rmi.RemoteException,
159             com.liferay.portal.kernel.jbi.WorkflowComponentException;
160 
161     public int getUserTasksCount(long instanceId, java.lang.String taskName,
162         java.lang.String definitionName, java.lang.String assignedTo,
163         java.lang.String createDateGT, java.lang.String createDateLT,
164         java.lang.String startDateGT, java.lang.String startDateLT,
165         java.lang.String endDateGT, java.lang.String endDateLT,
166         boolean hideEndedTasks, boolean andOperator)
167         throws java.rmi.RemoteException,
168             com.liferay.portal.kernel.jbi.WorkflowComponentException;
169 
170     public java.lang.String getUserTasksCountXml(long instanceId,
171         java.lang.String taskName, java.lang.String definitionName,
172         java.lang.String assignedTo, java.lang.String createDateGT,
173         java.lang.String createDateLT, java.lang.String startDateGT,
174         java.lang.String startDateLT, java.lang.String endDateGT,
175         java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator)
176         throws java.rmi.RemoteException,
177             com.liferay.portal.kernel.jbi.WorkflowComponentException;
178 
179     public java.lang.String getUserTasksXml(long instanceId,
180         java.lang.String taskName, java.lang.String definitionName,
181         java.lang.String assignedTo, java.lang.String createDateGT,
182         java.lang.String createDateLT, java.lang.String startDateGT,
183         java.lang.String startDateLT, java.lang.String endDateGT,
184         java.lang.String endDateLT, boolean hideEndedTasks,
185         boolean andOperator, int begin, int end)
186         throws java.rmi.RemoteException,
187             com.liferay.portal.kernel.jbi.WorkflowComponentException;
188 
189     public void signalInstance(long instanceId)
190         throws java.rmi.RemoteException,
191             com.liferay.portal.kernel.jbi.WorkflowComponentException;
192 
193     public void signalToken(long instanceId, long tokenId)
194         throws java.rmi.RemoteException,
195             com.liferay.portal.kernel.jbi.WorkflowComponentException;
196 
197     public java.lang.String startWorkflow(long definitionId)
198         throws java.rmi.RemoteException,
199             com.liferay.portal.kernel.jbi.WorkflowComponentException;
200 
201     public java.util.Map updateTask(long taskId, java.lang.String transition,
202         java.util.Map parameterMap)
203         throws java.rmi.RemoteException,
204             com.liferay.portal.kernel.jbi.WorkflowComponentException;
205 
206     public java.lang.String updateTaskXml(long taskId,
207         java.lang.String transition, java.util.Map parameterMap)
208         throws java.rmi.RemoteException,
209             com.liferay.portal.kernel.jbi.WorkflowComponentException;
210 }