|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IMetadataSynchronizerManager
Provides access to members that control which metadata synchronizers are used to update metadata.
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.
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.
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.
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 |
---|
int getNumSynchronizers() throws IOException, AutomationException
Returns the number of metadata synchronizers registered on the machine.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IMetadataSynchronizer getSynchronizer(int index) throws IOException, AutomationException
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.
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setEnabled(int index, boolean enabled) throws IOException, AutomationException
The SetEnabled method sets the enabled/disabled state of the synchronizer referenced by the index passed in to the first argument.
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.
index
- The index (in)enabled
- The enabled (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean getEnabled(int index) throws IOException, AutomationException
The GetEnabled method returns a boolean if the metadata sychronizer, specified using the index parameter, is currently enabled.
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |