1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   *
12   *
13   */
14  
15  package com.liferay.portal.kernel.jbi;
16  
17  import java.util.List;
18  import java.util.Map;
19  
20  /**
21   * <a href="WorkflowComponent.java.html"><b><i>View Source</i></b></a>
22   *
23   * @author Charles May
24   */
25  public interface WorkflowComponent {
26  
27      public String deploy(String xml) throws WorkflowComponentException;
28  
29      public List getCurrentTasks(long instanceId, long tokenId)
30          throws WorkflowComponentException;
31  
32      public String getCurrentTasksXml(long instanceId, long tokenId)
33          throws WorkflowComponentException;
34  
35      public Object getDefinition(long definitionId)
36          throws WorkflowComponentException;
37  
38      public List getDefinitions(
39              long definitionId, String name, int start, int end)
40          throws WorkflowComponentException;
41  
42      public String getDefinitionsXml(
43              long definitionId, String name, int start, int end)
44          throws WorkflowComponentException;
45  
46      public int getDefinitionsCount(long definitionId, String name)
47          throws WorkflowComponentException;
48  
49      public String getDefinitionsCountXml(long definitionId, String name)
50          throws WorkflowComponentException;
51  
52      public String getDefinitionXml(long definitionId)
53          throws WorkflowComponentException;
54  
55      public List getInstances(
56              long definitionId, long instanceId, String definitionName,
57              String definitionVersion, String startDateGT, String startDateLT,
58              String endDateGT, String endDateLT, boolean hideEndedTasks,
59              boolean retrieveUserInstances, boolean andOperator, int start,
60              int end)
61          throws WorkflowComponentException;
62  
63      public int getInstancesCount(
64              long definitionId, long instanceId, String definitionName,
65              String definitionVersion, String startDateGT, String startDateLT,
66              String endDateGT, String endDateLT, boolean hideEndedTasks,
67              boolean retrieveUserInstances, boolean andOperator)
68          throws WorkflowComponentException;
69  
70      public String getInstancesCountXml(
71              long definitionId, long instanceId, String definitionName,
72              String definitionVersion, String startDateGT, String startDateLT,
73              String endDateGT, String endDateLT, boolean hideEndedTasks,
74              boolean retrieveUserInstances, boolean andOperator)
75          throws WorkflowComponentException;
76  
77      public String getInstancesXml(
78              long definitionId, long instanceId, String definitionName,
79              String definitionVersion, String startDateGT, String startDateLT,
80              String endDateGT, String endDateLT, boolean hideEndedTasks,
81              boolean retrieveUserInstances, boolean andOperator, int start,
82              int end)
83          throws WorkflowComponentException;
84  
85      public List getTaskFormElements(long taskId)
86          throws WorkflowComponentException;
87  
88      public String getTaskFormElementsXml(long taskId)
89          throws WorkflowComponentException;
90  
91      public List getTaskTransitions(long taskId)
92          throws WorkflowComponentException;
93  
94      public String getTaskTransitionsXml(long taskId)
95          throws WorkflowComponentException;
96  
97      public List getUserTasks(
98              long instanceId, String taskName, String definitionName,
99              String assignedTo, String createDateGT, String createDateLT,
100             String startDateGT, String startDateLT, String endDateGT,
101             String endDateLT, boolean hideEndedTasks, boolean andOperator,
102             int start, int end)
103         throws WorkflowComponentException;
104 
105     public int getUserTasksCount(
106             long instanceId, String taskName, String definitionName,
107             String assignedTo, String createDateGT, String createDateLT,
108             String startDateGT, String startDateLT, String endDateGT,
109             String endDateLT, boolean hideEndedTasks, boolean andOperator)
110         throws WorkflowComponentException;
111 
112     public String getUserTasksCountXml(
113             long instanceId, String taskName, String definitionName,
114             String assignedTo, String createDateGT, String createDateLT,
115             String startDateGT, String startDateLT, String endDateGT,
116             String endDateLT, boolean hideEndedTasks, boolean andOperator)
117         throws WorkflowComponentException;
118 
119     public String getUserTasksXml(
120             long instanceId, String taskName, String definitionName,
121             String assignedTo, String createDateGT, String createDateLT,
122             String startDateGT, String startDateLT, String endDateGT,
123             String endDateLT, boolean hideEndedTasks, boolean andOperator,
124             int start, int end)
125         throws WorkflowComponentException;
126 
127     public void signalInstance(long instanceId)
128         throws WorkflowComponentException;
129 
130     public void signalToken(long instanceId, long tokenId)
131         throws WorkflowComponentException;
132 
133     public String startWorkflow(long definitionId)
134         throws WorkflowComponentException;
135 
136     public Map updateTask(long taskId, String transition, Map parameterMap)
137         throws WorkflowComponentException;
138 
139     public String updateTaskXml(
140             long taskId, String transition, Map parameterMap)
141         throws WorkflowComponentException;
142 
143 }