|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.geoprocessing.GPParameter
public class GPParameter
COM Class 'GPParameter'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'
Description 'Geoprocessing Parameter object.' 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 =
| Field Summary | |
|---|---|
static long |
serialVersionUID
|
| 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 |
| Fields inherited from interface com.esri.arcgis.geoprocessing.IGPParameter3 |
|---|
IID, IIDed520462_7c5f_4eee_bcdd_8a82a7174a91, xxDummy |
| Fields inherited from interface com.esri.arcgis.geoprocessing.IGPParameter2 |
|---|
IID3a5bcff9_9178_4cfe_9cd9_20b7593cb17f |
| Fields inherited from interface com.esri.arcgis.geoprocessing.IGPParameter |
|---|
IID40ef6d06_4e62_4b3d_98e6_85f7a0607730 |
| Fields inherited from interface com.esri.arcgis.geoprocessing.IGPParameterEdit3 |
|---|
IID, IID5353174c_8a81_4c72_a874_880ac9b7ef3f, xxDummy |
| Fields inherited from interface com.esri.arcgis.geoprocessing.IGPParameterEdit2 |
|---|
IID1ba34152_5e03_4df1_a402_22c7e2a9f869 |
| Fields inherited from interface com.esri.arcgis.geoprocessing.IGPParameterEdit |
|---|
IID41ea73ee_8c7f_4ec8_bf00_1c5b11ef781d |
| 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. GPParameter theGPParameter = (GPParameter) obj; |
|
| 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. |
java.lang.String |
getCategory()
Category of the geoprocessing parameter. |
IGPChoiceList |
getChoiceList()
The choice list object of the geoprocessing parameter. |
void |
getClassID(GUID[] pClassID)
getClassID |
static java.lang.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. |
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. |
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Deprecated. Internal use only. |
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. |
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(java.io.ObjectInput in)
|
void |
release()
Release a GPParameter. |
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(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 |
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(java.io.ObjectOutput out)
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final long serialVersionUID
| Constructor Detail |
|---|
public GPParameter()
throws java.io.IOException,
java.net.UnknownHostException
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems
public GPParameter(java.lang.Object obj)
throws java.io.IOException
GPParameter theGPParameter = (GPParameter) obj;
obj to GPParameter.
obj - an object returned from ArcGIS Engine or Server
java.io.IOException - if there are interop problems| Method Detail |
|---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRefpublic void release()
release in interface com.esri.arcgis.interop.RemoteObjRef
public java.lang.String getName()
throws java.io.IOException,
AutomationException
getName in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getDisplayName()
throws java.io.IOException,
AutomationException
getDisplayName in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getDirection()
throws java.io.IOException,
AutomationException
getDirection in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPDataType getDataType()
throws java.io.IOException,
AutomationException
getDataType in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getParameterType()
throws java.io.IOException,
AutomationException
getParameterType in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumBSTR getParameterDependencies()
throws java.io.IOException,
AutomationException
getParameterDependencies in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPDomain getDomain()
throws java.io.IOException,
AutomationException
getDomain in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEnabled()
throws java.io.IOException,
AutomationException
isEnabled in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPValue getValue()
throws java.io.IOException,
AutomationException
getValue in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IUID getControlCLSID()
throws java.io.IOException,
AutomationException
getControlCLSID in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getDefaultEnvironmentName()
throws java.io.IOException,
AutomationException
getDefaultEnvironmentName in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getDisplayOrder()
throws java.io.IOException,
AutomationException
getDisplayOrder in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isAltered()
throws java.io.IOException,
AutomationException
isAltered in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isHasBeenValidated()
throws java.io.IOException,
AutomationException
isHasBeenValidated in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getCategory()
throws java.io.IOException,
AutomationException
getCategory in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPChoiceList getChoiceList()
throws java.io.IOException,
AutomationException
getChoiceList in interface IGPParameterjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setName(java.lang.String rhs1)
throws java.io.IOException,
AutomationException
setName in interface IGPParameterEditrhs1 - The rhs1 (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDisplayName(java.lang.String rhs1)
throws java.io.IOException,
AutomationException
setDisplayName in interface IGPParameterEditrhs1 - The rhs1 (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDirection(int rhs1)
throws java.io.IOException,
AutomationException
setDirection in interface IGPParameterEditrhs1 - A com.esri.arcgis.geoprocessing.esriGPParameterDirection constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDataTypeByRef(IGPDataType rhs1)
throws java.io.IOException,
AutomationException
setDataTypeByRef in interface IGPParameterEditrhs1 - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setParameterType(int rhs1)
throws java.io.IOException,
AutomationException
setParameterType in interface IGPParameterEditrhs1 - A com.esri.arcgis.geoprocessing.esriGPParameterType constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setParameterDependencies(IEnumBSTR rhs1)
throws java.io.IOException,
AutomationException
setParameterDependencies in interface IGPParameterEditrhs1 - A reference to a com.esri.arcgis.system.IEnumBSTR (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDomainByRef(IGPDomain rhs1)
throws java.io.IOException,
AutomationException
setDomainByRef in interface IGPParameterEditrhs1 - A reference to a com.esri.arcgis.geodatabase.IGPDomain (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setEnabled(boolean rhs1)
throws java.io.IOException,
AutomationException
setEnabled in interface IGPParameterEditrhs1 - The rhs1 (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setValueByRef(IGPValue rhs1)
throws java.io.IOException,
AutomationException
setValueByRef in interface IGPParameterEditrhs1 - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setControlCLSID(IUID rhs1)
throws java.io.IOException,
AutomationException
setControlCLSID in interface IGPParameterEditrhs1 - A reference to a com.esri.arcgis.system.IUID (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefaultEnvironmentName(java.lang.String rhs1)
throws java.io.IOException,
AutomationException
setDefaultEnvironmentName in interface IGPParameterEditrhs1 - The rhs1 (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDisplayOrder(int rhs1)
throws java.io.IOException,
AutomationException
setDisplayOrder in interface IGPParameterEditrhs1 - The rhs1 (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAltered(boolean rhs1)
throws java.io.IOException,
AutomationException
setAltered in interface IGPParameterEditrhs1 - The rhs1 (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setHasBeenValidated(boolean rhs1)
throws java.io.IOException,
AutomationException
setHasBeenValidated in interface IGPParameterEditrhs1 - The rhs1 (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addDependency(java.lang.String name)
throws java.io.IOException,
AutomationException
addDependency in interface IGPParameterEditname - The name (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCategory(java.lang.String rhs1)
throws java.io.IOException,
AutomationException
setCategory in interface IGPParameterEditrhs1 - The rhs1 (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setChoiceListByRef(IGPChoiceList rhs1)
throws java.io.IOException,
AutomationException
setChoiceListByRef in interface IGPParameterEditrhs1 - A reference to a com.esri.arcgis.geodatabase.IGPChoiceList (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IClone esri_clone()
throws java.io.IOException,
AutomationException
esri_clone in interface IClonejava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void assign(IClone src)
throws java.io.IOException,
AutomationException
assign in interface IClonesrc - A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEqual(IClone other)
throws java.io.IOException,
AutomationException
isEqual in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isIdentical(IClone other)
throws java.io.IOException,
AutomationException
isIdentical in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws java.io.IOException,
AutomationException
isDirty in interface IPersistStreamjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws java.io.IOException,
AutomationException
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws java.io.IOException,
AutomationException
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws java.io.IOException,
AutomationException
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws java.io.IOException,
AutomationException
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void serialize(IXMLSerializeData data)
throws java.io.IOException,
AutomationException
serialize in interface IXMLSerializedata - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deserialize(IXMLSerializeData data)
throws java.io.IOException,
AutomationException
deserialize in interface IXMLSerializedata - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isManaged()
throws java.io.IOException,
AutomationException
isManaged in interface IGPParameter2java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setManaged(boolean rhs1)
throws java.io.IOException,
AutomationException
setManaged in interface IGPParameterEdit2rhs1 - The rhs1 (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPSchema getSchema()
throws java.io.IOException,
AutomationException
getSchema in interface IGPParameter3java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSchemaByRef(IGPSchema rhs1)
throws java.io.IOException,
AutomationException
setSchemaByRef in interface IGPParameterEdit3rhs1 - A reference to a com.esri.arcgis.geoprocessing.IGPSchema (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(java.io.ObjectOutput out)
throws java.io.IOException
writeExternal in interface java.io.Externalizablejava.io.IOException
public void readExternal(java.io.ObjectInput in)
throws java.io.IOException,
java.lang.ClassNotFoundException
readExternal in interface java.io.Externalizablejava.io.IOException
java.lang.ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||