com.esri.arcgis.geodatabase

Interface IGPDataType

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DENetworkDatasetType, IGPDataTypeProxy, NetworkTravelModeType

public interface IGPDataType
extends java.io.Serializable

COM Interface 'IGPDataType'. Generated 9/21/2023 10:01:46 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description: 'Provides access to members of a GP Data Type.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID172a93a9_afc1_432d_8f04_54b7309ba432
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
IGPValue	createValue(java.lang.String text) Creates a geoprocessing value object from the given string.
IUID	getControlCLSID() The COM class id of the data type.
java.lang.String	getDisplayName() The descriptive, user-friendly name.
IName	getFullName() The associated Name object.
int	getHelpContext() The context identifier of the topic within the help file.
java.lang.String	getHelpFile() The name of the (CHM) file containing help information.
java.lang.String	getMetadataFile() The name of the (XML) file containing the default metadata for this data type.
java.lang.String	getName() The name of the data type.
IGPMessage	validateDataType(IGPDataType type) Validates if a given geoprocessing data type object is valid.
IGPMessage	validateValue(IGPValue value, IGPDomain domain) Validates if a given geoprocessing value object is the correct data type.

Field Detail

IID172a93a9_afc1_432d_8f04_54b7309ba432

static final int IID172a93a9_afc1_432d_8f04_54b7309ba432

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                  throws java.io.IOException,
                         AutomationException

The name of the data type.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayName

java.lang.String getDisplayName()
                         throws java.io.IOException,
                                AutomationException

The descriptive, user-friendly name.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getControlCLSID

IUID getControlCLSID()
              throws java.io.IOException,
                     AutomationException

The COM class id of the data type.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullName

IName getFullName()
           throws java.io.IOException,
                  AutomationException

The associated Name object.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpFile

java.lang.String getHelpFile()
                      throws java.io.IOException,
                             AutomationException

The name of the (CHM) file containing help information.

Returns:

The file

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpContext

int getHelpContext()
            throws java.io.IOException,
                   AutomationException

The context identifier of the topic within the help file.

Returns:

The context

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMetadataFile

java.lang.String getMetadataFile()
                          throws java.io.IOException,
                                 AutomationException

The name of the (XML) file containing the default metadata for this data type.

Returns:

The file

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createValue

IGPValue createValue(java.lang.String text)
              throws java.io.IOException,
                     AutomationException

Creates a geoprocessing value object from the given string.

Parameters:

text - The text (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validateDataType

IGPMessage validateDataType(IGPDataType type)
                     throws java.io.IOException,
                            AutomationException

Validates if a given geoprocessing data type object is valid.

Parameters:

type - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validateValue

IGPMessage validateValue(IGPValue value,
                         IGPDomain domain)
                  throws java.io.IOException,
                         AutomationException

Validates if a given geoprocessing value object is the correct data type.

Parameters:

value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

domain - A reference to a com.esri.arcgis.geodatabase.IGPDomain (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.