Managed Object - ConverterServerJobJob

Property of
ConverterEvent, ConverterEventFilterSpec, ConverterJobFault, ConverterTaskFilterSpec, ConverterTaskInfo
Parameter to
ConverterGenerateJobLogBundle
Extended by
ConverterServerConversionConversionJob
Extends
ConverterManagedEntity
See also
ConverterServerJobJobInfo, ConverterServerJobJobJobUpdateSpec, ConverterServerJobJobSpec
Since
Converter API 2.0


Managed Object Description

Interface interacting with Jobs. Can be extended for more specific job types.

Properties

Name Type Description
extraInfo*xsd:anyType

Property for extra information associated with this managed object.
infoConverterServerJobJobInfo

Gets the dynamic job information for the job.
specConverterServerJobJobSpec

Get the job specification for this job.
Properties inherited from ConverterManagedEntity
name, overallStatus
*May not be present

Methods

Methods defined in this Managed Object
ConverterServerJobResume, ConverterServerJobStop, ConverterServerJobSuspend, ConverterServerJobUpdateExtaInfo, ConverterServerJobUpdateSpec
Methods inherited from ConverterManagedEntity
ConverterServerManagedEntityRename

ConverterServerJobResume

Unsuspend the job so that it can continue running its scheduled operations.

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 ConverterServerJobJob used to make the method call.

Return Value

Type Description
None

Faults

Type Description
InvalidState
NoPermissionThrown if the user is not authorized for this operation.
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



ConverterServerJobStop

Permenantly stops this job. This managed object will cease to exist, any runtime resources consumed by this job are freed, corresponding scheduler items are removed from the internal scheduler, and (if requested) any active tasks are notified to cancel and are destroyed. Only the job data stored in the database will remain and is accessible through the ConverterServerConversionConversionJobHistoryCollector interface. To remove the database rows associated with this job call ConverterServerConversionManagerDestroyJob.
Required Privileges
None
Since
Converter API 3.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterServerJobJob used to make the method call.
activeTaskHandling Pxsd:string

Describes how to handle active tasks. Must be stringized representation of a value from the ConverterServerJobJobActiveTaskHandling enumeration.

Since Converter API 3.0
P Required privilege: activeTaskHandling

Return Value

Type Description
None

Faults

Type Description
ConverterJobDeactivationFaultThrown if there is a general error deactivating the given job. Check to see if the faultCause property is set for more detailed information.
ConverterJobHasActiveTaskFaultThrown if the "activeTaskHandling" is set to "failIfActiveTask" and the job was found to have an active task at the time of suspend.
InvalidArgument
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



ConverterServerJobSuspend

Atomically suspend the job, updating the internal scheduler. If cancelActiveTask is set then any active task will be canceled (though may not be completed running when this returns). Otherwise if failActiveTask is set then this method will throw an exception (to be defined) if and only if there is an active task running when this is suspended.

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 ConverterServerJobJob used to make the method call.
activeTaskHandling Pxsd:string

Describes how to handle active tasks. Must be a stringized representation of a value from the Job.ActiveTaskHandling enumeration.

Since Converter API 2.0
P Required privilege: activeTaskHandling

Return Value

Type Description
None

Faults

Type Description
ConverterJobHasActiveTaskFaultThrow if the "activeTaskHandling" is set to "failIfActiveTask" and the job was found to have an active task at the time of suspend.
InvalidStateThrown if the job is already in the suspended state.
NoPermissionThrown if the user is not authorized for this operation.
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



ConverterServerJobUpdateExtaInfo

Replace the extra information associated with this Job 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 ConverterServerJobJob used to make the method call.
replacementInfo* Pxsd:anyType

Information with which to replace the "extraInfo" property in this Job managed object. If not set then this will clear the value of "extraInfo".

Since Converter API 2.0
*Need not be set P Required privilege: replacementInfo

Return Value

Type Description
xsd:anyTypeThe old extraInfo property before replacment.

Faults

Type Description
NoPermissionThrown if the user is not authorized for this operation.
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



ConverterServerJobUpdateSpec

Update several job parameters in one call.

Adds the ability to update the first run time, including to run as soon as possible. It is an error to update the first run time if the job has already started its initial run.

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 ConverterServerJobJob used to make the method call.
updateParams PConverterServerJobJobJobUpdateSpec

Parameters to use for updating a job's specification.

Since Converter API 2.0
P Required privilege: updateParams

Return Value

Type Description
ConverterServerJobJobSpecThe old job spec before update.

Faults

Type Description
ConverterFirstRunAlreadyStartedFaultA new first runtime is requested, but the job has previously started its first run.
DuplicateNameThe new name already exists in the current folder.
InvalidNameThe new name is not valid.
NoPermissionThrown if the user is not authorized for this operation.
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