com.esri.arcgis.catalog
Class IMSMetadataService

java.lang.Object
  com.esri.arcgis.catalog.IMSMetadataService

All Implemented Interfaces:

IGxLayerSource, IGxObject, IGxObjectContainer, IGxObjectDeleteOptions, IGxObjectEdit, IGxObjectInternalName, IGxObjectProperties, IGxObjectSort, IGxObjectUI, IGxPasteTarget, IGxThumbnail, IRemoteMetadata, IRemoteMetadata2, IMetadata, IMetadataEdit, INativeTypeInfo, IIMSServiceDescription, IIMSUserRole, com.esri.arcgis.interop.RemoteObjRef, IClone, Serializable

public class IMSMetadataService
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxObject, IGxObjectEdit, IGxObjectUI, IGxLayerSource, IGxObjectContainer, IGxObjectDeleteOptions, IGxThumbnail, IIMSServiceDescription, IMetadata, IGxObjectProperties, INativeTypeInfo, IGxObjectInternalName, IMetadataEdit, IRemoteMetadata, IGxPasteTarget, IClone, IGxObjectSort, IIMSUserRole, IRemoteMetadata2

GxObject that represents ArcIMS Metadata Service.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

IMSMetadataService()
Constructs a IMSMetadataService using ArcGIS Engine.

IMSMetadataService(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
IMSMetadataService theIMSMetadataService = (IMSMetadataService) obj;

Method Summary

IGxObject	addChild(IGxObject child) Adds a new child and returns a reference to it.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	attach(IGxObject parent, IGxCatalog pCatalog) Attaches the object to its parent and the catalog.
boolean	canCopy() Indicates if the object can be copied.
boolean	canDelete() Indicates if the object can be deleted.
boolean	canPaste(IEnumName names, boolean[] moveOperation) Indicates if the specified names may be pasted into this object.
boolean	canRename() Indicates if the object can be renamed.
IGxObject	createChild(String server, String service, String userName, String password, boolean isFolder) Creates a new folder as a child of this folder.
void	delete() Deletes the object.
void	deleteChild(IGxObject child) Deletes the specified child object.
void	detach() Instructs the object to detach itself from its parent and the catalog.
void	editProperties(int hParent) Presents a modal dialog to allow editing the object's properties.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
String	getBaseName() The base name of the object (i.e.
String	getCategory() The category of the object.
IEnumGxObject	getChildren() An enumeration of the child objects.
IUID	getClassID() The class ID of this object.
static String	getClsid() getClsid.
IPropertySet	getConnectionProperties() True if the service is free.
String	getContentType() The content type of the metadata document.
IUID	getContextMenu() The class ID of the context menu for this object.
String	getDataset() Name of metadata document on server.
int	getDeleteOption() Behavior when deleting multiple objects.
IEnvelope	getExtent() The extent of the dataset represented by this document.
String	getFullName() The full name of the object.
int	getIndexStatus() Indicates whether this document is indexed on the server.
IName	getInternalObjectName() The Name for the internal object that this GxObject represents.
int	getLargeImage() The large image that represents the object.
int	getLargeSelectedImage() The large image that represents the object when it is selected.
IPropertySet	getMetadata() The PropertySet containing metadata.
String	getMetadataURL() URL of metadata document on server.
String	getModifiedTime() The modified date and time of the metadata document.
String	getName() The short name of the object.
INativeType	getNativeType() The native type.
IUID	getNewMenu() The class ID of the New menu for this object.
String	getOnlink() The online linkage contained within this document.
String	getOwner() ArcIMS authenticated user owning metadata document.
IGxObject	getParent() The parent of the object.
Object	getPassword() Password for the specified service.
void	getPropByIndex(int index, String[] name, Object[] value) The name and value of the indexed property in the GxObject.
Object	getProperty(String name) The value of the named property in the GxObject.
int	getPropertyCount() The number of properties in the GxObject.
int	getRefCount() The number of references to this document on the server.
int	getSecurity() Type of security set on the service.
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.
int	getServiceType() Type of service.
int	getSmallImage() The small image that represents the object.
int	getSmallSelectedImage() The small image that represents the object when it is selected.
IPicture	getThumbnail() The Thumbnail.
String	getThumbnailURL() URL of thumbnail image on server.
String	getURL() URL to ArcIMS server.
String	getUserID() Unique id (UUID) of metadata document.
String	getUserName() User name for the specified service.
int	getUserRole() User role.
int	hashCode() the hashcode for this object
boolean	isAreChildrenViewable() Indicates if the objects children are available for viewing in the tree-view.
boolean	isCanEditMetadata() Indicates if metadata can be edited.
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isFolder() Indicates whether this metadata document is a folder.
boolean	isHasChildren() Indicates if the object has any children.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isPrivate() Indicates if the service is private (requires password).
boolean	isPrivateDocument() Indicates whether this metadata document is private.
boolean	isRoot() Indicates whether this metadata document is the root document.
boolean	isSavePassword() Indicates if the password should be saved.
boolean	isShowDialogs() Indicates whether publishing status dialogs are shown.
boolean	isSortEnabled() Indicates if sorting is enabled for this GxObject.
boolean	isValid() Indicates if the object is still valid.
boolean	paste(IEnumName names, boolean[] moveOperation) Pastes the specified names into this object.
void	publishDatasets(IEnumName names) Publish the metadata of a set of datasets to an ArcIMS Metadata Server.
void	refresh() Updates the object and any children of the object.
void	rename(String newShortName) Renames the object.
void	setConnectionProperties(IPropertySet connectionProperties) True if the service is free.
void	setContentType(String contentType) The content type of the metadata document.
void	setDataset(String dataset) Name of metadata document on server.
void	setDeleteOption(int option) Behavior when deleting multiple objects.
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	setInternalObjectNameByRef(IName internalObjectName) The Name for the internal object that this GxObject represents.
void	setIsFolder(boolean isFolder) Indicates whether this metadata document is a folder.
void	setIsPrivate(boolean isPrivate) Indicates if the service is private (requires password).
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	setMetadata(IPropertySet ppPropertySet) The PropertySet containing metadata.
void	setMetadataURL(String uRL) URL of metadata document on server.
void	setModifiedTime(String modifiedTime) The modified date and time of the metadata document.
void	setName(String name) Service Name.
void	setOnlink(String onlink) The online linkage contained within this document.
void	setOwner(String owner) ArcIMS authenticated user owning metadata document.
void	setPassword(String password) Password for the specified service.
void	setProperty(String name, Object value) Set the value of the named property in the GxObject.
void	setRefCount(int refCount) The number of references to this document on the server.
void	setSavePassword(boolean flag) Indicates if the password should be saved.
void	setSecurity(int security) Type of security set on the service.
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	setServiceType(int type) Type of service.
void	setShowDialogs(boolean show) Indicates whether publishing status dialogs are shown.
void	setSortEnabled(boolean path) Indicates if sorting is enabled for this GxObject.
void	setThumbnailByRef(IPicture picture) The Thumbnail.
void	setThumbnailURL(String uRL) URL of thumbnail image on server.
void	setURL(String uRL) URL to ArcIMS server.
void	setUserID(String userID) Unique id (UUID) of metadata document.
void	setUserName(String userName) User name for the specified service.
void	setUserRole(int role) User role.
void	synchronize(int action, int interval) Updates metadata with the current properties; may create metadata if it doesn't already exist.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

IMSMetadataService

public IMSMetadataService()
                   throws IOException,
                          UnknownHostException

Constructs a IMSMetadataService using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

IMSMetadataService

public IMSMetadataService(Object obj)
                   throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
IMSMetadataService theIMSMetadataService = (IMSMetadataService) obj;

Construct a IMSMetadataService using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to IMSMetadataService.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

The short name of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IGxObject

Specified by:

getName in interface IIMSServiceDescription

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullName

public String getFullName()
                   throws IOException,
                          AutomationException

The full name of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getFullName in interface IGxObject

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseName

public String getBaseName()
                   throws IOException,
                          AutomationException

The base name of the object (i.e. no extension).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getBaseName in interface IGxObject

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The category of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getCategory in interface IGxObject

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParent

public IGxObject getParent()
                    throws IOException,
                           AutomationException

The parent of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getParent in interface IGxObject

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.

getClassID

public IUID getClassID()
                throws IOException,
                       AutomationException

The class ID of this object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getClassID in interface IGxObject

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInternalObjectName

public IName getInternalObjectName()
                            throws IOException,
                                   AutomationException

The Name for the internal object that this GxObject represents.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getInternalObjectName in interface IGxObject

Specified by:

getInternalObjectName in interface IGxObjectInternalName

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException

Indicates if the object is still valid.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isValid in interface IGxObject

Returns:

The isValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

attach

public void attach(IGxObject parent,
                   IGxCatalog pCatalog)
            throws IOException,
                   AutomationException

Attaches the object to its parent and the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

attach in interface IGxObject

Parameters:

parent - A reference to a com.esri.arcgis.catalog.IGxObject (in)

pCatalog - A reference to a com.esri.arcgis.catalog.IGxCatalog (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

detach

public void detach()
            throws IOException,
                   AutomationException

Instructs the object to detach itself from its parent and the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

detach in interface IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Updates the object and any children of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

refresh in interface IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canRename

public boolean canRename()
                  throws IOException,
                         AutomationException

Indicates if the object can be renamed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

canRename in interface IGxObjectEdit

Returns:

The canRename

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rename

public void rename(String newShortName)
            throws IOException,
                   AutomationException

Renames the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

rename in interface IGxObjectEdit

Parameters:

newShortName - The newShortName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws IOException,
                         AutomationException

Indicates if the object can be deleted.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

canDelete in interface IGxObjectEdit

Returns:

The canDelete

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws IOException,
                   AutomationException

Deletes the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

delete in interface IGxObjectEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

editProperties

public void editProperties(int hParent)
                    throws IOException,
                           AutomationException

Presents a modal dialog to allow editing the object's properties.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

editProperties in interface IGxObjectEdit

Parameters:

hParent - The hParent (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canCopy

public boolean canCopy()
                throws IOException,
                       AutomationException

Indicates if the object can be copied.

Remarks

CanCopy must return True if your customized GxObject is intended to support copy/paste, drag/drop within ArcCatalog or drag/drop from ArcCatalog to ArcMap.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

canCopy in interface IGxObjectEdit

Returns:

The canCopy

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws IOException,
                         AutomationException

The small image that represents the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSmallImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws IOException,
                                 AutomationException

The small image that represents the object when it is selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSmallSelectedImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws IOException,
                         AutomationException

The large image that represents the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getLargeImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws IOException,
                                 AutomationException

The large image that represents the object when it is selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getLargeSelectedImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContextMenu

public IUID getContextMenu()
                    throws IOException,
                           AutomationException

The class ID of the context menu for this object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getContextMenu in interface IGxObjectUI

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNewMenu

public IUID getNewMenu()
                throws IOException,
                       AutomationException

The class ID of the New menu for this object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getNewMenu in interface IGxObjectUI

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasChildren

public boolean isHasChildren()
                      throws IOException,
                             AutomationException

Indicates if the object has any children.

Remarks

Note: This property always return True even when it has no children. This was done to improve the overall ArcCatalog browsing performance.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isHasChildren in interface IGxObjectContainer

Returns:

The hasChildren

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildren

public IEnumGxObject getChildren()
                          throws IOException,
                                 AutomationException

An enumeration of the child objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getChildren in interface IGxObjectContainer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAreChildrenViewable

public boolean isAreChildrenViewable()
                              throws IOException,
                                     AutomationException

Indicates if the objects children are available for viewing in the tree-view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isAreChildrenViewable in interface IGxObjectContainer

Returns:

The areViewable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addChild

public IGxObject addChild(IGxObject child)
                   throws IOException,
                          AutomationException

Adds a new child and returns a reference to it. However, if a duplicate already exists, the function returns the existing child instead.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

addChild in interface IGxObjectContainer

Parameters:

child - A reference to a com.esri.arcgis.catalog.IGxObject (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.

deleteChild

public void deleteChild(IGxObject child)
                 throws IOException,
                        AutomationException

Deletes the specified child object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

deleteChild in interface IGxObjectContainer

Parameters:

child - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDeleteOption

public void setDeleteOption(int option)
                     throws IOException,
                            AutomationException

Behavior when deleting multiple objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setDeleteOption in interface IGxObjectDeleteOptions

Parameters:

option - A com.esri.arcgis.catalog.esriGxDeleteOption constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDeleteOption

public int getDeleteOption()
                    throws IOException,
                           AutomationException

Behavior when deleting multiple objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDeleteOption in interface IGxObjectDeleteOptions

Returns:

A com.esri.arcgis.catalog.esriGxDeleteOption constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setThumbnailByRef

public void setThumbnailByRef(IPicture picture)
                       throws IOException,
                              AutomationException

The Thumbnail.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setThumbnailByRef in interface IGxThumbnail

Parameters:

picture - A reference to a com.esri.arcgis.support.ms.stdole.IPicture (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThumbnail

public IPicture getThumbnail()
                      throws IOException,
                             AutomationException

The Thumbnail.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getThumbnail in interface IGxThumbnail

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.IPicture

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Service Name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IIMSServiceDescription

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getURL

public String getURL()
              throws IOException,
                     AutomationException

URL to ArcIMS server.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getURL in interface IIMSServiceDescription

Returns:

The uRL

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setURL

public void setURL(String uRL)
            throws IOException,
                   AutomationException

URL to ArcIMS server.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setURL in interface IIMSServiceDescription

Parameters:

uRL - The uRL (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserName

public void setUserName(String userName)
                 throws IOException,
                        AutomationException

User name for the specified service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUserName in interface IIMSServiceDescription

Parameters:

userName - The userName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserName

public String getUserName()
                   throws IOException,
                          AutomationException

User name for the specified service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUserName in interface IIMSServiceDescription

Returns:

The userName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPassword

public Object getPassword()
                   throws IOException,
                          AutomationException

Password for the specified service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPassword in interface IIMSServiceDescription

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPassword

public void setPassword(String password)
                 throws IOException,
                        AutomationException

Password for the specified service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPassword in interface IIMSServiceDescription

Parameters:

password - The password (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSavePassword

public boolean isSavePassword()
                       throws IOException,
                              AutomationException

Indicates if the password should be saved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSavePassword in interface IIMSServiceDescription

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSavePassword

public void setSavePassword(boolean flag)
                     throws IOException,
                            AutomationException

Indicates if the password should be saved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSavePassword in interface IIMSServiceDescription

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceType

public int getServiceType()
                   throws IOException,
                          AutomationException

Type of service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getServiceType in interface IIMSServiceDescription

Returns:

A com.esri.arcgis.gisclient.acServiceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServiceType

public void setServiceType(int type)
                    throws IOException,
                           AutomationException

Type of service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setServiceType in interface IIMSServiceDescription

Parameters:

type - A com.esri.arcgis.gisclient.acServiceType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSecurity

public int getSecurity()
                throws IOException,
                       AutomationException

Type of security set on the service. Use a combination of acSecurityType constants.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSecurity in interface IIMSServiceDescription

Returns:

The security

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSecurity

public void setSecurity(int security)
                 throws IOException,
                        AutomationException

Type of security set on the service. Use a combination of acSecurityType constants.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSecurity in interface IIMSServiceDescription

Parameters:

security - The security (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPrivate

public boolean isPrivate()
                  throws IOException,
                         AutomationException

Indicates if the service is private (requires password).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isPrivate in interface IIMSServiceDescription

Returns:

The isPrivate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsPrivate

public void setIsPrivate(boolean isPrivate)
                  throws IOException,
                         AutomationException

Indicates if the service is private (requires password).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIsPrivate in interface IIMSServiceDescription

Parameters:

isPrivate - The isPrivate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionProperties

public IPropertySet getConnectionProperties()
                                     throws IOException,
                                            AutomationException

True if the service is free.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getConnectionProperties in interface IIMSServiceDescription

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.

setConnectionProperties

public void setConnectionProperties(IPropertySet connectionProperties)
                             throws IOException,
                                    AutomationException

True if the service is free.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setConnectionProperties in interface IIMSServiceDescription

Parameters:

connectionProperties - 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.

getMetadata

public IPropertySet getMetadata()
                         throws IOException,
                                AutomationException

The PropertySet containing metadata.

Remarks

The variable to hold the data must be of IPropertySet data type.

The metadata property is frequently used to save, or update, changes to metadata documents that have taken place through methods available on the IPropertySet, IXmlPropertySet, and/or IXmlPropertySet2 interfaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMetadata in interface IMetadata

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

public void setMetadata(IPropertySet ppPropertySet)
                 throws IOException,
                        AutomationException

The PropertySet containing metadata.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMetadata in interface IMetadata

Parameters:

ppPropertySet - 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.

synchronize

public void synchronize(int action,
                        int interval)
                 throws IOException,
                        AutomationException

Updates metadata with the current properties; may create metadata if it doesn't already exist.

Description

The Synchronize method is used to extract metadata properties from an object and write those properties to the metadata .xml. Depending on the value of the esriMetaSyncAction, the Synchronize method may generate a new set of metadata if it doesn't already exist.

Remarks

The following actions will result in synchronization given each of the listed conditions:

Action	Metadata status	Esri/Sync element	Interval parameter
esriMSAAccessed	Doesn't matter	Must not be FALSE	Must be less than actual interval
esriMSAAlways	Doesn't matter	Doesn't matter	Doesn't matter
esriMSACreated	Must not exist	Must not be FALSE	Must be less than actual interval
esriMSANotCreated	Must exist	Must not be FALSE	Must be less than actual interval
esriMSAOverwrite	Doesn't matter	Doesn't matter	Doesn't matter

The difference between esriMSAAlways and esriMSAOverwrite lies in which elements are synchronized. esriMSAAlways will honor the removal or value change of an element's Sync attribute (to disable synchronization), whereas using esriMSAOverwrite is equivalent to setting the IXmlPropertySet2.OverwriteSyncAttribute to true for the metadata's property set, meaning that even elements without a Sync attribute of TRUE will be synchronized.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

synchronize in interface IMetadata

Parameters:

action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertyCount

public int getPropertyCount()
                     throws IOException,
                            AutomationException

The number of properties in the GxObject.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getPropertyCount in interface IGxObjectProperties

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropByIndex

public void getPropByIndex(int index,
                           String[] name,
                           Object[] value)
                    throws IOException,
                           AutomationException

The name and value of the indexed property in the GxObject.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getPropByIndex in interface IGxObjectProperties

Parameters:

index - The index (in)

name - The name (in/out: use single element array)

value - A Variant (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperty

public Object getProperty(String name)
                   throws IOException,
                          AutomationException

The value of the named property in the GxObject.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getProperty in interface IGxObjectProperties

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProperty

public void setProperty(String name,
                        Object value)
                 throws IOException,
                        AutomationException

Set the value of the named property in the GxObject.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setProperty in interface IGxObjectProperties

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNativeType

public INativeType getNativeType()
                          throws IOException,
                                 AutomationException

The native type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNativeType in interface INativeTypeInfo

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInternalObjectNameByRef

public void setInternalObjectNameByRef(IName internalObjectName)
                                throws IOException,
                                       AutomationException

The Name for the internal object that this GxObject represents.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setInternalObjectNameByRef in interface IGxObjectInternalName

Parameters:

internalObjectName - A reference to a com.esri.arcgis.system.IName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanEditMetadata

public boolean isCanEditMetadata()
                          throws IOException,
                                 AutomationException

Indicates if metadata can be edited.

Remarks

This property is available to those objects that support metadata.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCanEditMetadata in interface IMetadataEdit

Returns:

The pCanEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataset

public void setDataset(String dataset)
                throws IOException,
                       AutomationException

Name of metadata document on server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setDataset in interface IRemoteMetadata

Parameters:

dataset - The dataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataset

public String getDataset()
                  throws IOException,
                         AutomationException

Name of metadata document on server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDataset in interface IRemoteMetadata

Returns:

The dataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOwner

public void setOwner(String owner)
              throws IOException,
                     AutomationException

ArcIMS authenticated user owning metadata document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setOwner in interface IRemoteMetadata

Parameters:

owner - The owner (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOwner

public String getOwner()
                throws IOException,
                       AutomationException

ArcIMS authenticated user owning metadata document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getOwner in interface IRemoteMetadata

Returns:

The owner

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserID

public void setUserID(String userID)
               throws IOException,
                      AutomationException

Unique id (UUID) of metadata document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setUserID in interface IRemoteMetadata

Parameters:

userID - The userID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserID

public String getUserID()
                 throws IOException,
                        AutomationException

Unique id (UUID) of metadata document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getUserID in interface IRemoteMetadata

Returns:

The userID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMetadataURL

public void setMetadataURL(String uRL)
                    throws IOException,
                           AutomationException

URL of metadata document on server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setMetadataURL in interface IRemoteMetadata

Parameters:

uRL - The uRL (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMetadataURL

public String getMetadataURL()
                      throws IOException,
                             AutomationException

URL of metadata document on server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getMetadataURL in interface IRemoteMetadata

Returns:

The uRL

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setThumbnailURL

public void setThumbnailURL(String uRL)
                     throws IOException,
                            AutomationException

URL of thumbnail image on server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setThumbnailURL in interface IRemoteMetadata

Parameters:

uRL - The uRL (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThumbnailURL

public String getThumbnailURL()
                       throws IOException,
                              AutomationException

URL of thumbnail image on server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getThumbnailURL in interface IRemoteMetadata

Returns:

The uRL

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createChild

public 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

Specified by:

createChild in interface IRemoteMetadata

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

public void setHasChildren(boolean rhs1)
                    throws IOException,
                           AutomationException

Indicates whether this folder has children.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setHasChildren in interface IRemoteMetadata

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsFolder

public void setIsFolder(boolean isFolder)
                 throws IOException,
                        AutomationException

Indicates whether this metadata document is a folder.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setIsFolder in interface IRemoteMetadata

Parameters:

isFolder - The isFolder (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFolder

public boolean isFolder()
                 throws IOException,
                        AutomationException

Indicates whether this metadata document is a folder.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isFolder in interface IRemoteMetadata

Returns:

The isFolder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsRoot

public 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

Specified by:

setIsRoot in interface IRemoteMetadata

Parameters:

isRoot - The isRoot (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRoot

public boolean isRoot()
               throws IOException,
                      AutomationException

Indicates whether this metadata document is the root document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isRoot in interface IRemoteMetadata

Returns:

The isRoot

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsPrivateDocument

public void setIsPrivateDocument(boolean isPrivate)
                          throws IOException,
                                 AutomationException

Indicates whether this metadata document is private.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setIsPrivateDocument in interface IRemoteMetadata

Parameters:

isPrivate - The isPrivate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPrivateDocument

public boolean isPrivateDocument()
                          throws IOException,
                                 AutomationException

Indicates whether this metadata document is private.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isPrivateDocument in interface IRemoteMetadata

Returns:

The isPrivate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

publishDatasets

public 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

Specified by:

publishDatasets in interface IRemoteMetadata

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

public 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

Specified by:

setRefCount in interface IRemoteMetadata

Parameters:

refCount - The refCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRefCount

public int getRefCount()
                throws IOException,
                       AutomationException

The number of references to this document on the server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getRefCount in interface IRemoteMetadata

Returns:

The refCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtentByRef

public void setExtentByRef(IEnvelope extent)
                    throws IOException,
                           AutomationException

The extent of the dataset represented by this document.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setExtentByRef in interface IRemoteMetadata

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

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the dataset represented by this document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getExtent in interface IRemoteMetadata

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

public void setOnlink(String onlink)
               throws IOException,
                      AutomationException

The online linkage contained within this document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setOnlink in interface IRemoteMetadata

Parameters:

onlink - The onlink (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOnlink

public String getOnlink()
                 throws IOException,
                        AutomationException

The online linkage contained within this document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getOnlink in interface IRemoteMetadata

Returns:

The onlink

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServer

public 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

Specified by:

setServer in interface IRemoteMetadata

Parameters:

server - The server (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServer

public 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

Specified by:

getServer in interface IRemoteMetadata

Returns:

The server

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setService

public 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

Specified by:

setService in interface IRemoteMetadata

Parameters:

service - The service (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getService

public String getService()
                  throws IOException,
                         AutomationException

The name of the ArcIMS service represented by this document.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getService in interface IRemoteMetadata

Returns:

The service

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIndexStatus

public int getIndexStatus()
                   throws IOException,
                          AutomationException

Indicates whether this document is indexed on the server.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getIndexStatus in interface IRemoteMetadata

Returns:

A com.esri.arcgis.gisclient.acIndexStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndexStatus

public 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

Specified by:

setIndexStatus in interface IRemoteMetadata

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.

canPaste

public boolean canPaste(IEnumName names,
                        boolean[] moveOperation)
                 throws IOException,
                        AutomationException

Indicates if the specified names may be pasted into this object. On output, moveOperation indicates if a subsequent paste operation would represent a move, or merely a copy, operation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

canPaste in interface IGxPasteTarget

Parameters:

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

moveOperation - The moveOperation (in/out: use single element array)

Returns:

The canPaste

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

paste

public boolean paste(IEnumName names,
                     boolean[] moveOperation)
              throws IOException,
                     AutomationException

Pastes the specified names into this object. On input, moveOperation indicates if this is a move operation. On output, it indicates if the objects have been moved, or merely copied.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

paste in interface IGxPasteTarget

Parameters:

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

moveOperation - The moveOperation (in/out: use single element array)

Returns:

The successfulPaste

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSortEnabled

public void setSortEnabled(boolean path)
                    throws IOException,
                           AutomationException

Indicates if sorting is enabled for this GxObject.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setSortEnabled in interface IGxObjectSort

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSortEnabled

public boolean isSortEnabled()
                      throws IOException,
                             AutomationException

Indicates if sorting is enabled for this GxObject.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isSortEnabled in interface IGxObjectSort

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserRole

public int getUserRole()
                throws IOException,
                       AutomationException

User role.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUserRole in interface IIMSUserRole

Returns:

A com.esri.arcgis.gisclient.acUserRole constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserRole

public void setUserRole(int role)
                 throws IOException,
                        AutomationException

User role.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUserRole in interface IIMSUserRole

Parameters:

role - A com.esri.arcgis.gisclient.acUserRole constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowDialogs

public boolean isShowDialogs()
                      throws IOException,
                             AutomationException

Indicates whether publishing status dialogs are shown.

Product Availability

Available with ArcGIS Desktop.

Specified by:

isShowDialogs in interface IRemoteMetadata2

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowDialogs

public void setShowDialogs(boolean show)
                    throws IOException,
                           AutomationException

Indicates whether publishing status dialogs are shown.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setShowDialogs in interface IRemoteMetadata2

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContentType

public String getContentType()
                      throws IOException,
                             AutomationException

The content type of the metadata document.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getContentType in interface IRemoteMetadata2

Returns:

The contentType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContentType

public void setContentType(String contentType)
                    throws IOException,
                           AutomationException

The content type of the metadata document.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setContentType in interface IRemoteMetadata2

Parameters:

contentType - The contentType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getModifiedTime

public String getModifiedTime()
                       throws IOException,
                              AutomationException

The modified date and time of the metadata document.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getModifiedTime in interface IRemoteMetadata2

Returns:

The modifiedTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setModifiedTime

public void setModifiedTime(String modifiedTime)
                     throws IOException,
                            AutomationException

The modified date and time of the metadata document.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setModifiedTime in interface IRemoteMetadata2

Parameters:

modifiedTime - The modifiedTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.