com.esri.arcgis.geodatabase
Interface IMetadataSynchronizerManager

All Superinterfaces:

Serializable

All Known Implementing Classes:

MetadataSynchronizer

public interface IMetadataSynchronizerManager
extends Serializable

Provides access to members that control which metadata synchronizers are used to update metadata.

Description

The IMetadataSynchronizationManager interface is used to manage the synchronization objects registered in ArcCatalog. Three methods, (GetEnabled, GetSynchronizer, and SetEnabled) and one property (NumSynchronizers) are supported through this interface.

Remarks

The IMetadataSynchronizerManager Interface is available from the MetadataSynchronizer CoClass. The interface allows you to enable or disable any of the registered metadata synchronizers.

Additional information on this subject can be found in the Technical Paper "Creating a Custom Metadata Synchronizer", May 2001.

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.

When To Use

The IMetadataSynchronizationManager is used when changing the current synchronizers that are enabled, when attempting to retrieve a specific synchronizer, or after creating a custom metadata synchronizer. The interface allows enabling or disabling any of the registered metadata sychronizers. A synchronizer's enabled status determines whether it will write metadata when the synchronization process occurs.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

boolean	getEnabled(int index) Indicates whether the Nth synchronizer is enabled.
int	getNumSynchronizers() The number of available synchronizers.
IMetadataSynchronizer	getSynchronizer(int index) Gets the nth synchronizer.
void	setEnabled(int index, boolean enabled) Set the synchronizer to be enabled or disabled.

Method Detail

getNumSynchronizers

int getNumSynchronizers()
                        throws IOException,
                               AutomationException

The number of available synchronizers.

Description

Returns the number of metadata synchronizers registered on the machine.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The numSynchronizers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSynchronizer

IMetadataSynchronizer getSynchronizer(int index)
                                      throws IOException,
                                             AutomationException

Gets the nth synchronizer.

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IMetadataSynchronizer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnabled

void setEnabled(int index,
                boolean enabled)
                throws IOException,
                       AutomationException

Set the synchronizer to be enabled or disabled.

Description

The SetEnabled method sets the enabled/disabled state of the synchronizer referenced by the index passed in to the first argument.

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

enabled - The enabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnabled

boolean getEnabled(int index)
                   throws IOException,
                          AutomationException

Indicates whether the Nth synchronizer is enabled.

Description

The GetEnabled method returns a boolean if the metadata sychronizer, specified using the index parameter, is currently enabled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Returns:

The enabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.