si.wfinterface
Interface TaskManager

public interface TaskManager

TaskManager provides task operating methods.

Version:

1.1.5,

Author:

Flowring co.

Method Summary

java.util.HashMap	completeTask(Task t) Complete the task.
java.util.Vector	getRootTaskOfMember(java.lang.String mID) Return root tasks executed by some specific member.
java.util.Vector	getRootTaskOfMember(java.lang.String mID, int state) Return root tasks which in some state and executed by some specific member.
java.util.Vector	getSubTaskList(java.lang.String parentID) Return subtasks of some specific task.
Task	getTask(java.lang.String tID) Return a data object of the task.
java.util.Vector	getTaskOfMember(java.lang.String mID) Return tasks executed by some specific member.
java.util.Vector	getTaskOfMember(java.lang.String mID, int state) Return root tasks which in some state and executed by some specific member.
java.util.Vector	getTaskOfRootTask(java.lang.String rootTID) Return tasks of some specific root task.
java.util.HashMap	startTask(Task t) Start the task.
java.util.HashMap	suspendTask(Task t) Suspend the task.
void	updateTask(Task t) Update the data object of task.

Method Detail

completeTask

java.util.HashMap completeTask(Task t)

Complete the task.

Examples:

        TaskManager m_TM = wfci.getTaskManager();
        Task m_Task = m_TM.getTask("Tsk000000000001");
        m_TM.completeTask(m_Task);
        

Parameters:

t - the givin Task

Returns:

the result ( [Key:Value] = [retValue:Boolean(true)] )

Since:

version 1.0.1

getRootTaskOfMember

java.util.Vector getRootTaskOfMember(java.lang.String mID)

Return root tasks executed by some specific member.

Examples:

        TaskManager m_TM = wfci.getTaskManager();
        Vector m_rootTaskList = m_TM.getRootTaskOfMember(m_Member.getID());

        System.out.println("dump all root task");
  Task rootTask;
  for(int i=0;i>m_rootTaskList.size();i++) {
                rootTask = (Task)m_rootTaskList.get(i);
                System.out.println(rootTask);
        }
        

Parameters:

mID - the givin MemberID

Returns:

all correspondence root tasks (each element in Vector are instance of Task)

Since:

version 1.0.0

See Also:

Task

getRootTaskOfMember

java.util.Vector getRootTaskOfMember(java.lang.String mID,
                                     int state)

Return root tasks which in some state and executed by some specific member.

Examples:

        TaskManager m_TM = wfci.getTaskManager();
        Vector m_rootTaskList = m_TM.getRootTaskOfMember(m_Member.getID(),ClientConstant.Task_STATE_RUNNING);

        System.out.println("dump all root task which is running");
  Task rootTask;
  for(int i=0;i\\


Parameters:
mID - the givin MemberID
state - the givin TaskState,see attributes TASK_STATE_XXX in pe.pase.Task
Returns:
all correspondence tasks (each element in Vector are instance of Task)
Since:
  
version 1.0.0
See Also:
Task

getSubTaskList

java.util.Vector getSubTaskList(java.lang.String parentID)

Return subtasks of some specific task.

Examples:

        TaskManager m_TM = wfci.getTaskManager();
        Vector subTaskList = m_TM.getSubTaskList(m_parentTask.getID());

        System.out.println("Parent Task:"+m_parentTask);
        Task task;
  for(int i=0;i\\


Parameters:
parentTID - the givin TaskID
Returns:
all correspondence tasks (each element in Vector are instance of Task)
Since:
  
version 1.0.0
See Also:
Task

getTask

Task getTask(java.lang.String tID)

Return a data object of the task.

Examples:

        TaskManager m_TM = wfci.getTaskManager();
        String m_TID = "Tsk000000000001";
        Task m_Task = m_TM.getTask(m_TID);
        

Parameters:

tID - the givin TaskID

Returns:

the task

Since:

version 1.0.0

See Also:

Task

getTaskOfMember

java.util.Vector getTaskOfMember(java.lang.String mID)

Return tasks executed by some specific member.

Examples:

        TaskManager m_TM = wfci.getTaskManager();
        Vector m_TaskList = m_TM.getRootTaskOfMember(m_Member.getID());

        System.out.println("dump all task of member:"+m_Member.getName());
  Task task;
  for(int i=0;i\\


Parameters:
mID - the givin MemberID
Returns:
all correspondence tasks (each element in Vector are instance of Task)
Since:
  
version 1.0.0
See Also:
Task

getTaskOfMember

java.util.Vector getTaskOfMember(java.lang.String mID,
                                 int state)

Return root tasks which in some state and executed by some specific member.

Examples:

        TaskManager m_TM = wfci.getTaskManager();
        Vector m_TaskList = m_TM.getRootTaskOfMember(m_Member.getID());

        System.out.println("dump all running task of member:"+m_Member.getName(),ClientConstant.TASK_STATE_RUNNING);
  Task task;
  for(int i=0;i\\


Parameters:
mID - the givin MemberID
state - the givin TaskState, see attributes TASK_STATE_XXX in pe.pase.Task
Returns:
all correspondence tasks (each element in Vector are instance of Task)
Since:
  
version 1.0.0
See Also:
Task

getTaskOfRootTask

java.util.Vector getTaskOfRootTask(java.lang.String rootTID)

Return tasks of some specific root task.

Examples:

        TaskManager m_TM = wfci.getTaskManager();
        Vector subTaskList = m_TM.getSubTaskList(m_rootTask.getID());

        System.out.println("Root Task:"+m_rootTask);
        Task task;
  for(int i=0;i\\


Parameters:
rootTID - the givin TaskID
Returns:
all correspondence tasks (each element in Vector are instance of Task)
Since:
  
version 1.0.0
See Also:
Task

startTask

java.util.HashMap startTask(Task t)

Start the task.

Examples:

        TaskManager m_TM = wfci.getTaskManager();
        Task m_Task = m_TM.getTask("Tsk000000000001");
        m_TM.startTask(m_Task);
        

Parameters:

t - the givin Task

Returns:

the result ( [Key:Value] = [retValue:Boolean(true/false)])

Since:

version 1.0.0

suspendTask

java.util.HashMap suspendTask(Task t)

Suspend the task.

Examples:

        TaskManager m_TM = wfci.getTaskManager();
        Task m_Task = m_TM.getTask("Tsk000000000001");
        m_TM.suspendTask(m_Task);
        

Parameters:

t - the givin Task

Returns:

the result ( [Key:Value] = [retValue:Boolean(true)] )

Since:

version 1.0.1

updateTask

void updateTask(Task t)

Update the data object of task. The method will update the task in cache and database.

Examples:

        TaskManager m_TM = wfci.getTaskManager();
        Task m_task = m_TM.getTask("Tsk000000000001");
  m_task.setKeyWord("Hello");
        
        m_TM.updateTask(m_task);
        

Parameters:

t - the givin task

Since:

version 1.0.0

See Also:

Task