com.esri.arcgis.gisclient
Class IMSMetadataServiceName

java.lang.Object
  com.esri.arcgis.gisclient.IMSMetadataServiceName

All Implemented Interfaces:

IMetadata, IIMSAxlRequest, IIMSMetadataAxlRequest, IIMSServiceDescription, IIMSUserRole, IRemoteMetadataName, IRemoteMetadataName2, com.esri.arcgis.interop.RemoteObjRef, IName, IPersist, IPersistStream, Externalizable, Serializable

public class IMSMetadataServiceName
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IIMSServiceDescription, IIMSAxlRequest, IMetadata, IName, IPersist, IPersistStream, IRemoteMetadataName, IIMSMetadataAxlRequest, IIMSUserRole, IRemoteMetadataName2, Externalizable

ArIMS Metadata Service Name Object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

IMSMetadataServiceName()
Constructs a IMSMetadataServiceName using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IPropertySet	getConnectionProperties() True if the service is free.
String	getContentType() The content type of the metadata document.
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.
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() Service Name.
String	getNameString() The name string of the object.
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.
Object	getPassword() Password for the specified service.
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	getServerVersion(ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages) The ArcIMS server version.
String	getService() The name of the ArcIMS service represented by this document.
int	getServiceType() Type of service.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
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
void	isDirty() isDirty
boolean	isFolder() Indicates whether this metadata document is a folder.
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.
void	load(IStream pstm) load
Object	open() Opens the object referred to by this name.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
String	sendAxlRequest(String axl, boolean queryRequest, ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages) Sends an Axl request.
IStream	sendAxlRequestStream(String axl, boolean queryRequest, ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages) Sends an Axl request and returns a stream.
String	sendCommandRequest(String command, ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages) Sends a command request,i.e.: ConnectorPing.
String	sendMetadataAxlRequest(String axl, ITrackCancel pTrackCancel) Sends an Axl request.
void	setConnectionProperties(IPropertySet connectionProperties) True if the service is free.
void	setContentType(String pContentType) The content type of the metadata 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	setIsPrivate(boolean isPrivate) Indicates if the service is private (requires password).
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	setMetadata(IPropertySet ppPropertySet) The PropertySet containing metadata.
void	setMetadataURL(String pUrl) URL of metadata document on server.
void	setModifiedTime(String pModifiedTime) The modified date and time of the metadata document.
void	setName(String name) Service Name.
void	setNameString(String nameString) The name string of the object.
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	setPassword(String password) Password for the specified service.
void	setRefCount(int pRefCount) 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	setThumbnailURL(String pUrl) URL of thumbnail image on server.
void	setURL(String uRL) URL to ArcIMS server.
void	setUserID(String pUserID) 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.
void	writeExternal(ObjectOutput out)

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

IMSMetadataServiceName

public IMSMetadataServiceName()
                       throws IOException,
                              UnknownHostException

Constructs a IMSMetadataServiceName using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

IMSMetadataServiceName

public IMSMetadataServiceName(Object obj)
                       throws IOException

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

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

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

Service Name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IIMSServiceDescription

Returns:

The name

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.

sendAxlRequest

public String sendAxlRequest(String axl,
                             boolean queryRequest,
                             ITrackCancel trackCancel,
                             boolean showConnectingAVI,
                             boolean processMessages)
                      throws IOException,
                             AutomationException

Sends an Axl request.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

sendAxlRequest in interface IIMSAxlRequest

Parameters:

axl - The axl (in)

