com.esri.arcgis.geodatabase
Interface IPlugInMetadata

All Superinterfaces:
Serializable
All Known Subinterfaces:
IPlugInMetadata2
All Known Implementing Classes:
IPlugInMetadata2Proxy, IPlugInMetadataProxy

public interface IPlugInMetadata
extends Serializable

Provides access to members that manage property set metadata for a plug-in.

Description

May be implemented by a plug-in workspace helper class if a plug-in data source has its own metadata engine.

Remarks

You should implement either IPlugInMetadata or IPlugInMetadataPath on your plug-in workspace helper for successful operation of the Export Data command in ArcMap. This command uses the FeatureDataConverter object which relies on metadata capabilities of data sources.

Product Availability

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


Method Summary
 IPropertySet getMetadata(String localName)
          A property set containing the metadata for the indicated dataset.
 boolean isCanEditMetadata()
          Indicates if the metadata for the indicated dataset currently writable.
 void setMetadata(String localName, IPropertySet metadata)
          A property set containing the metadata for the indicated dataset.
 

Method Detail

isCanEditMetadata

boolean isCanEditMetadata()
                          throws IOException,
                                 AutomationException
Indicates if the metadata for the indicated dataset currently writable.

Description

Returns true if the metadata is currently editable. This implies that a call to put_Metadata is expected to succeed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The canEdit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMetadata

IPropertySet getMetadata(String localName)
                         throws IOException,
                                AutomationException
A property set containing the metadata for the indicated dataset.

Product Availability

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

Parameters:
localName - The localName (in)
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMetadata

void setMetadata(String localName,
                 IPropertySet metadata)
                 throws IOException,
                        AutomationException
A property set containing the metadata for the indicated dataset.

Product Availability

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

Parameters:
localName - The localName (in)
metadata - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.