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