com.esri.arcgis.carto
Interface IParameterInfo

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IParameterInfoProxy

public interface IParameterInfo
extends java.io.Serializable

COM Interface 'IParameterInfo'. Generated 3/19/2015 1:20:54 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides generic access to object parameters for GP framework.' 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

static java.lang.String	IID Deprecated. Internal use only
static int	IID82f99956_a431_4a70_b460_772ac1203fa7
static int	xxDummy Deprecated. Internal use only

Method Summary

IGPDataType	getDataType(int indexParam) Get parameter type.
int	getDependency(int indexParam) Get parameter dependency.
IGPDomain	getDomain(int indexParam) Get parameter domain.
java.lang.String	getLabel(int indexParam) Gets parameter label.
java.lang.String	getName(int indexParam) Gets parameter name.
java.lang.String	getObjectLabel() Gets object UI label.
java.lang.String	getObjectSubType() Gets object sub-type name.
java.lang.String	getObjectType() Gets object type name.
int	getParameterCount() Number of exposed parameters.
IGPValue	getValue(int indexParam) Gets parameter value.
boolean	isOptional(int indexParam) Get parameter optional flag.
void	setValue(int indexParam, IGPValue ppGPValue) Gets parameter value.

Field Detail

IID82f99956_a431_4a70_b460_772ac1203fa7

static final int IID82f99956_a431_4a70_b460_772ac1203fa7

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

getParameterCount

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

Number of exposed parameters.

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

Gets parameter name.

Parameters:

indexParam - The indexParam (in)

Returns:

The pName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabel

java.lang.String getLabel(int indexParam)
                          throws java.io.IOException,
                                 AutomationException

Gets parameter label.

Parameters:

indexParam - The indexParam (in)

Returns:

The pLabel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataType

IGPDataType getDataType(int indexParam)
                        throws java.io.IOException,
                               AutomationException

Get parameter type.

Parameters:

indexParam - The indexParam (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDomain

IGPDomain getDomain(int indexParam)
                    throws java.io.IOException,
                           AutomationException

Get parameter domain.

Parameters:

indexParam - The indexParam (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDependency

int getDependency(int indexParam)
                  throws java.io.IOException,
                         AutomationException

Get parameter dependency.

Parameters:

indexParam - The indexParam (in)

Returns:

The pIndexDependency

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isOptional

boolean isOptional(int indexParam)
                   throws java.io.IOException,
                          AutomationException

Get parameter optional flag.

Parameters:

indexParam - The indexParam (in)

Returns:

The pOptional

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValue

IGPValue getValue(int indexParam)
                  throws java.io.IOException,
                         AutomationException

Gets parameter value.

Parameters:

indexParam - The indexParam (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.

setValue

void setValue(int indexParam,
              IGPValue ppGPValue)
              throws java.io.IOException,
                     AutomationException

Gets parameter value.

Parameters:

indexParam - The indexParam (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getObjectType

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

Gets object type name.

Returns:

The pObjectTypeName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getObjectSubType

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

Gets object sub-type name.

Returns:

The pObjectSubTypeName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getObjectLabel

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

Gets object UI label.

Returns:

The pObjectLabel

Throws:

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

AutomationException - If the ArcObject component throws an exception.