| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
maxCollector* | xsd:int |
For each client, the maximum number of job collectors that can exist
simultaneously.
Since Converter API 3.0 |
rootFolder | ManagedObjectReference
to a ConverterServerConversionConversionFolder |
Property to access the root of the conversion folder tree in which conversion
jobs are stored.
|
Methods
Job history collectors do not persist beyond the current client session.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterServerConversionConversionManager used to make the method call. |
filter P | ConverterServerJobJobFilterSpec |
The specification for the job query filter.
Since Converter API 3.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterServerConversionConversionJobHistoryCollector | The job collector based on the filter. |
Faults
Type | Description |
---|---|
InvalidState | Thrown if there are more than the maximum number of job 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 ConverterServerConversionConversionManager used to make the method call. |
spec P | ConverterServerConversionConversionJobSpec |
The specification for the new conversion job.
Since Converter API 2.0 |
extraInfo* P | xsd:anyType |
The extra client provided information to be associated wit this
managed object.
Since Converter API 2.0 |
Return Value
Type | Description |
---|---|
ConverterServerConversionConversionJobInfo |
Faults
Type | Description |
---|---|
DuplicateName | |
InvalidLogin | |
InvalidName | |
InvalidState | |
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 |
In standalone mode this operation can be initiated by the user that created the job or by Administrator.
In VC-integrated mode this operation can be initiated by the user that created the job or by any user who has Task.Update privilege on the inventory root.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterServerConversionConversionManager used to make the method call. |
job P | ManagedObjectReference
to a ConverterServerConversionConversionJob |
The conversion job to destroy.
Since Converter API 2.0 |
activeTaskHandling* P | xsd:string |
Determines how to handle an active task if any exists
for the job. This should be a stringized value of the
ConversionJob.ActiveTaskHandling enumeration.
Since Converter API 2.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | |
NotFound | |
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 ConverterServerConversionConversionManager used to make the method call. |
conversionJob P | ManagedObjectReference
to a ConverterServerConversionConversionJob |
The conversion job to retrieve's managed object
reference.
Since Converter API 2.0 |
Return Value
Type | Description |
---|---|
xsd:anyType |
Faults
Type | Description |
---|---|
NotFound | |
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 ConverterServerConversionConversionManager used to make the method call. |
task P | ManagedObjectReference
to a ScheduledTask |
Scheduled task object.
Since Converter API 2.0 |
Return Value
Type | Description |
---|---|
xsd:anyType |
Faults
Type | Description |
---|---|
NotFound | |
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 ConverterServerConversionConversionManager used to make the method call. |
conversionJob P | ManagedObjectReference
to a ConverterServerConversionConversionJob |
The conversion job to retrieve's managed object reference.
Since Converter API 2.0 |
Return Value
Type | Description |
---|---|
ConverterServerConversionConversionJobInfo |
Faults
Type | Description |
---|---|
NotFound | |
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 ConverterServerConversionConversionManager used to make the method call. |
task P | ManagedObjectReference
to a ScheduledTask |
Scheduled task object.
Since Converter API 2.0 |
Return Value
Type | Description |
---|---|
ConverterServerConversionConversionJobInfo |
Faults
Type | Description |
---|---|
NotFound | |
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 ConverterServerConversionConversionManager used to make the method call. |
conversionJob P | ManagedObjectReference
to a ConverterServerConversionConversionJob |
The conversion job to retrieve's managed object
reference.
Since Converter API 2.0 |
Return Value
Type | Description |
---|---|
ConverterServerConversionConversionJobSpec |
Faults
Type | Description |
---|---|
NotFound | |
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 ConverterServerConversionConversionManager used to make the method call. |
task P | ManagedObjectReference
to a ScheduledTask |
Scheduled task object.
Since Converter API 2.0 |
Return Value
Type | Description |
---|---|
ConverterServerConversionConversionJobSpec |
Faults
Type | Description |
---|---|
NotFound | |
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 |