public interface ITaskAppSoap
Modifier and Type | Method and Description |
---|---|
TaskSoapDO |
createTask(String sessionId,
String taskGroupId,
String title,
String description,
int priority,
String userAssignedTo,
String status,
Date startDate,
Date endDate,
int estimatedHours,
int requiredHours,
boolean includeWeekends)
Creates a new task with the specified information.
|
void |
createTaskDependency(String sessionId,
String originTaskId,
String targetTaskId)
Creates a task dependency.
|
TaskGroupSoapDO |
createTaskGroup(String sessionId,
String parentId,
String title,
String description)
Creates a new task group.
|
void |
deleteTask(String sessionId,
String taskId)
Deletes a task.
|
void |
deleteTaskDependency(String sessionId,
String originTaskId,
String targetTaskId)
Deletes a task dependency.
|
void |
deleteTaskGroup(String sessionId,
String taskGroupId)
Deletes a task group.
|
TaskSoapList |
findTasks(String sessionId,
String queryString,
String projectId,
boolean searchAttachments)
Finds a list of tasks matching a search string.
|
TaskSoapList |
getPredecessorTaskList(String sessionId,
String targetTaskId)
Returns a list of tasks on which the task is dependent ("predecessors").
|
TaskSoapList |
getSuccessorTaskList(String sessionId,
String originTaskId)
Returns a list of tasks which are dependent on the task ("successors").
|
TaskSoapDO |
getTaskData(String sessionId,
String taskId)
Returns data associated with the specified task.
|
TaskGroupSoapDO |
getTaskGroupData(String sessionId,
String taskGroupId)
Returns data associated with the specified task group.
|
TaskGroupSoapList |
getTaskGroupList(String sessionId,
String parentId)
Returns a list of task groups for a project (in the correct order).
|
TaskSoapList |
getTaskList(String sessionId,
String containerId,
com.collabnet.ce.soap60.types.SoapFilter[] filters)
Returns a filtered list of tasks within a given project or task group.
|
boolean |
hasTasksWithPendingChanges(String sessionId,
String taskGroupId)
Returns true if a folder has any items with pending changes under it.
|
TaskSoapDO |
moveTask(String sessionId,
String taskId,
String targetTaskGroupId)
Moves a task.
|
TaskGroupSoapDO |
moveTaskGroup(String sessionId,
String taskGroupId,
String targetTaskGroupId)
Moves a task group.
|
TaskGroupSoapDO |
renameTaskGroup(String sessionId,
String taskGroupId,
String newTitle)
Renames a task group.
|
void |
reorderTaskGroups(String sessionId,
String parentFolderId,
String[] taskGroupIds)
Sets a new order for the task groups (folders) in a parent folder.
|
void |
setTaskData(String sessionId,
TaskSoapDO taskData,
String comment)
Returns data associated with the specified task.
|
TaskGroupSoapList getTaskGroupList(String sessionId, String parentId) throws RemoteException
sessionId
- User session id.parentId
- Parent task group id -or- project id for listing top-level task groups.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.RemoteException
void reorderTaskGroups(String sessionId, String parentFolderId, String[] taskGroupIds) throws RemoteException
sessionId
- User session id.parentFolderId
- the id of the parent foldertaskGroupIds
- an array of task group ids in their new ordercom.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.RemoteException
TaskGroupSoapDO createTaskGroup(String sessionId, String parentId, String title, String description) throws RemoteException
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.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.RemoteException
void deleteTaskGroup(String sessionId, String taskGroupId) throws RemoteException
sessionId
- User session id.taskGroupId
- Task group id.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.RemoteException
TaskSoapList getTaskList(String sessionId, String containerId, com.collabnet.ce.soap60.types.SoapFilter[] filters) throws RemoteException
filters
) for filtering task lists.sessionId
- User session id.containerId
- Project or task group id.filters
- Task list filters (null will return all tasks within the container).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.RemoteException
TaskSoapList findTasks(String sessionId, String queryString, String projectId, boolean searchAttachments) throws RemoteException
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.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.RemoteException
TaskGroupSoapDO getTaskGroupData(String sessionId, String taskGroupId) throws RemoteException
sessionId
- User session id.taskGroupId
- Task group idcom.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.RemoteException
TaskGroupSoapDO renameTaskGroup(String sessionId, String taskGroupId, String newTitle) throws RemoteException
sessionId
- User session id.taskGroupId
- Task group idnewTitle
- the new title for the task groupcom.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.RemoteException
TaskGroupSoapDO moveTaskGroup(String sessionId, String taskGroupId, String targetTaskGroupId) throws RemoteException
sessionId
- User session id.taskGroupId
- The id of the task group to move.targetTaskGroupId
- the id of the target group.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 pathRemoteException
TaskSoapDO getTaskData(String sessionId, String taskId) throws RemoteException
sessionId
- User session id.taskId
- Task path.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.RemoteException
void setTaskData(String sessionId, TaskSoapDO taskData, String comment) throws RemoteException
includeWeekends
).sessionId
- User session id.taskData
- Task data to set.comment
- Comment on the changes, if any.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.RemoteException
TaskSoapDO createTask(String sessionId, String taskGroupId, String title, String description, int priority, String userAssignedTo, String status, Date startDate, Date endDate, int estimatedHours, int requiredHours, boolean includeWeekends) throws RemoteException
includeWeekends
) added.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 rangescom.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.RemoteException
TaskSoapDO
void deleteTask(String sessionId, String taskId) throws RemoteException
sessionId
- User session id.taskId
- Task id.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.RemoteException
TaskSoapDO moveTask(String sessionId, String taskId, String targetTaskGroupId) throws RemoteException
sessionId
- User session id.taskId
- The id of the task to move.targetTaskGroupId
- the id of the target group.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 validRemoteException
void createTaskDependency(String sessionId, String originTaskId, String targetTaskId) throws RemoteException
sessionId
- User session id.originTaskId
- Origin task IDtargetTaskId
- Target task IDcom.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.RemoteException
void deleteTaskDependency(String sessionId, String originTaskId, String targetTaskId) throws RemoteException
sessionId
- User session id.originTaskId
- Origin task IDtargetTaskId
- Target task IDcom.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.RemoteException
TaskSoapList getPredecessorTaskList(String sessionId, String targetTaskId) throws RemoteException
sessionId
- User session id.targetTaskId
- Target task IDcom.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.RemoteException
boolean hasTasksWithPendingChanges(String sessionId, String taskGroupId) throws RemoteException
sessionId
- User session id.taskGroupId
- Task group id.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.RemoteException
TaskSoapList getSuccessorTaskList(String sessionId, String originTaskId) throws RemoteException
sessionId
- User session id.originTaskId
- Origin task IDcom.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.RemoteException
Copyright © 2016 CollabNet. All Rights Reserved.