com.esri.arcgis.schematic
Class NgParameters

java.lang.Object
  com.esri.arcgis.schematic.NgParameters

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INgParameters, ISupportErrorInfo, Serializable

public class NgParameters
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgParameters, ISupportErrorInfo

Parameters collection object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NgParameters()
Constructs a NgParameters using ArcGIS Engine.

NgParameters(Object obj)
Construct a NgParameters using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	add(INgParameter item) Adds a new parameter in the collection.
void	clear() Removes all the parameters from the collection.
boolean	equals(Object o) Compare this object with another
Enumeration	get_NewEnum() Retrieves an IEnumVariant interface that enumerates the collection's content.
static String	getClsid() getClsid.
int	getCount() Number of parameters in the collection.
INgParameter	getItem(int index) The parameter 'index' item in the collection.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	remove(int index) Removes the parameter 'index' item from the collection.

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

NgParameters

public NgParameters()
             throws IOException,
                    UnknownHostException

Constructs a NgParameters using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NgParameters

public NgParameters(Object obj)
             throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems NgParameters theNgParameters = (NgParameters) obj;

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

get_NewEnum

public Enumeration get_NewEnum()
                        throws IOException,
                               AutomationException

Retrieves an IEnumVariant interface that enumerates the collection's content. This method supports the FOR EACH statement in VB.

Product Availability

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

Specified by:

get_NewEnum in interface INgParameters

Returns:

An enumeration.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItem

public INgParameter getItem(int index)
                     throws IOException,
                            AutomationException

The parameter 'index' item in the collection.

Product Availability

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

Specified by:

getItem in interface INgParameters

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.schematic.INgParameter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

Number of parameters in the collection.

Product Availability

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

Specified by:

getCount in interface INgParameters

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public void add(INgParameter item)
         throws IOException,
                AutomationException

Adds a new parameter in the collection.

Product Availability

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

Specified by:

add in interface INgParameters

Parameters:

item - A reference to a com.esri.arcgis.schematic.INgParameter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int index)
            throws IOException,
                   AutomationException

Removes the parameter 'index' item from the collection.

Product Availability

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

Specified by:

remove in interface INgParameters

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException

Removes all the parameters from the collection.

Product Availability

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

Specified by:

clear in interface INgParameters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.