com.esri.arcgis.system
Interface IUID

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IUIDProxy, UID

public interface IUID

extends java.io.Serializable

Provides access to members that work with globally unique identifier objects.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

When To Use

Use the IUID interface to set the value of a UID object, set the subtype of the UID object, generate a new globally unique value, or compare two UID objects.

See Also:

UID

Method Summary

boolean	compare(IUID otherID) Indicates if the two UID objects represent the same globally unique identifier.
void	generate() Creates a new globally unique value for the UID object.
int	getSubType() The subtype of the UID object.
java.lang.Object	getValue() The value of the UID object.
void	setSubType(int subType) The subtype of the UID object.
void	setValue(java.lang.Object guidAsString) The value of the UID object.

Method Detail

getValue

public java.lang.Object getValue()
                          throws java.io.IOException,
                                 AutomationException

The value of the UID object.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Value property is a string representing either the CLSID or ProgID of an interface or coclass.

COM interfaces and coclasses are identified by a globally unique identifier (GUID). The GUID for an interface is called an interface ID (IID). The GUID for a coclass is called class ID (CLSID). A ProgID is a text alias for a CLSID; the ProgID is a string composed of the project name and the class name of the coclass.

ArcGIS Desktop developers can find the CLSID, ProgID, and subtype of a built-in command, menu, or toolbar in ArcMap or ArcCatalog, in the following technical documents:

ArcGIS Developer Help for Desktop developers > General reference > Names and IDs > ArcMap commands

ArcGIS Developer Help for Desktop developers > Technical General reference > Names and IDs > ArcCatalog commands

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(java.lang.Object guidAsString)
              throws java.io.IOException,
                     AutomationException

The value of the UID object.

Supported Platforms

Windows, Solaris, Linux

Parameters:

guidAsString - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generate

public void generate()
              throws java.io.IOException,
                     AutomationException

Creates a new globally unique value for the UID object.

Supported Platforms

Windows, Solaris, Linux

Description

Creates a new globally unique value (GUID) for the UID object. This is a 128-bit integer used for CLSIDs and interface identifiers.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubType

public int getSubType()
               throws java.io.IOException,
                      AutomationException

The subtype of the UID object.

Supported Platforms

Windows, Solaris, Linux

Description

Use the SubType property when working with classes that implement ICommandSubType that have multiple commands within a single class.

Returns:

The subType

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubType

public void setSubType(int subType)
                throws java.io.IOException,
                       AutomationException

The subtype of the UID object.

Supported Platforms

Windows, Solaris, Linux

Parameters:

subType - The subType (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

compare

public boolean compare(IUID otherID)
                throws java.io.IOException,
                       AutomationException

Indicates if the two UID objects represent the same globally unique identifier.

Supported Platforms

Windows, Solaris, Linux

Description

Returns a boolean indicating whether the specified UID object represents the same globally unique value (GUID) as this UID object.

Parameters:

otherID - A reference to a com.esri.arcgis.system.IUID (in)

Returns:

The bEqual

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.