Oracle© Collaboration Suite Workspaces Web Services API Reference
10g Release 1 (10.1.2.2)

Part No. B28209-01


oracle.workspaces.ws
Interface TasksService


public interface TasksService

TasksService provides methods to operate on Tasks within a workspace.

The major operations supported include : creation of a task in the workspace agenda ,updation of a task, retrieval of task(s), listing of all, expired and unexpired tasks in a workspace and deletion of tasks


Method Summary
 TaskResourceItem createTask(java.lang.String wspcId, TaskDefinition taskDef)
          Creates a to-do task in the workspace agenda and returns it
 void deleteTasks(java.lang.String wspcId, java.lang.String[] taskIds)
          Deletes tasks in the workspace agenda.
 TaskResourceItem[] getMyTasks(java.lang.String wspcId)
          Get all tasks that are assigned to the user.
 TaskResourceItem getTaskByUid(java.lang.String wspcId, java.lang.String taskId)
          Get a to-do task in the workspace agenda by its id.
 TaskResourceItem[] listAllCompletedTasks(java.lang.String wspcId, boolean bSort)
          Get all completed tasks in this workspace agenda.
 TaskResourceItem[] listAllIncompleteTasks(java.lang.String wspcId, boolean bSort)
          Get all incomplete tasks in this workspace agenda.
 TaskResourceItem[] listAllTasks(java.lang.String wspcId, boolean bSort)
          Get all tasks in this workspace agenda.
 TaskResourceItem[] listTasksByRange(java.lang.String wspcId, java.util.Calendar beginDate, java.util.Calendar endDate, boolean bSort)
          Get tasks in workspace agenda that occur within the time range specified.
 void updateTask(java.lang.String wspcId, TaskResourceItem taskResourceItem)
          Store the properties of the task

 

Method Detail

createTask

public TaskResourceItem createTask(java.lang.String wspcId,
                                   TaskDefinition taskDef)
                            throws CwWSException
Creates a to-do task in the workspace agenda and returns it
Parameters:
wspcId - - Uid of the workspace in which the task should be created
taskDef - - The definition for the new task to be created
Returns:
TaskResourceItem - Task resource item created
Throws:
CwWSException - - If objects passed are null or invalid

deleteTasks

public void deleteTasks(java.lang.String wspcId,
                        java.lang.String[] taskIds)
                 throws CwWSException
Deletes tasks in the workspace agenda.
Parameters:
wspcId - - Uid of the workspace in which the task should be deleted
taskIds - - Uids of the tasks to be deleted
Throws:
CwWSException - - If objects passed are null or invalid

updateTask

public void updateTask(java.lang.String wspcId,
                       TaskResourceItem taskResourceItem)
                throws CwWSException
Store the properties of the task
Parameters:
wspcId - - Uid of the workspace the item belongs to
taskResourceItem - - Task Resource Item to be updated
Throws:
CwWSException - - If objects passed are null or invalid

listTasksByRange

public TaskResourceItem[] listTasksByRange(java.lang.String wspcId,
                                           java.util.Calendar beginDate,
                                           java.util.Calendar endDate,
                                           boolean bSort)
                                    throws CwWSException
Get tasks in workspace agenda that occur within the time range specified.
Parameters:
wspcId - - Uid of the workspace the tasks belong to
beginDate - - Start date for the range
endDate - - End date for the range
bSort - - Set this to true for results to be sorted in ascending order of starttime
Returns:
TaskResourceItem[] - the list of task resource items being returned
Throws:
CwWSException - - If objects passed are null or invalid

getMyTasks

public TaskResourceItem[] getMyTasks(java.lang.String wspcId)
                              throws CwWSException
Get all tasks that are assigned to the user.
Parameters:
wspcId - - Uid of the workspace the tasks belong to
Returns:
TaskResourceItem[] - the list of task resource items being returned
Throws:
CwWSException - - If objects passed are null or invalid

getTaskByUid

public TaskResourceItem getTaskByUid(java.lang.String wspcId,
                                     java.lang.String taskId)
                              throws CwWSException
Get a to-do task in the workspace agenda by its id.
Parameters:
wspcId - - Uid of the workspace the task belongs to
taskId - - Uid of the task that needs to be got
Returns:
TaskResourceItem - the task resource items being returned
Throws:
CwWSException - - If objects passed are null or invalid

listAllCompletedTasks

public TaskResourceItem[] listAllCompletedTasks(java.lang.String wspcId,
                                                boolean bSort)
                                         throws CwWSException
Get all completed tasks in this workspace agenda.
Parameters:
wspcId - - Uid of the workspace the event belongs to
bSort - - Set this to true for results to be sorted in ascending order of starttime
Returns:
TaskResourceItem[] - the list of task resource items being returned
Throws:
CwWSException - - If objects passed are null or invalid

listAllIncompleteTasks

public TaskResourceItem[] listAllIncompleteTasks(java.lang.String wspcId,
                                                 boolean bSort)
                                          throws CwWSException
Get all incomplete tasks in this workspace agenda.
Parameters:
wspcId - - Uid of the workspace the tasks belong to
bSort - - Set this to true for results to be sorted in ascending order of starttime
Returns:
TaskResourceItem[] - the list of task resource items being returned
Throws:
CwWSException

listAllTasks

public TaskResourceItem[] listAllTasks(java.lang.String wspcId,
                                       boolean bSort)
                                throws CwWSException
Get all tasks in this workspace agenda.
Parameters:
wspcId - - Uid of the workspace the tasks belong to
bSort - - Set this to true for results to be sorted in ascending order of starttime
Returns:
TaskResourceItem[] - the list of task resource items being returned
Throws:
CwWSException - - If objects passed are null or invalid

Copyright © 2001, 2006, Oracle. All rights reserved.