com.esri.arcgis.geoprocessing
Class GPParameter

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

All Implemented Interfaces:

IGPParameter, IGPParameter2, IGPParameter3, IGPParameterEdit, IGPParameterEdit2, IGPParameterEdit3, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class GPParameter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPParameter, IGPParameterEdit, IClone, IPersistStream, IXMLSerialize, IGPParameter2, IGPParameterEdit2, IGPParameter3, IGPParameterEdit3, Externalizable

Geoprocessing Parameter object.

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.

Product Availability

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

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GPParameter()
Constructs a GPParameter using ArcGIS Engine.

GPParameter(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPParameter theGPParameter = (GPParameter) obj;

Method Summary

void	addDependency(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(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
String	getCategory() Category of the geoprocessing parameter.
IGPChoiceList	getChoiceList() The choice list object of the geoprocessing parameter.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() 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.
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.
String	getDisplayName() Display name of the geoprocessing parameter.
int	getDisplayOrder() The display order of the geoprocessing parameter.
IGPDomain	getDomain() Domain of the geoprocessing parameter.
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.
IGPSchema	getSchema() Indicates how the output value is to be generated and populated during validate.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
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() isDirty
boolean	isEnabled() Indicates whether the ActiveX control for the geoprocessing parameter should be enabled/disabled.
boolean	isEqual(IClone other) Indicates if 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) Indicates if the receiver and other are the same object.
boolean	isManaged() Indicates whether the parameter is managed.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
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(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(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(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(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	setSchemaByRef(IGPSchema rhs1) Indicates how the output value is to be generated and populated during validate.
void	setValueByRef(IGPValue rhs1) The current value object of the geoprocessing parameter.
void	writeExternal(ObjectOutput out)

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

GPParameter

public GPParameter()
            throws IOException,
                   UnknownHostException

Constructs a GPParameter using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPParameter

public GPParameter(Object obj)
            throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPParameter theGPParameter = (GPParameter) obj;

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.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

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

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the geoprocessing parameter.

Remarks

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

Product Availability

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

Supported Platforms

Windows

Specified by:

getName in interface IGPParameter

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

public String getDisplayName()
                      throws IOException,
                             AutomationException

Display name of the geoprocessing parameter.

Remarks

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

Product Availability

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

Supported Platforms

Windows

Specified by:

getDisplayName in interface IGPParameter

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirection

public int getDirection()
                 throws IOException,
                        AutomationException

Direction of the geoprocessing parameter.

Remarks

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

Product Availability

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

Supported Platforms

Windows

Specified by:

getDirection in interface IGPParameter

Returns:

A com.esri.arcgis.geoprocessing.esriGPParameterDirection constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataType

public IGPDataType getDataType()
                        throws IOException,
                               AutomationException

Data type of the geoprocessing parameter.

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.

Product Availability

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

Supported Platforms

Windows

Specified by:

getDataType in interface IGPParameter

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.

getParameterType

public int getParameterType()
                     throws IOException,
                            AutomationException

Type of the geoprocessing parameter.

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.

Product Availability

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

Supported Platforms

Windows

Specified by:

getParameterType in interface IGPParameter

Returns:

A com.esri.arcgis.geoprocessing.esriGPParameterType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterDependencies

public IEnumBSTR getParameterDependencies()
                                   throws IOException,
                                          AutomationException

Enumeration of parameter names the geoprocessing parameter is dependent on.

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.

Product Availability

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

Supported Platforms

Windows

Specified by:

getParameterDependencies in interface IGPParameter

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDomain

public IGPDomain getDomain()
                    throws IOException,
                           AutomationException

Domain of the geoprocessing parameter.

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.

Product Availability

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

Supported Platforms

Windows

Specified by:

getDomain in interface IGPParameter

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.

isEnabled

public boolean isEnabled()
                  throws IOException,
                         AutomationException

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

Remarks

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

Product Availability

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

Supported Platforms

Windows

Specified by:

isEnabled in interface IGPParameter

Returns:

The enabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

public IGPValue getValue()
                  throws IOException,
                         AutomationException

The current value object of the geoprocessing parameter.

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.

Product Availability

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

Supported Platforms

Windows

Specified by:

getValue in interface IGPParameter

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.

getControlCLSID

public IUID getControlCLSID()
                     throws IOException,
                            AutomationException

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

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.

Product Availability

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

Supported Platforms

Windows

Specified by:

getControlCLSID in interface IGPParameter

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultEnvironmentName

public String getDefaultEnvironmentName()
                                 throws IOException,
                                        AutomationException

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

Remarks

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

Product Availability

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

Supported Platforms

Windows

Specified by:

getDefaultEnvironmentName in interface IGPParameter

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayOrder

public int getDisplayOrder()
                    throws IOException,
                           AutomationException

The display order of the geoprocessing parameter.

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.

Product Availability

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

Supported Platforms

Windows

Specified by:

getDisplayOrder in interface IGPParameter

Returns:

The displayOrder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAltered

public boolean isAltered()
                  throws IOException,
                         AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

isAltered in interface IGPParameter

Returns:

The altered

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasBeenValidated

public boolean isHasBeenValidated()
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

isHasBeenValidated in interface IGPParameter

Returns:

The validated

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

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.

Product Availability

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

Specified by:

getCategory in interface IGPParameter

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChoiceList

public IGPChoiceList getChoiceList()
                            throws IOException,
                                   AutomationException

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.

Product Availability

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

Specified by:

getChoiceList in interface IGPParameter

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String rhs1)
             throws IOException,
                    AutomationException

Name of the geoprocessing parameter.

Product Availability

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

Supported Platforms

Windows

Specified by:

setName in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayName

public void setDisplayName(String rhs1)
                    throws IOException,
                           AutomationException

Display name of the geoprocessing parameter.

Product Availability

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

Supported Platforms

Windows

Specified by:

setDisplayName in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirection

public void setDirection(int rhs1)
                  throws IOException,
                         AutomationException

Direction of the geoprocessing parameter.

Product Availability

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

Supported Platforms

Windows

Specified by:

setDirection in interface IGPParameterEdit

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataTypeByRef

public void setDataTypeByRef(IGPDataType rhs1)
                      throws IOException,
                             AutomationException

Data type of the geoprocessing parameter.

Product Availability

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

Specified by:

setDataTypeByRef in interface IGPParameterEdit

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameterType

public void setParameterType(int rhs1)
                      throws IOException,
                             AutomationException

Type of the geoprocessing parameter.

Product Availability

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

Supported Platforms

Windows

Specified by:

setParameterType in interface IGPParameterEdit

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameterDependencies

public void setParameterDependencies(IEnumBSTR rhs1)
                              throws IOException,
                                     AutomationException

Enumeration of parameter names the geoprocessing parameter is dependent on.

Product Availability

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

Supported Platforms

Windows

Specified by:

setParameterDependencies in interface IGPParameterEdit

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDomainByRef

public void setDomainByRef(IGPDomain rhs1)
                    throws IOException,
                           AutomationException

Domain of the geoprocessing parameter.

Product Availability

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

Specified by:

setDomainByRef in interface IGPParameterEdit

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnabled

public void setEnabled(boolean rhs1)
                throws IOException,
                       AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

setEnabled in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValueByRef

public void setValueByRef(IGPValue rhs1)
                   throws IOException,
                          AutomationException

The current value object of the geoprocessing parameter.

Product Availability

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

Specified by:

setValueByRef in interface IGPParameterEdit

Parameters:

rhs1 - 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.

setControlCLSID

public void setControlCLSID(IUID rhs1)
                     throws IOException,
                            AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

setControlCLSID in interface IGPParameterEdit

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultEnvironmentName

public void setDefaultEnvironmentName(String rhs1)
                               throws IOException,
                                      AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

setDefaultEnvironmentName in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayOrder

public void setDisplayOrder(int rhs1)
                     throws IOException,
                            AutomationException

The display order of the geoprocessing parameter.

Product Availability

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

Supported Platforms

Windows

Specified by:

setDisplayOrder in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAltered

public void setAltered(boolean rhs1)
                throws IOException,
                       AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

setAltered in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasBeenValidated

public void setHasBeenValidated(boolean rhs1)
                         throws IOException,
                                AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

setHasBeenValidated in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDependency

public void addDependency(String name)
                   throws IOException,
                          AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

addDependency in interface IGPParameterEdit

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(String rhs1)
                 throws IOException,
                        AutomationException

Category of the geoprocessing parameter.

Product Availability

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

Specified by:

setCategory in interface IGPParameterEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChoiceListByRef

public void setChoiceListByRef(IGPChoiceList rhs1)
                        throws IOException,
                               AutomationException

The choice list object of the geoprocessing parameter.

Product Availability

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

Specified by:

setChoiceListByRef in interface IGPParameterEdit

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isManaged

public boolean isManaged()
                  throws IOException,
                         AutomationException

Indicates whether the parameter is managed.

Product Availability

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

Specified by:

isManaged in interface IGPParameter2

Returns:

The managed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setManaged

public void setManaged(boolean rhs1)
                throws IOException,
                       AutomationException

Indicates whether the parameter is managed.

Product Availability

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

Specified by:

setManaged in interface IGPParameterEdit2

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchema

public IGPSchema getSchema()
                    throws IOException,
                           AutomationException

Indicates how the output value is to be generated and populated during validate.

Product Availability

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

Specified by:

getSchema in interface IGPParameter3

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPSchema

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchemaByRef

public void setSchemaByRef(IGPSchema rhs1)
                    throws IOException,
                           AutomationException

Indicates how the output value is to be generated and populated during validate.

Product Availability

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

Specified by:

setSchemaByRef in interface IGPParameterEdit3

Parameters:

rhs1 - A reference to a com.esri.arcgis.geoprocessing.IGPSchema (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException