com.esri.arcgis.geoprocessing
Class GPParameterInfo

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

All Implemented Interfaces:

IGPParameterInfo, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class GPParameterInfo
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPParameterInfo, IClone, IPersistStream, IXMLSerialize, java.io.Externalizable

COM Class 'GPParameterInfo'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description 'GPParameterInfo Class.' 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 =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.geoprocessing.IGPParameterInfo

IID, IIDcee0770d_1b0f_40a5_aad8_57a40b88b13f, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

GPParameterInfo()
Constructs a GPParameterInfo using ArcGIS Engine.

GPParameterInfo(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPParameterInfo theGPParameterInfo = (GPParameterInfo) obj;

Method Summary

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.
java.lang.String	getCategory() The parameter category.
IStringArray	getChoiceList() The parameter choice list.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getDataType() The parameter data type.
int	getDirection() The parameter direction.
java.lang.String	getDisplayName() The parameter display name.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The parameter name.
int	getParameterType() The parameter type.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IGPValue	getValue() The parameter value.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a GPParameterInfo.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCategory(java.lang.String category) The parameter category.
void	setChoiceListByRef(IStringArray ppChoiceList) The parameter choice list.
void	setDataType(java.lang.String type) The parameter data type.
void	setDirection(int direction) The parameter direction.
void	setDisplayName(java.lang.String name) The parameter display name.
void	setName(java.lang.String name) The parameter name.
void	setParameterType(int paramtype) The parameter type.
void	setValueByRef(IGPValue ppValue) The parameter value.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

GPParameterInfo

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

Constructs a GPParameterInfo using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPParameterInfo

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

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

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

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()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a GPParameterInfo.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

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

The parameter name.

Specified by:

getName in interface IGPParameterInfo

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

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

The parameter name.

Specified by:

setName in interface IGPParameterInfo

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayName

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

The parameter display name.

Specified by:

getDisplayName in interface IGPParameterInfo

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayName

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

The parameter display name.

Specified by:

setDisplayName in interface IGPParameterInfo

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

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

The parameter category.

Specified by:

getCategory in interface IGPParameterInfo

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCategory

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

The parameter category.

Specified by:

setCategory in interface IGPParameterInfo

Parameters:

category - The category (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataType

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

The parameter data type.

Specified by:

getDataType in interface IGPParameterInfo

Returns:

The type

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDataType

public void setDataType(java.lang.String type)
                 throws java.io.IOException,
                        AutomationException

The parameter data type.

Specified by:

setDataType in interface IGPParameterInfo

Parameters:

type - The type (in)

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

The parameter direction.

Specified by:

getDirection in interface IGPParameterInfo

Returns:

A com.esri.arcgis.geoprocessing.esriGPParameterDirection constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDirection

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

The parameter direction.

Specified by:

setDirection in interface IGPParameterInfo

Parameters:

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

getParameterType

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

The parameter type.

Specified by:

getParameterType in interface IGPParameterInfo

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.

setParameterType

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

The parameter type.

Specified by:

setParameterType in interface IGPParameterInfo

Parameters:

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

getChoiceList

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

The parameter choice list.

Specified by:

getChoiceList in interface IGPParameterInfo

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setChoiceListByRef

public void setChoiceListByRef(IStringArray ppChoiceList)
                        throws java.io.IOException,
                               AutomationException

The parameter choice list.

Specified by:

setChoiceListByRef in interface IGPParameterInfo

Parameters:

ppChoiceList - A reference to a com.esri.arcgis.system.IStringArray (in)

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

The parameter value.

Specified by:

getValue in interface IGPParameterInfo

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.

setValueByRef

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

The parameter value.

Specified by:

setValueByRef in interface IGPParameterInfo

Parameters:

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

esri_clone

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

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

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

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

Indicates if 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:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

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

Indicates if 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:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

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

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

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

Serializes an object to XML.

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

Deserializes an object from XML.

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.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException