001: /**
002: * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
003: *
004: * Permission is hereby granted, free of charge, to any person obtaining a copy
005: * of this software and associated documentation files (the "Software"), to deal
006: * in the Software without restriction, including without limitation the rights
007: * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
008: * copies of the Software, and to permit persons to whom the Software is
009: * furnished to do so, subject to the following conditions:
010: *
011: * The above copyright notice and this permission notice shall be included in
012: * all copies or substantial portions of the Software.
013: *
014: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
015: * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
016: * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
017: * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
018: * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
019: * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
020: * SOFTWARE.
021: */package com.liferay.portal.kernel.jbi;
022:
023: import java.util.List;
024: import java.util.Map;
025:
026: /**
027: * <a href="WorkflowComponent.java.html"><b><i>View Source</i></b></a>
028: *
029: * @author Charles May
030: *
031: */
032: public interface WorkflowComponent {
033:
034: public String deploy(String xml) throws WorkflowComponentException;
035:
036: public List getCurrentTasks(long instanceId, long tokenId)
037: throws WorkflowComponentException;
038:
039: public String getCurrentTasksXml(long instanceId, long tokenId)
040: throws WorkflowComponentException;
041:
042: public Object getDefinition(long definitionId)
043: throws WorkflowComponentException;
044:
045: public List getDefinitions(long definitionId, String name,
046: int begin, int end) throws WorkflowComponentException;
047:
048: public String getDefinitionsXml(long definitionId, String name,
049: int begin, int end) throws WorkflowComponentException;
050:
051: public int getDefinitionsCount(long definitionId, String name)
052: throws WorkflowComponentException;
053:
054: public String getDefinitionsCountXml(long definitionId, String name)
055: throws WorkflowComponentException;
056:
057: public String getDefinitionXml(long definitionId)
058: throws WorkflowComponentException;
059:
060: public List getInstances(long definitionId, long instanceId,
061: String definitionName, String definitionVersion,
062: String startDateGT, String startDateLT, String endDateGT,
063: String endDateLT, boolean hideEndedTasks,
064: boolean retrieveUserInstances, boolean andOperator,
065: int begin, int end) throws WorkflowComponentException;
066:
067: public int getInstancesCount(long definitionId, long instanceId,
068: String definitionName, String definitionVersion,
069: String startDateGT, String startDateLT, String endDateGT,
070: String endDateLT, boolean hideEndedTasks,
071: boolean retrieveUserInstances, boolean andOperator)
072: throws WorkflowComponentException;
073:
074: public String getInstancesCountXml(long definitionId,
075: long instanceId, String definitionName,
076: String definitionVersion, String startDateGT,
077: String startDateLT, String endDateGT, String endDateLT,
078: boolean hideEndedTasks, boolean retrieveUserInstances,
079: boolean andOperator) throws WorkflowComponentException;
080:
081: public String getInstancesXml(long definitionId, long instanceId,
082: String definitionName, String definitionVersion,
083: String startDateGT, String startDateLT, String endDateGT,
084: String endDateLT, boolean hideEndedTasks,
085: boolean retrieveUserInstances, boolean andOperator,
086: int begin, int end) throws WorkflowComponentException;
087:
088: public List getTaskFormElements(long taskId)
089: throws WorkflowComponentException;
090:
091: public String getTaskFormElementsXml(long taskId)
092: throws WorkflowComponentException;
093:
094: public List getTaskTransitions(long taskId)
095: throws WorkflowComponentException;
096:
097: public String getTaskTransitionsXml(long taskId)
098: throws WorkflowComponentException;
099:
100: public List getUserTasks(long instanceId, String taskName,
101: String definitionName, String assignedTo,
102: String createDateGT, String createDateLT,
103: String startDateGT, String startDateLT, String endDateGT,
104: String endDateLT, boolean hideEndedTasks,
105: boolean andOperator, int begin, int end)
106: throws WorkflowComponentException;
107:
108: public int getUserTasksCount(long instanceId, String taskName,
109: String definitionName, String assignedTo,
110: String createDateGT, String createDateLT,
111: String startDateGT, String startDateLT, String endDateGT,
112: String endDateLT, boolean hideEndedTasks,
113: boolean andOperator) throws WorkflowComponentException;
114:
115: public String getUserTasksCountXml(long instanceId,
116: String taskName, String definitionName, String assignedTo,
117: String createDateGT, String createDateLT,
118: String startDateGT, String startDateLT, String endDateGT,
119: String endDateLT, boolean hideEndedTasks,
120: boolean andOperator) throws WorkflowComponentException;
121:
122: public String getUserTasksXml(long instanceId, String taskName,
123: String definitionName, String assignedTo,
124: String createDateGT, String createDateLT,
125: String startDateGT, String startDateLT, String endDateGT,
126: String endDateLT, boolean hideEndedTasks,
127: boolean andOperator, int begin, int end)
128: throws WorkflowComponentException;
129:
130: public void signalInstance(long instanceId)
131: throws WorkflowComponentException;
132:
133: public void signalToken(long instanceId, long tokenId)
134: throws WorkflowComponentException;
135:
136: public String startWorkflow(long definitionId)
137: throws WorkflowComponentException;
138:
139: public Map updateTask(long taskId, String transition,
140: Map parameterMap) throws WorkflowComponentException;
141:
142: public String updateTaskXml(long taskId, String transition,
143: Map parameterMap) throws WorkflowComponentException;
144:
145: }
|