Skip navigation links
com.collabnet.ce.soap60.webservices.taskmgr

Interface ITaskAppSoap

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      TaskSoapDO createTask(java.lang.String sessionId, java.lang.String taskGroupId, java.lang.String title, java.lang.String description, int priority, java.lang.String userAssignedTo, java.lang.String status, java.util.Date startDate, java.util.Date endDate, int estimatedHours, int requiredHours, boolean includeWeekends)
      Creates a new task with the specified information.
      void createTaskDependency(java.lang.String sessionId, java.lang.String originTaskId, java.lang.String targetTaskId)
      Creates a task dependency.
      TaskGroupSoapDO createTaskGroup(java.lang.String sessionId, java.lang.String parentId, java.lang.String title, java.lang.String description)
      Creates a new task group.
      void deleteTask(java.lang.String sessionId, java.lang.String taskId)
      Deletes a task.
      void deleteTaskDependency(java.lang.String sessionId, java.lang.String originTaskId, java.lang.String targetTaskId)
      Deletes a task dependency.
      void deleteTaskGroup(java.lang.String sessionId, java.lang.String taskGroupId)
      Deletes a task group.
      TaskSoapList findTasks(java.lang.String sessionId, java.lang.String queryString, java.lang.String projectId, boolean searchAttachments)
      Finds a list of tasks matching a search string.
      TaskSoapList getPredecessorTaskList(java.lang.String sessionId, java.lang.String targetTaskId)
      Returns a list of tasks on which the task is dependent ("predecessors").
      TaskSoapList getSuccessorTaskList(java.lang.String sessionId, java.lang.String originTaskId)
      Returns a list of tasks which are dependent on the task ("successors").
      TaskSoapDO getTaskData(java.lang.String sessionId, java.lang.String taskId)
      Returns data associated with the specified task.
      TaskGroupSoapDO getTaskGroupData(java.lang.String sessionId, java.lang.String taskGroupId)
      Returns data associated with the specified task group.
      TaskGroupSoapList getTaskGroupList(java.lang.String sessionId, java.lang.String parentId)
      Returns a list of task groups for a project (in the correct order).
      TaskSoapList getTaskList(java.lang.String sessionId, java.lang.String containerId, SoapFilter[] filters)
      Returns a filtered list of tasks within a given project or task group.
      boolean hasTasksWithPendingChanges(java.lang.String sessionId, java.lang.String taskGroupId)
      Returns true if a folder has any items with pending changes under it.
      TaskSoapDO moveTask(java.lang.String sessionId, java.lang.String taskId, java.lang.String targetTaskGroupId)
      Moves a task.
      TaskGroupSoapDO moveTaskGroup(java.lang.String sessionId, java.lang.String taskGroupId, java.lang.String targetTaskGroupId)
      Moves a task group.
      TaskGroupSoapDO renameTaskGroup(java.lang.String sessionId, java.lang.String taskGroupId, java.lang.String newTitle)
      Renames a task group.
      void reorderTaskGroups(java.lang.String sessionId, java.lang.String parentFolderId, java.lang.String[] taskGroupIds)
      Sets a new order for the task groups (folders) in a parent folder.
      void setTaskData(java.lang.String sessionId, TaskSoapDO taskData, java.lang.String comment)
      Returns data associated with the specified task.
    • Method Detail

      • getTaskGroupList

        TaskGroupSoapList getTaskGroupList(java.lang.String sessionId,
                                           java.lang.String parentId)
                                    throws java.rmi.RemoteException
        Returns a list of task groups for a project (in the correct order).
        Parameters:
        sessionId - User session id.
        parentId - Parent task group id -or- project id for listing top-level task groups.
        Returns:
        List of task groups within the project.
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        java.rmi.RemoteException
        Since:
        4.1
      • reorderTaskGroups

        void reorderTaskGroups(java.lang.String sessionId,
                               java.lang.String parentFolderId,
                               java.lang.String[] taskGroupIds)
                        throws java.rmi.RemoteException
        Sets a new order for the task groups (folders) in a parent folder. The task groups will be listed in this new order in UI.
        Parameters:
        sessionId - User session id.
        parentFolderId - the id of the parent folder
        taskGroupIds - an array of task group ids in their new order
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        java.rmi.RemoteException
        Since:
        4.1
      • createTaskGroup

        TaskGroupSoapDO createTaskGroup(java.lang.String sessionId,
                                        java.lang.String parentId,
                                        java.lang.String title,
                                        java.lang.String description)
                                 throws java.rmi.RemoteException
        Creates a new task group.
        Parameters:
        sessionId - User session id.
        parentId - Parent task group id -or- project id under which to create the new task group.
        title - Task group title.
        description - Task group description.
        Returns:
        Newly created task group object.
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - when the a task group with the specified title already exists.
        com.collabnet.ce.soap60.fault.IllegalArgumentFault - when an argument value is invalid.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        java.rmi.RemoteException
        Since:
        4.1
      • deleteTaskGroup

        void deleteTaskGroup(java.lang.String sessionId,
                             java.lang.String taskGroupId)
                      throws java.rmi.RemoteException
        Deletes a task group.
        Parameters:
        sessionId - User session id.
        taskGroupId - Task group id.
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        java.rmi.RemoteException
        Since:
        4.1
      • getTaskList

        TaskSoapList getTaskList(java.lang.String sessionId,
                                 java.lang.String containerId,
                                 SoapFilter[] filters)
                          throws java.rmi.RemoteException
        Returns a filtered list of tasks within a given project or task group.
        Change History
        Version 4.2
        • Added additional parameter (filters) for filtering task lists.
        Parameters:
        sessionId - User session id.
        containerId - Project or task group id.
        filters - Task list filters (null will return all tasks within the container).
        Returns:
        Filtered list of tasks within the project or task group.
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.InvalidFilterFault - when the specified filters are invalid.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        java.rmi.RemoteException
        Since:
        "4.1"
      • findTasks

        TaskSoapList findTasks(java.lang.String sessionId,
                               java.lang.String queryString,
                               java.lang.String projectId,
                               boolean searchAttachments)
                        throws java.rmi.RemoteException
        Finds a list of tasks matching a search string.
        Parameters:
        sessionId - User session id.
        queryString - Query string.
        projectId - The project in which to find tasks. (if null, search all projects)
        searchAttachments - Whether to search attachments.
        Returns:
        List of tasks matching search criteria.
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified project id is invalid.
        com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the specified query string is invalid.
        java.rmi.RemoteException
        Since:
        4.1
      • getTaskGroupData

        TaskGroupSoapDO getTaskGroupData(java.lang.String sessionId,
                                         java.lang.String taskGroupId)
                                  throws java.rmi.RemoteException
        Returns data associated with the specified task group.
        Parameters:
        sessionId - User session id.
        taskGroupId - Task group id
        Returns:
        the task group data associated with the task at the given path
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        java.rmi.RemoteException
        Since:
        4.1
      • renameTaskGroup

        TaskGroupSoapDO renameTaskGroup(java.lang.String sessionId,
                                        java.lang.String taskGroupId,
                                        java.lang.String newTitle)
                                 throws java.rmi.RemoteException
        Renames a task group.
        Parameters:
        sessionId - User session id.
        taskGroupId - Task group id
        newTitle - the new title for the task group
        Returns:
        the task group data for the updated group.
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        com.collabnet.ce.soap60.fault.VersionMismatchFault - when task group data is stale.
        java.rmi.RemoteException
        Since:
        4.1
      • moveTaskGroup

        TaskGroupSoapDO moveTaskGroup(java.lang.String sessionId,
                                      java.lang.String taskGroupId,
                                      java.lang.String targetTaskGroupId)
                               throws java.rmi.RemoteException
        Moves a task group.
        Parameters:
        sessionId - User session id.
        taskGroupId - The id of the task group to move.
        targetTaskGroupId - the id of the target group.
        Returns:
        the task group data for the updated group.
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        com.collabnet.ce.soap60.fault.IllegalArgumentFault - on an illegal destination path
        java.rmi.RemoteException
        Since:
        4.1
      • getTaskData

        TaskSoapDO getTaskData(java.lang.String sessionId,
                               java.lang.String taskId)
                        throws java.rmi.RemoteException
        Returns data associated with the specified task.
        Parameters:
        sessionId - User session id.
        taskId - Task path.
        Returns:
        the task data associated with the task at the given path
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        java.rmi.RemoteException
        Since:
        4.1
      • setTaskData

        void setTaskData(java.lang.String sessionId,
                         TaskSoapDO taskData,
                         java.lang.String comment)
                  throws java.rmi.RemoteException
        Returns data associated with the specified task.
        Version 4.2
        • TaskSoapDO has a new member field (includeWeekends).
        Parameters:
        sessionId - User session id.
        taskData - Task data to set.
        comment - Comment on the changes, if any.
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.VersionMismatchFault - when task data is stale.
        com.collabnet.ce.soap60.fault.PendingChangesConflictFault - when this operation conflicts with pending changes.
        com.collabnet.ce.soap60.fault.IllegalArgumentFault - when an argument value is invalid.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        java.rmi.RemoteException
        Since:
        4.1
      • createTask

        TaskSoapDO createTask(java.lang.String sessionId,
                              java.lang.String taskGroupId,
                              java.lang.String title,
                              java.lang.String description,
                              int priority,
                              java.lang.String userAssignedTo,
                              java.lang.String status,
                              java.util.Date startDate,
                              java.util.Date endDate,
                              int estimatedHours,
                              int requiredHours,
                              boolean includeWeekends)
                       throws java.rmi.RemoteException
        Creates a new task with the specified information.
        Version 4.2
        • New parameter (includeWeekends) added.
        Parameters:
        sessionId - User's session id.
        taskGroupId - Task group id.
        title - Task title.
        description - Task description.
        priority - Task priority (see TaskSoapDO for more details).
        userAssignedTo - User task is assigned to.
        status - Task status (see TaskSoapDO for more details).
        startDate - Task start date.
        endDate - Task end date.
        estimatedHours - Estimated time in hours.
        requiredHours - Required time in hours.
        includeWeekends - Whether weekends should be included in date ranges
        Returns:
        Task object.
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.IllegalArgumentFault - when or more of the specified parameters are invalid.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        java.rmi.RemoteException
        Since:
        4.1
        See Also:
        TaskSoapDO
      • deleteTask

        void deleteTask(java.lang.String sessionId,
                        java.lang.String taskId)
                 throws java.rmi.RemoteException
        Deletes a task.
        Parameters:
        sessionId - User session id.
        taskId - Task id.
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        java.rmi.RemoteException
        Since:
        4.1
      • moveTask

        TaskSoapDO moveTask(java.lang.String sessionId,
                            java.lang.String taskId,
                            java.lang.String targetTaskGroupId)
                     throws java.rmi.RemoteException
        Moves a task.
        Parameters:
        sessionId - User session id.
        taskId - The id of the task to move.
        targetTaskGroupId - the id of the target group.
        Returns:
        the task group data for the updated group.
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - when a task with the same name already exists in the target group.
        com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the destination path is not valid
        java.rmi.RemoteException
        Since:
        4.1
      • createTaskDependency

        void createTaskDependency(java.lang.String sessionId,
                                  java.lang.String originTaskId,
                                  java.lang.String targetTaskId)
                           throws java.rmi.RemoteException
        Creates a task dependency.
        Parameters:
        sessionId - User session id.
        originTaskId - Origin task ID
        targetTaskId - Target task ID
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id(s) is invalid.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        java.rmi.RemoteException
        Since:
        4.1
      • deleteTaskDependency

        void deleteTaskDependency(java.lang.String sessionId,
                                  java.lang.String originTaskId,
                                  java.lang.String targetTaskId)
                           throws java.rmi.RemoteException
        Deletes a task dependency.
        Parameters:
        sessionId - User session id.
        originTaskId - Origin task ID
        targetTaskId - Target task ID
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id(s) is invalid.
        com.collabnet.ce.soap60.fault.NoSuchRelationshipFault - when there's no dependency between tasks.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        java.rmi.RemoteException
        Since:
        4.1
      • getPredecessorTaskList

        TaskSoapList getPredecessorTaskList(java.lang.String sessionId,
                                            java.lang.String targetTaskId)
                                     throws java.rmi.RemoteException
        Returns a list of tasks on which the task is dependent ("predecessors").
        NOTE: Replaces listPredecessorTasks() in 4.1.
        Parameters:
        sessionId - User session id.
        targetTaskId - Target task ID
        Returns:
        List of predecessor tasks
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id(s) is invalid.
        com.collabnet.ce.soap60.fault.NoSuchRelationshipFault - when there's no dependency between tasks.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        java.rmi.RemoteException
        Since:
        4.2
      • hasTasksWithPendingChanges

        boolean hasTasksWithPendingChanges(java.lang.String sessionId,
                                           java.lang.String taskGroupId)
                                    throws java.rmi.RemoteException
        Returns true if a folder has any items with pending changes under it.
        Parameters:
        sessionId - User session id.
        taskGroupId - Task group id.
        Returns:
        true if a folder has any items with pending changes under it, false otherwise
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id(s) is invalid.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        java.rmi.RemoteException
        Since:
        4.1
      • getSuccessorTaskList

        TaskSoapList getSuccessorTaskList(java.lang.String sessionId,
                                          java.lang.String originTaskId)
                                   throws java.rmi.RemoteException
        Returns a list of tasks which are dependent on the task ("successors").
        NOTE: Replaces listSuccessorTasks() in 4.1.
        Parameters:
        sessionId - User session id.
        originTaskId - Origin task ID
        Returns:
        List of successor tasks
        Throws:
        com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
        com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id(s) is invalid.
        com.collabnet.ce.soap60.fault.NoSuchRelationshipFault - when there's no dependency between tasks.
        com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
        com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
        java.rmi.RemoteException
        Since:
        4.2