com.esri.arcgis.carto
Class IParameterInfoProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IParameterInfoProxy

All Implemented Interfaces:

IParameterInfo, Externalizable, Serializable

public class IParameterInfoProxy
extends com.esri.arcgis.interop.Dispatch
implements IParameterInfo, Serializable

Provides generic access to object parameters for GP framework.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IParameterInfoProxy()
	IParameterInfoProxy(Object obj)
protected	IParameterInfoProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
IGPDataType	getDataType(int indexParam) Get parameter type.
int	getDependency(int indexParam) Get parameter dependency.
IGPDomain	getDomain(int indexParam) Get parameter domain.
String	getLabel(int indexParam) Gets parameter label.
String	getName(int indexParam) Gets parameter name.
String	getObjectLabel() Gets object UI label.
String	getObjectSubType() Gets object sub-type name.
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	removeListener(String iidStr, Object theListener)
void	setValue(int indexParam, IGPValue ppGPValue) Gets parameter value.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IParameterInfoProxy

public IParameterInfoProxy()

IParameterInfoProxy

public IParameterInfoProxy(Object obj)
                    throws IOException

Throws:

IOException

IParameterInfoProxy

protected IParameterInfoProxy(Object obj,
                              String iid)
                       throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getParameterCount

public int getParameterCount()
                      throws IOException,
                             AutomationException

Number of exposed parameters.

Product Availability

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

Specified by:

getParameterCount in interface IParameterInfo

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName(int indexParam)
               throws IOException,
                      AutomationException

Gets parameter name.

Product Availability

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

Specified by:

getName in interface IParameterInfo

Parameters:

indexParam - The indexParam (in)

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel(int indexParam)
                throws IOException,
                       AutomationException

Gets parameter label.

Product Availability

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

Specified by:

getLabel in interface IParameterInfo

Parameters:

indexParam - The indexParam (in)

Returns:

The pLabel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataType

public IGPDataType getDataType(int indexParam)
                        throws IOException,
                               AutomationException

Get parameter type.

Product Availability

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

Specified by:

getDataType in interface IParameterInfo

Parameters:

indexParam - The indexParam (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDomain

public IGPDomain getDomain(int indexParam)
                    throws IOException,
                           AutomationException

Get parameter domain.

Product Availability

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

Specified by:

getDomain in interface IParameterInfo

Parameters:

indexParam - The indexParam (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDependency

public int getDependency(int indexParam)
                  throws IOException,
                         AutomationException

Get parameter dependency.

Product Availability

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

Specified by:

getDependency in interface IParameterInfo

Parameters:

indexParam - The indexParam (in)

Returns:

The pIndexDependency

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOptional

public boolean isOptional(int indexParam)
                   throws IOException,
                          AutomationException

Get parameter optional flag.

Product Availability

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

Specified by:

isOptional in interface IParameterInfo

Parameters:

indexParam - The indexParam (in)

Returns:

The pOptional

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

public IGPValue getValue(int indexParam)
                  throws IOException,
                         AutomationException

Gets parameter value.

Product Availability

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

Specified by:

getValue in interface IParameterInfo

Parameters:

indexParam - The indexParam (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(int indexParam,
                     IGPValue ppGPValue)
              throws IOException,
                     AutomationException

Gets parameter value.

Product Availability

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

Specified by:

setValue in interface IParameterInfo

Parameters:

indexParam - The indexParam (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectType

public String getObjectType()
                     throws IOException,
                            AutomationException

Gets object type name.

Product Availability

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

Specified by:

getObjectType in interface IParameterInfo

Returns:

The pObjectTypeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectSubType

public String getObjectSubType()
                        throws IOException,
                               AutomationException

Gets object sub-type name.

Product Availability

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

Specified by:

getObjectSubType in interface IParameterInfo

Returns:

The pObjectSubTypeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectLabel

public String getObjectLabel()
                      throws IOException,
                             AutomationException

Gets object UI label.

Product Availability

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

Specified by:

getObjectLabel in interface IParameterInfo

Returns:

The pObjectLabel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.