10:24 p.m.
Author: alex.guizar(a)jboss.com
Date: 2008-12-03 23:24:58 -0500 (Wed, 03 Dec 2008)
New Revision: 3186
Modified:
jbpm4/trunk/modules/api/src/main/java/org/jbpm/TaskService.java
jbpm4/trunk/modules/task/src/main/java/org/jbpm/task/cmd/CreateTask.java
jbpm4/trunk/modules/task/src/main/java/org/jbpm/task/impl/TaskImpl.java
jbpm4/trunk/modules/task/src/main/java/org/jbpm/task/impl/TaskServiceImpl.java
jbpm4/trunk/modules/task/src/test/java/org/jbpm/task/TaskTest.java
Log:
JBPM-1858: task service javadoc, task creation
Modified: jbpm4/trunk/modules/api/src/main/java/org/jbpm/TaskService.java
===================================================================
--- jbpm4/trunk/modules/api/src/main/java/org/jbpm/TaskService.java 2008-12-03 20:28:52
UTC (rev 3185)
+++ jbpm4/trunk/modules/api/src/main/java/org/jbpm/TaskService.java 2008-12-04 04:24:58
UTC (rev 3186)
@@ -26,14 +26,32 @@
import org.jbpm.task.Role;
import org.jbpm.task.Task;
+/**
+ * Human task management facility.
+ * @author Alejandro Guizar
+ */
public interface TaskService {
+ /** Creates a task with the given identifier.
+ * The returned task will be transient.
+ * Use {@link #updateTask(Task)} to persist the task. */
Task newTask(String taskId);
+
+ /** Retrieves the task with the given identifier from persistent storage.
+ * If no task with the given identifier exists,
+ * the call returns <code>null</code>. */
Task getTask(String taskId);
+
+ /** Saves the given task to persistent storage. */
void updateTask(Task task);
+
+ /** Marks the task with the given identifier as completed.
+ * This operation may result in a process instance being resumed. */
void submitTask(String taskId);
+
+ /** Removes the task with the given identifier from persistent storage. */
void deleteTask(String taskId);
-
+
List<String> getCandidates(String taskId);
List<Role> getRoles(String taskId);
@@ -41,7 +59,7 @@
* then the current authenticated user. E.g. when a manager wants to
* look at a subordinate's task list. */
List<Task> getPersonalTaskList(String userId, int firstResult, int maxResults);
-
+
/** retrieves the group task of the given user.
* The user id will be resolved to a set of candidate identities
* by the identity spi. */
Modified: jbpm4/trunk/modules/task/src/main/java/org/jbpm/task/cmd/CreateTask.java
===================================================================
--- jbpm4/trunk/modules/task/src/main/java/org/jbpm/task/cmd/CreateTask.java 2008-12-03
20:28:52 UTC (rev 3185)
+++ jbpm4/trunk/modules/task/src/main/java/org/jbpm/task/cmd/CreateTask.java 2008-12-04
04:24:58 UTC (rev 3186)
@@ -36,18 +36,25 @@
public class CreateTask implements Command<Task> {
private static final long serialVersionUID = 1L;
-
+
+ protected String taskId;
protected Long taskDefinitionDbid;
protected Long executionDbid;
public CreateTask() {
}
- public CreateTask(long taskDefinitionDbid) {
+ public CreateTask(String taskId) {
+ this.taskId = taskId;
+ }
+
+ public CreateTask(String taskId, long taskDefinitionDbid) {
+ this.taskId = taskId;
this.taskDefinitionDbid = taskDefinitionDbid;
}
- public CreateTask(long taskDefinitionDbid, long executionDbid) {
+ public CreateTask(String taskId, long taskDefinitionDbid, long executionDbid) {
+ this.taskId = taskId;
this.taskDefinitionDbid = taskDefinitionDbid;
this.executionDbid = executionDbid;
}
@@ -68,11 +75,11 @@
Task task = null;
if (taskDefinition==null) {
- task = TaskImpl.create();
+ task = TaskImpl.create(taskId);
} else if (execution==null) {
- task = TaskImpl.create(taskDefinition);
+ task = TaskImpl.create(taskId, taskDefinition);
} else {
- task = TaskImpl.create(taskDefinition, execution);
+ task = TaskImpl.create(taskId, taskDefinition, execution);
}
return task;
Modified: jbpm4/trunk/modules/task/src/main/java/org/jbpm/task/impl/TaskImpl.java
===================================================================
--- jbpm4/trunk/modules/task/src/main/java/org/jbpm/task/impl/TaskImpl.java 2008-12-03
20:28:52 UTC (rev 3185)
+++ jbpm4/trunk/modules/task/src/main/java/org/jbpm/task/impl/TaskImpl.java 2008-12-04
04:24:58 UTC (rev 3186)
@@ -96,15 +96,15 @@
// creating a task
- public static TaskImpl create() {
- return create(null, null);
+ public static TaskImpl create(String taskId) {
+ return create(taskId, null, null);
}
-
- public static TaskImpl create(TaskDefinitionImpl taskDefinition) {
- return create(taskDefinition, null);
+
+ public static TaskImpl create(String taskId, TaskDefinitionImpl taskDefinition) {
+ return create(taskId, taskDefinition, null);
}
- public static TaskImpl create(TaskDefinitionImpl taskDefinition, ExecutionImpl
execution) {
+ public static TaskImpl create(String taskId, TaskDefinitionImpl taskDefinition,
ExecutionImpl execution) {
TaskImpl task = null;
// if a task class name is configured
Environment environment = Environment.getCurrent();
@@ -122,6 +122,7 @@
task.create = Clock.getCurrentTime();
+ task.setId(taskId);
task.setTaskDefinition(taskDefinition);
task.setExecution(execution);
@@ -254,7 +255,7 @@
public Set<Task> getSubTasks() {
if (subTasks==null) {
- return Collections.EMPTY_SET;
+ return Collections.emptySet();
}
return (Set) subTasks;
}
@@ -269,14 +270,14 @@
return subtask;
}
- public Task createSubTask(TaskDefinition subtaskDefinition) {
- if (subtaskDefinition==null) {
+ public Task createSubTask(String subTaskId, TaskDefinition subTaskDefinition) {
+ if (subTaskDefinition==null) {
throw new TaskException("subtaskDefinition is null");
}
if (subTasks==null) {
subTasks = new HashSet<TaskImpl>();
}
- TaskImpl subtask = create(taskDefinition);
+ TaskImpl subtask = create(subTaskId, taskDefinition);
addSubTask(subtask);
return subtask;
}
Modified: jbpm4/trunk/modules/task/src/main/java/org/jbpm/task/impl/TaskServiceImpl.java
===================================================================
---
jbpm4/trunk/modules/task/src/main/java/org/jbpm/task/impl/TaskServiceImpl.java 2008-12-03
20:28:52 UTC (rev 3185)
+++
jbpm4/trunk/modules/task/src/main/java/org/jbpm/task/impl/TaskServiceImpl.java 2008-12-04
04:24:58 UTC (rev 3186)
@@ -28,11 +28,8 @@
import org.jbpm.task.Role;
import org.jbpm.task.Task;
import org.jbpm.task.cmd.CreateTask;
-import org.jbpm.task.cmd.DeleteTask;
-import org.jbpm.task.cmd.GetTask;
import org.jbpm.task.cmd.UpdateTask;
-
/**
* @author Tom Baeyens
*/
@@ -47,42 +44,10 @@
this.commandService = commandService;
}
- public Task createTask() {
- return (Task) commandService.execute(new CreateTask());
- }
-
- public Task createTask(long taskDefinitionDbid) {
- return (Task) commandService.execute(new CreateTask(taskDefinitionDbid));
- }
-
- public Task createTask(long taskDefinitionDbid, long executionDbid) {
- return (Task) commandService.execute(new CreateTask(taskDefinitionDbid,
executionDbid));
- }
-
- public void deleteTask(long taskDbid) {
- commandService.execute(new DeleteTask(taskDbid));
- }
-
- public Task getTask(long taskDbid) {
- return (Task) commandService.execute(new GetTask(taskDbid));
- }
-
public void updateTask(Task task) {
commandService.execute(new UpdateTask(task));
}
- public List<Task> getGroupTaskListPage(List<String> identityIds, int
firstResult, int maxResults) {
- throw new UnsupportedOperationException("TODO");
- }
-
- public List<Task> getPersonalTaskListPage(int firstResult, int maxResults) {
- throw new UnsupportedOperationException("TODO");
- }
-
- public List<Task> getPersonalTaskListPage(String userId, int firstResult, int
maxResults) {
- throw new UnsupportedOperationException("TODO");
- }
-
public CommandService getCommandService() {
return commandService;
}
@@ -95,16 +60,6 @@
}
- public List<Task> getGroupTaskList(List<String> identityIds, int
firstResult, int maxResults) {
- // TODO Auto-generated method stub
- return null;
- }
-
- public List<Task> getPersonalTaskList(int firstResult, int maxResults) {
- // TODO Auto-generated method stub
- return null;
- }
-
public List<Task> getPersonalTaskList(String userId, int firstResult, int
maxResults) {
// TODO Auto-generated method stub
return null;
@@ -116,8 +71,7 @@
}
public Task newTask(String taskId) {
- // TODO Auto-generated method stub
- return null;
+ return commandService.execute(new CreateTask(taskId));
}
public void submitTask(String taskId) {
Modified: jbpm4/trunk/modules/task/src/test/java/org/jbpm/task/TaskTest.java
===================================================================
--- jbpm4/trunk/modules/task/src/test/java/org/jbpm/task/TaskTest.java 2008-12-03 20:28:52
UTC (rev 3185)
+++ jbpm4/trunk/modules/task/src/test/java/org/jbpm/task/TaskTest.java 2008-12-04 04:24:58
UTC (rev 3186)
@@ -23,19 +23,13 @@
import java.util.Date;
import java.util.HashMap;
-import java.util.HashSet;
-import java.util.List;
import java.util.Map;
import java.util.Set;
-import org.jbpm.env.Environment;
-import org.jbpm.env.EnvironmentFactory;
-import org.jbpm.model.Comment;
import org.jbpm.pvm.internal.util.Clock;
import org.jbpm.pvm.internal.util.Priority;
import org.jbpm.task.impl.RoleImpl;
import org.jbpm.task.impl.SwimlaneImpl;
-import org.jbpm.task.impl.TaskDefinitionImpl;
import org.jbpm.task.impl.TaskImpl;
import org.jbpm.test.JbpmTestCase;
@@ -51,7 +45,7 @@
TaskImpl task;
try {
Clock.setCurrentTime(now);
- task = TaskImpl.create();
+ task = TaskImpl.create(getName());
} finally {
Clock.setCurrentTime(null);
}
@@ -68,13 +62,13 @@
}
public void testTaskAssignment() {
- TaskImpl task = TaskImpl.create();
+ TaskImpl task = TaskImpl.create(getName());
task.setAssignee("john doe");
assertEquals("john doe", task.getAssignee());
}
public void testTaskReassignmentAssignment() {
- TaskImpl task = TaskImpl.create();
+ TaskImpl task = TaskImpl.create(getName());
task.setAssignee("johndoe");
assertEquals("johndoe", task.getAssignee());
task.setAssignee("joesmoe");
@@ -82,7 +76,7 @@
}
public void testTaskRoles() {
- TaskImpl task = TaskImpl.create();
+ TaskImpl task = TaskImpl.create(getName());
assertNotNull(task.getRoles());
assertEquals(0, task.getRoles().size());
@@ -129,7 +123,7 @@
}
public void testTaskAllRoles() {
- TaskImpl task = TaskImpl.create();
+ TaskImpl task = TaskImpl.create(getName());
assertNotNull(task.getAllRoles());
assertEquals(0, task.getAllRoles().size());