| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
description | ConverterTaskDescription |
Static descriptive strings used to represent task information to users.
These strings are locale-specific.
|
maxCollector | xsd:int |
For each client, the maximum number of task collectors that can exist
simultaneously.
|
maxConnection | xsd:int |
The maximum number of concurrent connections within one task. (0 means unlimited)
When value is not set then defaults to 2 simultaneous connections.
Since Converter API 5.0 |
maxTask | xsd:int |
The maximum number of concurrent tasks.
|
recentTask* | ManagedObjectReference[]
to a ConverterTask[] |
Tasks that completed recently, are currently running, or are
queued to run.
|
Methods
Task collectors do not persist beyond the current client session.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call. |
filter P | ConverterTaskFilterSpec |
The specification for the task query filter.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTaskHistoryCollector | The task collector based on the filter. |
Faults
Type | Description |
---|---|
InvalidState | Thrown if there are more than the maximum number of task collectors. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call. |
taskSpec P | ConverterTaskSpec |
Task specification.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterTaskInfo | TaskInfo Data object describing the new task. |
Faults
Type | Description |
---|---|
InvalidLogin | Thrown if managed entity is specified but authentication with the host fails. |
InvalidName | Thrown if the source or target name is not valid. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call. |
task P | ManagedObjectReference
to a ConverterTask |
Task object.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | Thrown if the task is queued or running. |
NotFound | Thrown if the task could not be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call. |
taskSpec P | ConverterTaskSpec |
The specification of the task that should be
estimated.
Since Converter API 1.0 |
envInfo P | ConverterRuntimeEnvironmentInfo |
Additional information on the environment in
which the task will run.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
xsd:int | The estimated time remaining to complete the task in seconds. |
Faults
Type | Description |
---|---|
InvalidLogin | Thrown if authentication with the host fails. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call. |
task P | ManagedObjectReference
to a ConverterTask |
Task object.
Since Converter API 2.0 |
Return Value
Type | Description |
---|---|
ConverterTaskInfo[] | Array of TaskInfo data objects describing the child tasks of the parent task. |
Faults
Type | Description |
---|---|
NotFound | Thrown if the task could not be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call. |
task P | ManagedObjectReference |
Task object.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterTaskInfo | TaskInfo Data object describing the task information. |
Faults
Type | Description |
---|---|
NotFound | Thrown if the task could not be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call. |
task P | ManagedObjectReference |
Task object.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterTaskSpec | TaskSpec Data object describing the task specification. |
Faults
Type | Description |
---|---|
NotFound | Thrown if the task could not be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call. |
Return Value
Type | Description |
---|---|
xsd:string |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call. |
Return Value
Type | Description |
---|---|
xsd:boolean |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call. |
enable P | xsd:boolean |
Since Converter API 7.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call. |
maxConnection P | xsd:int |
The maximum number of concurrent connections in task.
Since Converter API 5.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call. |
maxTask P | xsd:int |
The maximum number of concurrent tasks.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |