com.esri.arcgis.geoprocessing
Class GPParameter

java.lang.Object
  com.esri.arcgis.geoprocessing.GPParameter

All Implemented Interfaces:

IClone, IGPParameter, IGPParameter2, IGPParameterEdit, IGPParameterEdit2, IPersist, IPersistStream, IXMLSerialize, java.io.Serializable

public class GPParameter

extends java.lang.Object

implements IGPParameter, IGPParameterEdit, IClone, IPersistStream, IXMLSerialize, IGPParameter2, IGPParameterEdit2

Geoprocessing Parameter object.

Product Availability

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

Supported Platforms

Windows

Remarks

The GPParameter class is required to define and create parameters for a new geoprocessing tool. Parameters define the characteristics of the inputs and outputs to a geoprocessing tool. An instance of this object is first created. Properties are then set to define the data type, name, direction, etc.

For more information about using the GPParameter class, see Building Geoprocessing Function Tools.

See also IGPParameter; IGPParameterEdit.

See Also:

Serialized Form

Constructor Summary

GPParameter()
Constructs a GPParameter using ArcGIS Engine.

GPParameter(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	addDependency(java.lang.String name) Adds the name of a parameter that this geoprocessing parameter object is dependent on.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
IClone	getAsIClone() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGPParameter	getAsIGPParameter() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGPParameter2	getAsIGPParameter2() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGPParameterEdit	getAsIGPParameterEdit() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGPParameterEdit2	getAsIGPParameterEdit2() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IXMLSerialize	getAsIXMLSerialize() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
java.lang.String	getCategory() Category of the geoprocessing parameter.
IGPChoiceList	getChoiceList() The choice list object of the geoprocessing parameter.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
IUID	getControlCLSID() The class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing parameter.
IGPDataType	getDataType() Data type of the geoprocessing parameter.
java.lang.String	getDefaultEnvironmentName() The name of the environment value to use as the default value for the geoprocessing parameter.
int	getDirection() Direction of the geoprocessing parameter.
java.lang.String	getDisplayName() Display name of the geoprocessing parameter.
int	getDisplayOrder() The display order of the geoprocessing parameter.
IGPDomain	getDomain() Domain of the geoprocessing parameter.
java.lang.String	getName() Name of the geoprocessing parameter.
IEnumBSTR	getParameterDependencies() Enumeration of parameter names the geoprocessing parameter is dependent on.
int	getParameterType() Type of the geoprocessing parameter.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
IGPValue	getValue() The current value object of the geoprocessing parameter.
int	hashCode() the hashcode for this object
boolean	isAltered() Indicates whether the parameter value has been explicitly set (by the user).
void	isDirty() Supported Platforms
boolean	isEnabled() Indicates whether the ActiveX control for the geoprocessing parameter should be enabled/disabled.
boolean	isEqual(IClone other) Returns TRUE when the receiver and other have the same properties.
boolean	isHasBeenValidated() Indicates whether the parameter value has been modified since the last time the parameter was validated (i.e., since Validate() was called).
boolean	isIdentical(IClone other) Returns TRUE when the receiver and other are the same object.
boolean	isManaged() Indicates whether the parameter is managed.
void	load(IStream pstm) Supported Platforms
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAltered(boolean rhs1) Indicates whether the parameter value has been explicitly set (by the user).
void	setCategory(java.lang.String rhs1) Category of the geoprocessing parameter.
void	setChoiceListByRef(IGPChoiceList rhs1) The choice list object of the geoprocessing parameter.
void	setControlCLSID(IUID rhs1) The class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing parameter.
void	setDataTypeByRef(IGPDataType rhs1) Data type of the geoprocessing parameter.
void	setDefaultEnvironmentName(java.lang.String rhs1) The name of the environment value to use as the default value for the geoprocessing parameter.
void	setDirection(int rhs1) Direction of the geoprocessing parameter.
void	setDisplayName(java.lang.String rhs1) Display name of the geoprocessing parameter.
void	setDisplayOrder(int rhs1) The display order of the geoprocessing parameter.
void	setDomainByRef(IGPDomain rhs1) Domain of the geoprocessing parameter.
void	setEnabled(boolean rhs1) Indicates whether the ActiveX control for the geoprocessing parameter should be enabled/disabled.
void	setHasBeenValidated(boolean rhs1) Indicates whether the parameter value has been modified since the last time the parameter was validated (i.e., since Validate() was called).
void	setManaged(boolean rhs1) Indicates whether the parameter is managed.
void	setName(java.lang.String rhs1) Name of the geoprocessing parameter.
void	setParameterDependencies(IEnumBSTR rhs1) Enumeration of parameter names the geoprocessing parameter is dependent on.
void	setParameterType(int rhs1) Type of the geoprocessing parameter.
void	setValueByRef(IGPValue rhs1) The current value object of the geoprocessing parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

GPParameter

public GPParameter()
            throws java.io.IOException,
                   java.net.UnknownHostException

Constructs a GPParameter using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPParameter

public GPParameter(java.lang.Object obj)
            throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a GPParameter using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GPParameter.
GPParameter theGPParameter = (GPParameter) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIGPParameter

public IGPParameter getAsIGPParameter()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGPParameterEdit

public IGPParameterEdit getAsIGPParameterEdit()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIClone

public IClone getAsIClone()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIXMLSerialize

public IXMLSerialize getAsIXMLSerialize()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGPParameter2

public IGPParameter2 getAsIGPParameter2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGPParameterEdit2

public IGPParameterEdit2 getAsIGPParameterEdit2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getName

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

Description copied from interface: IGPParameter

Name of the geoprocessing parameter.

Supported Platforms

Windows

Remarks

The Name property value must not contain any spaces; correct value examples are: "inputFeature" or "input_featureclass".

Specified by:

getName in interface IGPParameter

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IGPFunction

getDisplayName

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

Description copied from interface: IGPParameter

Display name of the geoprocessing parameter.

Supported Platforms

Windows

Remarks

The DisplayName property stores the parameter's name that is exposed at the UI, for example "Input Features". This value can be internationalized.

Specified by:

getDisplayName in interface IGPParameter

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDirection

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

Description copied from interface: IGPParameter

Direction of the geoprocessing parameter.

Supported Platforms

Windows

Remarks

The Direction property is an enumeration of values for setting the direction of a parameter. Valid values are: esriGPParameterDirectionInput, esriGPParameterDirectionOutput.

Specified by:

getDirection in interface IGPParameter

Returns:

A com.esri.arcgis.geoprocessing.esriGPParameterDirection constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getDataType

public IGPDataType getDataType()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IGPParameter

Data type of the geoprocessing parameter.

Supported Platforms

Windows

Remarks

The DataType property defines and manages the type of data that can be used with a parameter. Examples include: FeatureClass, String, Boolean, Raster, and Table. So, if a parameter's data type is Table, then only table data can be entered. For a complete list of data type objects, check the IGPDataType in the ArcGIS Developer Help.

Specified by:

getDataType in interface IGPParameter

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getParameterType

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

Description copied from interface: IGPParameter

Type of the geoprocessing parameter.

Supported Platforms

Windows

Remarks

The ParameterType property is an enumeration of values for setting a geoprocessing function parameter's type. Three values are in this enumeration: esriGPParameterTypeRequired, esriGPParameterTypeOptional, and esriGPParameterTypeDerived.

Specified by:

getParameterType in interface IGPParameter

Returns:

A com.esri.arcgis.geoprocessing.esriGPParameterType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParameterDependencies

public IEnumBSTR getParameterDependencies()
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IGPParameter

Enumeration of parameter names the geoprocessing parameter is dependent on.

Supported Platforms

Windows

Remarks

The ParameterDependencies property is optional; it is used to set dependencies between parameters. For example, a field parameter is typically dependent on a table or feature class.

Specified by:

getParameterDependencies in interface IGPParameter

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getDomain

public IGPDomain getDomain()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IGPParameter

Domain of the geoprocessing parameter.

Supported Platforms

Windows

Remarks

The Domain property is used to set, limit, or filter valid values for a parameter. An example of the domain (RangeDomain) for a value object is limiting an integer to the range of 1 - 100. For a complete list of valid domain objects, refer to IGPDomain in the ArcGIS Developer Help.

Specified by:

getDomain in interface IGPParameter

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.

isEnabled

public boolean isEnabled()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IGPParameter

Indicates whether the ActiveX control for the geoprocessing parameter should be enabled/disabled.

Supported Platforms

Windows

Remarks

The Enabled property controls whether or not a parameter is visible at the UI.

Specified by:

isEnabled in interface IGPParameter

Returns:

The enabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValue

public IGPValue getValue()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IGPParameter

The current value object of the geoprocessing parameter.

Supported Platforms

Windows

Remarks

The Value property defines the value of a parameter's data type. For example, if the data type is FeatureClass, then the parameter's default value is FeatureClass. Values are the actual data inputs to a geoprocessing tool, containing scalars or the path to the data on disk. For the complete list of Value objects, refer to IGPValue in the ArcGIS Develop Help.

Specified by:

getValue in interface IGPParameter

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getControlCLSID

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

Description copied from interface: IGPParameter

The class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing parameter.

Supported Platforms

Windows

Remarks

The ControlCLSID property is optional; it is used to override the default control of the DataType. If no CLSID is supplied, then the control of the DataType is used.

Specified by:

getControlCLSID in interface IGPParameter

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getDefaultEnvironmentName

public java.lang.String getDefaultEnvironmentName()
                                           throws java.io.IOException,
                                                  AutomationException

Description copied from interface: IGPParameter

The name of the environment value to use as the default value for the geoprocessing parameter.

Supported Platforms

Windows

Remarks

The DefaultEnvironmentName property is optional; it initializes the default environment value for a geoprocessing tool parameter.

Specified by:

getDefaultEnvironmentName in interface IGPParameter

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayOrder

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

Description copied from interface: IGPParameter

The display order of the geoprocessing parameter.

Supported Platforms

Windows

Remarks

The DisplayOrder is optional; it stores the order in which parameters are displayed on a dialog. The usage display order is always the order of the values in the array. For example, in the ParameterInfo property the parameters ought to be ordered by required, optional, and derived.

Specified by:

getDisplayOrder in interface IGPParameter

Returns:

The displayOrder

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isAltered

public boolean isAltered()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IGPParameter

Indicates whether the parameter value has been explicitly set (by the user).

Supported Platforms

Windows

Specified by:

isAltered in interface IGPParameter

Returns:

The altered

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isHasBeenValidated

public boolean isHasBeenValidated()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IGPParameter

Indicates whether the parameter value has been modified since the last time the parameter was validated (i.e., since Validate() was called).

Supported Platforms

Windows

Specified by:

isHasBeenValidated in interface IGPParameter

Returns:

The validated

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IGPParameter

Category of the geoprocessing parameter.

Remarks

The Category property is optional; it is creates an expandable and collapsible section on a tool dialog. Use the Category property to "hide" many optional parameters of a function.

Specified by:

getCategory in interface IGPParameter

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getChoiceList

public IGPChoiceList getChoiceList()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IGPParameter

The choice list object of the geoprocessing parameter.

Remarks

The ChoiceList property is optional; it supplies a choice list for parameter values for the command line.

Specified by:

getChoiceList in interface IGPParameter

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setName

public void setName(java.lang.String rhs1)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IGPParameterEdit

Name of the geoprocessing parameter.

Supported Platforms

Windows

Specified by:

setName in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setDisplayName

public void setDisplayName(java.lang.String rhs1)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IGPParameterEdit

Display name of the geoprocessing parameter.

Supported Platforms

Windows

Specified by:

setDisplayName in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDirection

public void setDirection(int rhs1)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IGPParameterEdit

Direction of the geoprocessing parameter.

Supported Platforms

Windows

Specified by:

setDirection in interface IGPParameterEdit

Parameters:

rhs1 - A com.esri.arcgis.geoprocessing.esriGPParameterDirection constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDataTypeByRef

public void setDataTypeByRef(IGPDataType rhs1)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IGPParameterEdit

Data type of the geoprocessing parameter.

Specified by:

setDataTypeByRef in interface IGPParameterEdit

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setParameterType

public void setParameterType(int rhs1)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IGPParameterEdit

Type of the geoprocessing parameter.

Supported Platforms

Windows

Specified by:

setParameterType in interface IGPParameterEdit

Parameters:

rhs1 - A com.esri.arcgis.geoprocessing.esriGPParameterType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setParameterDependencies

public void setParameterDependencies(IEnumBSTR rhs1)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IGPParameterEdit

Enumeration of parameter names the geoprocessing parameter is dependent on.

Supported Platforms

Windows

Specified by:

setParameterDependencies in interface IGPParameterEdit

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IEnumBSTR (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDomainByRef

public void setDomainByRef(IGPDomain rhs1)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IGPParameterEdit

Domain of the geoprocessing parameter.

Specified by:

setDomainByRef in interface IGPParameterEdit

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setEnabled

public void setEnabled(boolean rhs1)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IGPParameterEdit

Indicates whether the ActiveX control for the geoprocessing parameter should be enabled/disabled.

Supported Platforms

Windows

Specified by:

setEnabled in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setValueByRef

public void setValueByRef(IGPValue rhs1)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IGPParameterEdit

The current value object of the geoprocessing parameter.

Specified by:

setValueByRef in interface IGPParameterEdit

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setControlCLSID

public void setControlCLSID(IUID rhs1)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IGPParameterEdit

The class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing parameter.

Supported Platforms

Windows

Specified by:

setControlCLSID in interface IGPParameterEdit

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setDefaultEnvironmentName

public void setDefaultEnvironmentName(java.lang.String rhs1)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IGPParameterEdit

The name of the environment value to use as the default value for the geoprocessing parameter.

Supported Platforms

Windows

Specified by:

setDefaultEnvironmentName in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setDisplayOrder

public void setDisplayOrder(int rhs1)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IGPParameterEdit

The display order of the geoprocessing parameter.

Supported Platforms

Windows

Specified by:

setDisplayOrder in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setAltered

public void setAltered(boolean rhs1)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IGPParameterEdit

Indicates whether the parameter value has been explicitly set (by the user).

Supported Platforms

Windows

Specified by:

setAltered in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHasBeenValidated

public void setHasBeenValidated(boolean rhs1)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IGPParameterEdit

Indicates whether the parameter value has been modified since the last time the parameter was validated (i.e., since Validate() was called).

Supported Platforms

Windows

Specified by:

setHasBeenValidated in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

addDependency

public void addDependency(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IGPParameterEdit

Adds the name of a parameter that this geoprocessing parameter object is dependent on.

Supported Platforms

Windows

Specified by:

addDependency in interface IGPParameterEdit

Parameters:

name - The name (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setCategory

public void setCategory(java.lang.String rhs1)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IGPParameterEdit

Category of the geoprocessing parameter.

Specified by:

setCategory in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setChoiceListByRef

public void setChoiceListByRef(IGPChoiceList rhs1)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IGPParameterEdit

The choice list object of the geoprocessing parameter.

Specified by:

setChoiceListByRef in interface IGPParameterEdit

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IGPChoiceList (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IClone

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IClone

Assigns the properties of src to the receiver.

Supported Platforms

Windows, Solaris, Linux

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IXMLSerialize

Serializes an object to XML.

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IXMLSerialize

Deserializes an object from XML.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isManaged

public boolean isManaged()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IGPParameter2

Indicates whether the parameter is managed.

Specified by:

isManaged in interface IGPParameter2

Returns:

The managed

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setManaged

public void setManaged(boolean rhs1)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IGPParameterEdit2

Indicates whether the parameter is managed.

Specified by:

setManaged in interface IGPParameterEdit2

Parameters:

rhs1 - The rhs1 (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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