Managed Object - ConverterServerConversionConversionManager

Property of
ConverterServiceContent
See also
ConverterServerConversionConversionFolder, ConverterServerConversionConversionJob, ConverterServerConversionConversionJobHistoryCollector, ConverterServerConversionConversionJobInfo, ConverterServerConversionConversionJobSpec, ConverterServerJobJobFilterSpec, ScheduledTask
Since
Converter API 2.0


Managed Object Description

Manager for conversion jobs and related managed objects.

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
rootFolderManagedObjectReference
to a ConverterServerConversionConversionFolder

Property to access the root of the conversion folder tree in which conversion jobs are stored.
*May not be present

Methods

Methods defined in this Managed Object
ConverterCreateCollectorForJobs, ConverterServerConversionManagerCreateJob, ConverterServerConversionManagerDestroyJob, ConverterServerConversionManagerGetJobExtraInfo, ConverterServerConversionManagerGetJobExtraInfoFromScheduledTask, ConverterServerConversionManagerGetJobInfo, ConverterServerConversionManagerGetJobInfoFromScheduledTask, ConverterServerConversionManagerGetJobSpec, ConverterServerConversionManagerGetJobSpecFromScheduledTask

ConverterCreateCollectorForJobs

Creates a job history collector, as a specialized history collector that provides JobInfo objects.

Job history collectors do not persist beyond the current client session.

Required Privileges
None
Since
Converter API 3.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterServerConversionConversionManager used to make the method call.
filter PConverterServerJobJobFilterSpec

The specification for the job query filter.

Since Converter API 3.0
P Required privilege: filter

Return Value

Type Description
ManagedObjectReference
to a ConverterServerConversionConversionJobHistoryCollector
The job collector based on the filter.

Faults

Type Description
InvalidStateThrown if there are more than the maximum number of job collectors.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ConverterServerConversionManagerCreateJob

Create a conversion job managed object from the given conversion job specification.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterServerConversionConversionManager used to make the method call.
spec PConverterServerConversionConversionJobSpec

The specification for the new conversion job.

Since Converter API 2.0
extraInfo* Pxsd:anyType

The extra client provided information to be associated wit this managed object.

Since Converter API 2.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ConverterServerConversionConversionJobInfo

Faults

Type Description
DuplicateName
InvalidLogin
InvalidName
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ConverterServerConversionManagerDestroyJob

Destroy the given conversion job managed object. This will release all in- memeory state for the job, delete the corresponding rows in the database, remove corresponding scheduler items from the internal scheduler, notify any active tasks to cancel and destroy any associated active task managed object.

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.

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterServerConversionConversionManager used to make the method call.
job PManagedObjectReference
to a ConverterServerConversionConversionJob

The conversion job to destroy.

Since Converter API 2.0
activeTaskHandling* Pxsd: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
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
InvalidState
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ConverterServerConversionManagerGetJobExtraInfo

Gets the job's extra info even if there is no longer a managed object for this task. It will use the job managed object ID if needed to retrieve the job specification from the database.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterServerConversionConversionManager used to make the method call.
conversionJob PManagedObjectReference
to a ConverterServerConversionConversionJob

The conversion job to retrieve's managed object reference.

Since Converter API 2.0
P Required privilege: conversionJob

Return Value

Type Description
xsd:anyType

Faults

Type Description
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ConverterServerConversionManagerGetJobExtraInfoFromScheduledTask

Deprecated. as of version 6 of Converter API. Converter as VC extension is no longer supported.

Gets the job's extra info from its associated VC scheduled task object.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterServerConversionConversionManager used to make the method call.
task PManagedObjectReference
to a ScheduledTask

Scheduled task object.

Since Converter API 2.0
P Required privilege: task

Return Value

Type Description
xsd:anyType

Faults

Type Description
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ConverterServerConversionManagerGetJobInfo

Gets the job information even if there is no longer a managed object for this task. It will use the job managed object ID if needed to retrieve the job information from the database.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterServerConversionConversionManager used to make the method call.
conversionJob PManagedObjectReference
to a ConverterServerConversionConversionJob

The conversion job to retrieve's managed object reference.

Since Converter API 2.0
P Required privilege: conversionJob

Return Value

Type Description
ConverterServerConversionConversionJobInfo

Faults

Type Description
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ConverterServerConversionManagerGetJobInfoFromScheduledTask

Deprecated. as of version 6 of Converter API. Converter as VC extension is no longer supported.

Gets the scheduled job information from its associated VC scheduled task object.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterServerConversionConversionManager used to make the method call.
task PManagedObjectReference
to a ScheduledTask

Scheduled task object.

Since Converter API 2.0
P Required privilege: task

Return Value

Type Description
ConverterServerConversionConversionJobInfo

Faults

Type Description
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ConverterServerConversionManagerGetJobSpec

Gets the job specification even if there is no longer a managed object for this task. It will use the job managed object ID if needed to retrieve the job specification from the database.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterServerConversionConversionManager used to make the method call.
conversionJob PManagedObjectReference
to a ConverterServerConversionConversionJob

The conversion job to retrieve's managed object reference.

Since Converter API 2.0
P Required privilege: conversionJob

Return Value

Type Description
ConverterServerConversionConversionJobSpec

Faults

Type Description
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ConverterServerConversionManagerGetJobSpecFromScheduledTask

Deprecated. as of version 6 of Converter API. Converter as VC extension is no longer supported.

Gets the scheduled job specification from its associated VC scheduled task object.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterServerConversionConversionManager used to make the method call.
task PManagedObjectReference
to a ScheduledTask

Scheduled task object.

Since Converter API 2.0
P Required privilege: task

Return Value

Type Description
ConverterServerConversionConversionJobSpec

Faults

Type Description
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None