com.esri.arcgis.geoprocessing
Class MdParameter

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

All Implemented Interfaces:

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

public class MdParameter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IClone, IGPParameter, IGPParameterEdit, IMdParameter, IPersistStream, IXMLSerialize, IGPParameter2, IGPParameterEdit2, IGPParameter3, IGPParameterEdit3, java.io.Externalizable

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

Description 'Model parameter object that references a model variable or contains a value 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 =

See Also:

Serialized Form

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.geoprocessing.IMdParameter

IID, IID9411cd59_50b7_4852_8dff_a0c33f622216, 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

MdParameter()
Constructs a MdParameter using ArcGIS Engine.

MdParameter(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MdParameter theMdParameter = (MdParameter) 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
void	init(IGPParameter definition) Initializes the model parameter using the given parameter as a template.
boolean	isAltered() Indicates whether the parameter value has been explicitly set (by the user).
boolean	isCurrent() Indicates if the model parameter is current (i.e., has been created).
boolean	isDerived() Indicates if the model parameter is a derived value.
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.
boolean	isMarked() Indicates if the model parameter has been marked for validation/execution.
boolean	isValid() Indicates if the model parameter is valid.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a MdParameter.
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	setCurrent(boolean current) Indicates if the model parameter is current (i.e., has been created).
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	setDerived(boolean derived) Indicates if the model parameter is a derived value.
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	setMarked(boolean marked) Indicates if the model parameter has been marked for validation/execution.
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	setValid(boolean valid) Indicates if the model parameter is valid.
void	setValueByRef(IGPValue rhs1) The current value object of the geoprocessing parameter.
IGPMessage	validate() Validates the current value of the model 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

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

MdParameter

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

Constructs a MdParameter using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MdParameter

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

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

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

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

Specified by:

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

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.

getName

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

Name of the geoprocessing parameter.

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.

getDisplayName

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

Display name of the geoprocessing parameter.

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

Direction of the geoprocessing parameter.

Specified by:

getDirection in interface IGPParameter

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.

getDataType

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

Data type of the geoprocessing parameter.

Specified by:

getDataType in interface IGPParameter

Returns:

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

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

Type of the geoprocessing parameter.

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

Enumeration of parameter names the geoprocessing parameter is dependent on.

Specified by:

getParameterDependencies in interface IGPParameter

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDomain

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

Domain of the geoprocessing parameter.

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

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

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

The current value object of the geoprocessing parameter.

Specified by:

getValue in interface IGPParameter

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.

getControlCLSID

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

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

Specified by:

getControlCLSID in interface IGPParameter

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultEnvironmentName

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

The name of the environment value to use as the default value for the geoprocessing 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

The display order of the geoprocessing parameter.

Specified by:

getDisplayOrder in interface IGPParameter

Returns:

The displayOrder

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAltered

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

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

Specified by:

isAltered in interface IGPParameter

Returns:

The altered

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasBeenValidated

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

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

Specified by:

isHasBeenValidated in interface IGPParameter

Returns:

The validated

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

Category of the geoprocessing parameter.

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

The choice list object of the geoprocessing parameter.

Specified by:

getChoiceList in interface IGPParameter

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

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

Name of the geoprocessing parameter.

Specified by:

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

setDisplayName

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

Display name of the geoprocessing parameter.

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

Direction of the geoprocessing parameter.

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

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

Type of the geoprocessing parameter.

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

Enumeration of parameter names the geoprocessing parameter is dependent on.

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

Domain of the geoprocessing parameter.

Specified by:

setDomainByRef in interface IGPParameterEdit

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnabled

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

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

Specified by:

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

setValueByRef

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

The current value object of the geoprocessing parameter.

Specified by:

setValueByRef in interface IGPParameterEdit

Specified by:

setValueByRef in interface IMdParameter

Parameters:

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

setControlCLSID

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

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

Specified by:

setControlCLSID in interface IGPParameterEdit

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultEnvironmentName

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

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

Specified by:

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

setDisplayOrder

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

The display order of the geoprocessing parameter.

Specified by:

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

setAltered

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

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

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

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

Specified by:

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

addDependency

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

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

Specified by:

addDependency in interface IGPParameterEdit

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCategory

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

Category of the geoprocessing parameter.

Specified by:

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

setChoiceListByRef

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

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.

isMarked

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

Indicates if the model parameter has been marked for validation/execution.

Specified by:

isMarked in interface IMdParameter

Returns:

The marked

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMarked

public void setMarked(boolean marked)
               throws java.io.IOException,
                      AutomationException

Indicates if the model parameter has been marked for validation/execution.

Specified by:

setMarked in interface IMdParameter

Parameters:

marked - The marked (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValid

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

Indicates if the model parameter is valid.

Specified by:

isValid in interface IMdParameter

Returns:

The valid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setValid

public void setValid(boolean valid)
              throws java.io.IOException,
                     AutomationException

Indicates if the model parameter is valid.

Specified by:

setValid in interface IMdParameter

Parameters:

valid - The valid (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCurrent

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

Indicates if the model parameter is current (i.e., has been created).

Specified by:

isCurrent in interface IMdParameter

Returns:

The current

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrent

public void setCurrent(boolean current)
                throws java.io.IOException,
                       AutomationException

Indicates if the model parameter is current (i.e., has been created).

Specified by:

setCurrent in interface IMdParameter

Parameters:

current - The current (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDerived

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

Indicates if the model parameter is a derived value.

Specified by:

isDerived in interface IMdParameter

Returns:

The derived

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDerived

public void setDerived(boolean derived)
                throws java.io.IOException,
                       AutomationException

Indicates if the model parameter is a derived value.

Specified by:

setDerived in interface IMdParameter

Parameters:

derived - The derived (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

init

public void init(IGPParameter definition)
          throws java.io.IOException,
                 AutomationException

Initializes the model parameter using the given parameter as a template.

Specified by:

init in interface IMdParameter

Parameters:

definition - A reference to a com.esri.arcgis.geoprocessing.IGPParameter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validate

public IGPMessage validate()
                    throws java.io.IOException,
                           AutomationException

Validates the current value of the model parameter.

Specified by:

validate in interface IMdParameter

Returns:

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

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.

isManaged

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

Indicates whether the parameter is managed.

Specified by:

isManaged in interface IGPParameter2

Returns:

The managed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setManaged

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

Indicates whether the parameter is managed.

Specified by:

setManaged in interface IGPParameterEdit2

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSchema

public IGPSchema getSchema()
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

getSchema in interface IGPParameter3

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSchemaByRef

public void setSchemaByRef(IGPSchema rhs1)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

setSchemaByRef in interface IGPParameterEdit3

Parameters:

rhs1 - A reference to a com.esri.arcgis.geoprocessing.IGPSchema (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