Managed Object - ConverterManagedEntity

Extended by
ConverterServerConversionConversionFolder, ConverterServerJobJob
See also
ConverterManagedEntityStatus
Since
Converter API 2.0


Managed Object Description

A single entity in the converter server hierarchy.

Properties

Name Type Description
namexsd:string

Property for the name of the managed entity.
overallStatusConverterManagedEntityStatus

Property representing the status of this entity.

For composite entities such as ProtectionFolder this value is set to the highest status value in all child entities.



Methods

Methods defined in this Managed Object
ConverterServerManagedEntityRename

ConverterServerManagedEntityRename

Method to change the name of the managed entity.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterManagedEntity used to make the method call.
newName Pxsd:string

The new name to assign the managed entity.

Since Converter API 2.0
P Required privilege: newName

Return Value

Type Description
xsd:stringString The old name before the change.

Faults

Type Description
DuplicateName
InvalidName
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