com.esri.arcgis.gisclient
Interface IRemoteMetadataName

All Superinterfaces:

Serializable

All Known Implementing Classes:

IMSMetadataServiceName

public interface IRemoteMetadataName
extends Serializable

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

Product Availability

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

Method Summary

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.
String	getParentDataset() Name of parent of metadata document on server.
String	getParentOwner() ArcIMS authenticated user owning parent of metadata document.
String	getParentUserID() Unique id (UUID) of parent of 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	setDataset(String pDataset) Name of metadata document on server.
void	setExtentByRef(IEnvelope ppExtent) The extent of the dataset represented by this document.
void	setIndexStatus(int pIndexStatus) Indicates whether this document is indexed on the server.
void	setIsFolder(boolean pIsFolder) Indicates whether this metadata document is a folder.
void	setIsPrivateDocument(boolean pIsPrivate) Indicates whether this metadata document is private.
void	setIsRoot(boolean pIsRoot) Indicates whether this metadata document is the root document.
void	setMetadataURL(String pUrl) URL of metadata document on server.
void	setOnlink(String onlink) The online linkage contained within this document.
void	setOwner(String pOwner) ArcIMS authenticated user owning metadata document.
void	setParentDataset(String pDataset) Name of parent of metadata document on server.
void	setParentOwner(String pOwner) ArcIMS authenticated user owning parent of metadata document.
void	setParentUserID(String pUserID) Unique id (UUID) of parent of metadata document.
void	setRefCount(int pRefCount) 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 pUrl) URL of thumbnail image on server.
void	setUserID(String pUserID) Unique id (UUID) of metadata document.

Method Detail

setDataset

void setDataset(String pDataset)
                throws IOException,
                       AutomationException

Name of metadata document on server.

Product Availability

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

Parameters:

pDataset - The pDataset (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 Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOwner

void setOwner(String pOwner)
              throws IOException,
                     AutomationException

ArcIMS authenticated user owning metadata document.

Product Availability

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

Parameters:

pOwner - The pOwner (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 Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pOwner

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserID

void setUserID(String pUserID)
               throws IOException,
                      AutomationException

Unique id (UUID) of metadata document.

Product Availability

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

Parameters:

pUserID - The pUserID (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 Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pUserID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentDataset

void setParentDataset(String pDataset)
                      throws IOException,
                             AutomationException

Name of parent of metadata document on server.

Product Availability

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

Parameters:

pDataset - The pDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParentDataset

String getParentDataset()
                        throws IOException,
                               AutomationException

Name of parent of metadata document on server.

Product Availability

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

Returns:

The pDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentOwner

void setParentOwner(String pOwner)
                    throws IOException,
                           AutomationException

ArcIMS authenticated user owning parent of metadata document.

Product Availability

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

Parameters:

pOwner - The pOwner (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParentOwner

String getParentOwner()
                      throws IOException,
                             AutomationException

ArcIMS authenticated user owning parent of metadata document.

Product Availability

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

Returns:

The pOwner

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentUserID

void setParentUserID(String pUserID)
                     throws IOException,
                            AutomationException

Unique id (UUID) of parent of metadata document.

Product Availability

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

Parameters:

pUserID - The pUserID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParentUserID

String getParentUserID()
                       throws IOException,
                              AutomationException

Unique id (UUID) of parent of metadata document.

Product Availability

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

Returns:

The pUserID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMetadataURL

void setMetadataURL(String pUrl)
                    throws IOException,
                           AutomationException

URL of metadata document on server.

Product Availability

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

Parameters:

pUrl - The pUrl (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 Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pUrl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setThumbnailURL

void setThumbnailURL(String pUrl)
                     throws IOException,
                            AutomationException

URL of thumbnail image on server.

Product Availability

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

Parameters:

pUrl - The pUrl (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 Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pUrl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsFolder

void setIsFolder(boolean pIsFolder)
                 throws IOException,
                        AutomationException

Indicates whether this metadata document is a folder.

Product Availability

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

Parameters:

pIsFolder - The pIsFolder (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 Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pIsFolder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsRoot

void setIsRoot(boolean pIsRoot)
               throws IOException,
                      AutomationException

Indicates whether this metadata document is the root document.

Product Availability

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

Parameters:

pIsRoot - The pIsRoot (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 Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pIsRoot

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsPrivateDocument

void setIsPrivateDocument(boolean pIsPrivate)
                          throws IOException,
                                 AutomationException

Indicates whether this metadata document is private.

Product Availability

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

Parameters:

pIsPrivate - The pIsPrivate (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 Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pIsPrivate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRefCount

void setRefCount(int pRefCount)
                 throws IOException,
                        AutomationException

The number of references to this document on the server.

Product Availability

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

Parameters:

pRefCount - The pRefCount (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 Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pRefCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtentByRef

void setExtentByRef(IEnvelope ppExtent)
                    throws IOException,
                           AutomationException

The extent of the dataset represented by this document.

Product Availability

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

Parameters:

ppExtent - 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 Engine, ArcGIS Desktop, and ArcGIS Server.

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 Engine, ArcGIS Desktop, and ArcGIS Server.

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 Engine, ArcGIS Desktop, and ArcGIS Server.

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 Engine, ArcGIS Desktop, and ArcGIS Server.

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 Engine, ArcGIS Desktop, and ArcGIS Server.

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 Engine, ArcGIS Desktop, and ArcGIS Server.

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 Engine, ArcGIS Desktop, and ArcGIS Server.

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 Engine, ArcGIS Desktop, and ArcGIS Server.

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 pIndexStatus)
                    throws IOException,
                           AutomationException

Indicates whether this document is indexed on the server.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.