com.esri.arcgis.catalog
Interface IRemoteMetadata

All Superinterfaces:

Serializable

All Known Implementing Classes:

IMSMetadataService

public interface IRemoteMetadata
extends Serializable

Provides access to members to manipulate information specific to metadata stored in an ArcIMS Metadata Server.

Product Availability

Available with ArcGIS Desktop.

Method Summary

IGxObject	createChild(String server, String service, String userName, String password, boolean isFolder) Creates a new folder as a child of this folder.
String	getDataset() Name of metadata document on server.
IEnvelope	getExtent() The extent of the dataset represented by this document.
int	getIndexStatus() Indicates whether this document is indexed on the server.
String	getMetadataURL() URL of metadata document on server.
String	getOnlink() The online linkage contained within this document.
String	getOwner() ArcIMS authenticated user owning metadata document.
int	getRefCount() The number of references to this document on the server.
String	getServer() The URL of the ArcIMS server running the service represented by this document.
String	getService() The name of the ArcIMS service represented by this document.
String	getThumbnailURL() URL of thumbnail image on server.
String	getUserID() Unique id (UUID) of metadata document.
boolean	isFolder() Indicates whether this metadata document is a folder.
boolean	isPrivateDocument() Indicates whether this metadata document is private.
boolean	isRoot() Indicates whether this metadata document is the root document.
void	publishDatasets(IEnumName names) Publish the metadata of a set of datasets to an ArcIMS Metadata Server.
void	setDataset(String dataset) Name of metadata document on server.
void	setExtentByRef(IEnvelope extent) The extent of the dataset represented by this document.
void	setHasChildren(boolean rhs1) Indicates whether this folder has children.
void	setIndexStatus(int indexStatus) Indicates whether this document is indexed on the server.
void	setIsFolder(boolean isFolder) Indicates whether this metadata document is a folder.
void	setIsPrivateDocument(boolean isPrivate) Indicates whether this metadata document is private.
void	setIsRoot(boolean isRoot) Indicates whether this metadata document is the root document.
void	setMetadataURL(String uRL) URL of metadata document on server.
void	setOnlink(String onlink) The online linkage contained within this document.
void	setOwner(String owner) ArcIMS authenticated user owning metadata document.
void	setRefCount(int refCount) The number of references to this document on the server.
void	setServer(String server) The URL of the ArcIMS server running the service represented by this document.
void	setService(String service) The name of the ArcIMS service represented by this document.
void	setThumbnailURL(String uRL) URL of thumbnail image on server.
void	setUserID(String userID) Unique id (UUID) of metadata document.

Method Detail

setDataset

void setDataset(String dataset)
                throws IOException,
                       AutomationException

Name of metadata document on server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

dataset - The dataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataset

String getDataset()
                  throws IOException,
                         AutomationException

Name of metadata document on server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The dataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOwner

void setOwner(String owner)
              throws IOException,
                     AutomationException

ArcIMS authenticated user owning metadata document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

owner - The owner (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOwner

String getOwner()
                throws IOException,
                       AutomationException

ArcIMS authenticated user owning metadata document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The owner

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserID

void setUserID(String userID)
               throws IOException,
                      AutomationException

Unique id (UUID) of metadata document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

userID - The userID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserID

String getUserID()
                 throws IOException,
                        AutomationException

Unique id (UUID) of metadata document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The userID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMetadataURL

void setMetadataURL(String uRL)
                    throws IOException,
                           AutomationException

URL of metadata document on server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

uRL - The uRL (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMetadataURL

String getMetadataURL()
                      throws IOException,
                             AutomationException

URL of metadata document on server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The uRL

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setThumbnailURL

void setThumbnailURL(String uRL)
                     throws IOException,
                            AutomationException

URL of thumbnail image on server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

uRL - The uRL (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThumbnailURL

String getThumbnailURL()
                       throws IOException,
                              AutomationException

URL of thumbnail image on server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The uRL

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createChild

IGxObject createChild(String server,
                      String service,
                      String userName,
                      String password,
                      boolean isFolder)
                      throws IOException,
                             AutomationException

Creates a new folder as a child of this folder.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

server - The server (in)

service - The service (in)

userName - The userName (in)

password - The password (in)

isFolder - The isFolder (in)

Returns:

A reference to a com.esri.arcgis.catalog.IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasChildren

void setHasChildren(boolean rhs1)
                    throws IOException,
                           AutomationException

Indicates whether this folder has children.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsFolder

void setIsFolder(boolean isFolder)
                 throws IOException,
                        AutomationException

Indicates whether this metadata document is a folder.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

isFolder - The isFolder (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFolder

boolean isFolder()
                 throws IOException,
                        AutomationException

Indicates whether this metadata document is a folder.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The isFolder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsRoot

void setIsRoot(boolean isRoot)
               throws IOException,
                      AutomationException

Indicates whether this metadata document is the root document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

isRoot - The isRoot (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRoot

boolean isRoot()
               throws IOException,
                      AutomationException

Indicates whether this metadata document is the root document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The isRoot

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsPrivateDocument

void setIsPrivateDocument(boolean isPrivate)
                          throws IOException,
                                 AutomationException

Indicates whether this metadata document is private.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

isPrivate - The isPrivate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPrivateDocument

boolean isPrivateDocument()
                          throws IOException,
                                 AutomationException

Indicates whether this metadata document is private.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The isPrivate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

publishDatasets

void publishDatasets(IEnumName names)
                     throws IOException,
                            AutomationException

Publish the metadata of a set of datasets to an ArcIMS Metadata Server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

names - A reference to a com.esri.arcgis.system.IEnumName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRefCount

void setRefCount(int refCount)
                 throws IOException,
                        AutomationException

The number of references to this document on the server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

refCount - The refCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRefCount

int getRefCount()
                throws IOException,
                       AutomationException

The number of references to this document on the server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The refCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtentByRef

void setExtentByRef(IEnvelope extent)
                    throws IOException,
                           AutomationException

The extent of the dataset represented by this document.

Product Availability

Available with ArcGIS Desktop.

Parameters:

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the dataset represented by this document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOnlink

void setOnlink(String onlink)
               throws IOException,
                      AutomationException

The online linkage contained within this document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

onlink - The onlink (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOnlink

String getOnlink()
                 throws IOException,
                        AutomationException

The online linkage contained within this document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The onlink

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServer

void setServer(String server)
               throws IOException,
                      AutomationException

The URL of the ArcIMS server running the service represented by this document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

server - The server (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServer

String getServer()
                 throws IOException,
                        AutomationException

The URL of the ArcIMS server running the service represented by this document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The server

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setService

void setService(String service)
                throws IOException,
                       AutomationException

The name of the ArcIMS service represented by this document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

service - The service (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getService

String getService()
                  throws IOException,
                         AutomationException

The name of the ArcIMS service represented by this document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The service

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIndexStatus

int getIndexStatus()
                   throws IOException,
                          AutomationException

Indicates whether this document is indexed on the server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A com.esri.arcgis.gisclient.acIndexStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndexStatus

void setIndexStatus(int indexStatus)
                    throws IOException,
                           AutomationException

Indicates whether this document is indexed on the server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

indexStatus - A com.esri.arcgis.gisclient.acIndexStatus constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.