View API
|
| Local Methods | ||
| Service Types | Data Object Types | All Properties | All Methods |
Service - Task
Service Description
The task management service.Methods
| Methods defined in this Service |
|---|
| Task_Cancel, Task_Get |
Task_Cancel
Cancels the specified task.Privileges
| Privilege | Description |
|---|---|
| FEDERATED_LDAP_MANAGE | Global LDAP management is required to cancel a task. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Task used to make the method call. |
| id | TaskId |
The ID of the task to cancel.
|
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidRequest | Thrown if the task is not cancellable. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
Task_Get
Gets info on the requested task.Privileges
| Privilege | Description |
|---|---|
| FEDERATED_LDAP_VIEW | Global LDAP read is required to retrieve information about a task. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Task used to make the method call. |
| id | TaskId |
The ID of the task.
|
Return Value
| Type | Description |
|---|---|
| TaskInfo | A TaskInfo object containing the current state of the task. |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
| Top of page | Local Methods | ||
| Service Types | Data Object Types | All Properties | All Methods |