queryRequest - The queryRequest (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

showConnectingAVI - The showConnectingAVI (in)

processMessages - The processMessages (in)

Returns:

The response

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendAxlRequestStream

public IStream sendAxlRequestStream(String axl,
                                    boolean queryRequest,
                                    ITrackCancel trackCancel,
                                    boolean showConnectingAVI,
                                    boolean processMessages)
                             throws IOException,
                                    AutomationException

Sends an Axl request and returns a stream.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

sendAxlRequestStream in interface IIMSAxlRequest

Parameters:

axl - The axl (in)

queryRequest - The queryRequest (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

showConnectingAVI - The showConnectingAVI (in)

processMessages - The processMessages (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendCommandRequest

public String sendCommandRequest(String command,
                                 ITrackCancel trackCancel,
                                 boolean showConnectingAVI,
                                 boolean processMessages)
                          throws IOException,
                                 AutomationException

Sends a command request,i.e.: ConnectorPing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

sendCommandRequest in interface IIMSAxlRequest

Parameters:

command - The command (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

showConnectingAVI - The showConnectingAVI (in)

processMessages - The processMessages (in)

Returns:

The response

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerVersion

public String getServerVersion(ITrackCancel trackCancel,
                               boolean showConnectingAVI,
                               boolean processMessages)
                        throws IOException,
                               AutomationException

The ArcIMS server version.

Product Availability

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

Specified by:

getServerVersion in interface IIMSAxlRequest

Parameters:

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

showConnectingAVI - The showConnectingAVI (in)

processMessages - The processMessages (in)

Returns:

The serverVersion

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.

setNameString

public void setNameString(String nameString)
                   throws IOException,
                          AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNameString in interface IName

Parameters:

nameString - The nameString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameString

public String getNameString()
                     throws IOException,
                            AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IName

Returns:

The nameString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public Object open()
            throws IOException,
                   AutomationException

Opens the object referred to by this name.

Remarks

The Open method lets you instantiate the actual object given the name object.

Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.

Example:

IName   pName = pFeatureClassName; 
pFeatureClass = new IFeatureClassProxy(pName.open());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

open in interface IName

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataset

public void setDataset(String pDataset)
                throws IOException,
                       AutomationException

Name of metadata document on server.

Product Availability

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

Specified by:

setDataset in interface IRemoteMetadataName

Parameters:

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

Specified by:

getDataset in interface IRemoteMetadataName

Returns:

The pDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOwner

public void setOwner(String pOwner)
              throws IOException,
                     AutomationException

ArcIMS authenticated user owning metadata document.

Product Availability

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

Specified by:

setOwner in interface IRemoteMetadataName

Parameters:

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

Specified by:

getOwner in interface IRemoteMetadataName

Returns:

The pOwner

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserID

public void setUserID(String pUserID)
               throws IOException,
                      AutomationException

Unique id (UUID) of metadata document.

Product Availability

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

Specified by:

setUserID in interface IRemoteMetadataName

Parameters:

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

Specified by:

getUserID in interface IRemoteMetadataName

Returns:

The pUserID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentDataset

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

Specified by:

setParentDataset in interface IRemoteMetadataName

Parameters:

pDataset - The pDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParentDataset

public String getParentDataset()
                        throws IOException,
                               AutomationException

Name of parent of metadata document on server.

Product Availability

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

Specified by:

getParentDataset in interface IRemoteMetadataName

Returns:

The pDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentOwner

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

Specified by:

setParentOwner in interface IRemoteMetadataName

Parameters:

pOwner - The pOwner (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParentOwner

public String getParentOwner()
                      throws IOException,
                             AutomationException

ArcIMS authenticated user owning parent of metadata document.

Product Availability

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

Specified by:

getParentOwner in interface IRemoteMetadataName

Returns:

The pOwner

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentUserID

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

Specified by:

setParentUserID in interface IRemoteMetadataName

Parameters:

pUserID - The pUserID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParentUserID

public String getParentUserID()
                       throws IOException,
                              AutomationException

Unique id (UUID) of parent of metadata document.

Product Availability

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

Specified by:

getParentUserID in interface IRemoteMetadataName

Returns:

The pUserID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMetadataURL

public void setMetadataURL(String pUrl)
                    throws IOException,
                           AutomationException

URL of metadata document on server.

Product Availability

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

Specified by:

setMetadataURL in interface IRemoteMetadataName

Parameters:

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

Specified by:

getMetadataURL in interface IRemoteMetadataName

Returns:

The pUrl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setThumbnailURL

public void setThumbnailURL(String pUrl)
                     throws IOException,
                            AutomationException

URL of thumbnail image on server.

Product Availability

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

Specified by:

setThumbnailURL in interface IRemoteMetadataName

Parameters:

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

Specified by:

getThumbnailURL in interface IRemoteMetadataName

Returns:

The pUrl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsFolder

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

Specified by:

setIsFolder in interface IRemoteMetadataName

Parameters:

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

Specified by:

isFolder in interface IRemoteMetadataName

Returns:

The pIsFolder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsRoot

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

Specified by:

setIsRoot in interface IRemoteMetadataName

Parameters:

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

Specified by:

isRoot in interface IRemoteMetadataName

Returns:

The pIsRoot

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsPrivateDocument

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

Specified by:

setIsPrivateDocument in interface IRemoteMetadataName

Parameters:

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

Specified by:

isPrivateDocument in interface IRemoteMetadataName

Returns:

The pIsPrivate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRefCount

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

Specified by:

setRefCount in interface IRemoteMetadataName

Parameters:

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

Specified by:

getRefCount in interface IRemoteMetadataName

Returns:

The pRefCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtentByRef

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

Specified by:

setExtentByRef in interface IRemoteMetadataName

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

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

Specified by:

getExtent in interface IRemoteMetadataName

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

Specified by:

setOnlink in interface IRemoteMetadataName

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

Specified by:

getOnlink in interface IRemoteMetadataName

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

Specified by:

setServer in interface IRemoteMetadataName

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

Specified by:

getServer in interface IRemoteMetadataName

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

Specified by:

setService in interface IRemoteMetadataName

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

Specified by:

getService in interface IRemoteMetadataName

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

Specified by:

getIndexStatus in interface IRemoteMetadataName

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

Indicates whether this document is indexed on the server.

Product Availability

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

Specified by:

setIndexStatus in interface IRemoteMetadataName

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.

sendMetadataAxlRequest

public String sendMetadataAxlRequest(String axl,
                                     ITrackCancel pTrackCancel)
                              throws IOException,
                                     AutomationException

Sends an Axl request.

Product Availability

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

Specified by:

sendMetadataAxlRequest in interface IIMSMetadataAxlRequest

Parameters:

axl - The axl (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

The response

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.

getContentType

public String getContentType()
                      throws IOException,
                             AutomationException

The content type of the metadata document.

Product Availability

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

Specified by:

getContentType in interface IRemoteMetadataName2

Returns:

The pContentType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContentType

public void setContentType(String pContentType)
                    throws IOException,
                           AutomationException

The content type of the metadata document.

Product Availability

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

Specified by:

setContentType in interface IRemoteMetadataName2

Parameters:

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

Specified by:

getModifiedTime in interface IRemoteMetadataName2

Returns:

The pModifiedTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setModifiedTime

public void setModifiedTime(String pModifiedTime)
                     throws IOException,
                            AutomationException

The modified date and time of the metadata document.

Product Availability

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

Specified by:

setModifiedTime in interface IRemoteMetadataName2

Parameters:

pModifiedTime - The pModifiedTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException