Class MetadataSynchronizerClass

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("C10124EE-3648-445E-A16B-9D2755FBD690")]
public class MetadataSynchronizerClass : MetadataSynchronizer, IMetadataSynchronizer, IMetadataSynchronizerManager
Inheritance
MetadataSynchronizerClass
Implements
Inherited Members

Constructors

MetadataSynchronizerClass()

public MetadataSynchronizerClass()

Explicit Interface Implementations

ClassID

The class ID of the metadata synchronizer.

virtual UID ClassID { get; }

Returns

UID

GetEnabled(int)

Indicates whether the Nth synchronizer is enabled.

virtual bool GetEnabled(int Index)

Parameters

Index int

Returns

bool

GetSynchronizer(int)

Gets the nth synchronizer.

virtual IMetadataSynchronizer GetSynchronizer(int Index)

Parameters

Index int

Returns

IMetadataSynchronizer

Remarks

The GetSynchronizer method provides a reference to the IMetadataSynchronizer object.

Because the GetSynchronizer method uses an index to get the desired synchronizer, the IMetadataSynchronizerManager::NumSynchronizers property and IMetadataSynchronizer::Name are often used to first specify the metadata sychronizer of choice.

Name

The name of the metadata synchronizer.

virtual string Name { get; }

Returns

string

NumSynchronizers

The number of available synchronizers.

virtual int NumSynchronizers { get; }

Returns

int

SetEnabled(int, bool)

Set the synchronizer to be enabled or disabled.

virtual void SetEnabled(int Index, bool Enabled)

Parameters

Index int
Enabled bool

Remarks

The Index parameter is used to indicate the specific metadata synchronizer.

The second argument, of data type boolean, sets the state of the synchronizer.

Note that enabling and disabling synchronizers through this interface is persisted across sessions. If changes are meant to be temporary, it's recommended that the current enabled status of each synchronizer be stored prior to any changes being made, then restored after.

Update(IXmlPropertySet, string, object)

Updates the metadata item using the value passed in.

virtual void Update(IXmlPropertySet PropertySet, string itemDesc, object Value)

Parameters

PropertySet IXmlPropertySet
itemDesc string
Value object

Remarks

The pPropertySet parameter is an XML property set representing the metadata of the dataset being synchronized.

The itemDesc string parameter describes what object is being passed in the Value parameter.

The Value parameter  is an object of the datasets whose metadata is being synchronized.

The different objects passed to the Update method, the Value parameter, vary from the type of dataset that is being synchronized. Not all itemDesc are supported for all data types. For instance, CoverageEntity objects only apply to ArcGIS for Desktop Advanced coverages and ArcGIS for Desktop Advanced tables.

A complete list of the expected Values for the supported itemDesc items is available in the Technical Paper "Creating a Custom Metadata Synchronizer," May 2001.