com.esri.arcgis.geodatabase

Class ContingentValue

java.lang.Object

com.esri.arcgis.geodatabase.ContingentValue

All Implemented Interfaces:

IContingentValue, IContingentValueEdit, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class ContingentValue
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IContingentValueEdit

COM Class 'ContingentValue'. Generated 9/21/2023 10:01:43 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

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

Fields inherited from interface com.esri.arcgis.geodatabase.IContingentValueEdit

IID, IID1ea6deb1_cfa8_495f_bdef_cfb9b75c5130, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IContingentValue

IIDbc003034_4f15_4ede_99a8_16e57a5653c4

Constructor Summary

Constructors

Constructor and Description
ContingentValue() Constructs a ContingentValue using ArcGIS Engine.
ContingentValue(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. ContingentValue theContingentValue = (ContingentValue) obj;

Method Summary

Modifier and Type	Method and Description
void	allowAnyDomainValue(int fieldIndex) This contingency allows any values from the field domain.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
java.lang.Object	getCodedValue(int fieldIndex) The coded value of a coded value contingency.
int	getCount() Count of contingent values
java.lang.String	getFieldGroup() The group of fields the contingent value applies to.
int	getID() The unique ID of the contingent value.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
void	getRange(int fieldIndex, double[] minValue, double[] maxValue) The range of a range contingency.
int	getSubType() The subtype the contingent value applies to (if on a subtype class).
int	getType(int fieldIndex) The type of contingency.
int	hashCode() the hashcode for this object
void	initialize(IFieldGroup fieldGroup) Initialize the contingent value for its field group.
boolean	isRetired() Is this contingency retired?
void	putRange(int fieldIndex, double minValue, double maxValue) This contingency limits the field value to a sub-range of a range domain.
void	release() Release this COM object reference
void	renameFieldGroup(java.lang.String fieldGroupName) Renames the underlying Field Group.
void	requireNull(int fieldIndex) This contingency requires that the field value be null.
void	setCodedValue(int fieldIndex, java.lang.Object rhs2) This contingency limits the field value to a value from a coded value domain.
void	setID(int rhs1) The unique ID of the contingent value.
void	setIsRetired(boolean rhs1) Is this contingency retired?
void	setSubType(int rhs1) The subtype the contingent value applies to (if on a subtype class).

Methods inherited from class java.lang.Object

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

Constructor Detail

ContingentValue

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

Constructs a ContingentValue using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ContingentValue

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

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

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

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

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

initialize

public void initialize(IFieldGroup fieldGroup)
                throws java.io.IOException,
                       AutomationException

Initialize the contingent value for its field group. Must call first.

Specified by:

initialize in interface IContingentValueEdit

Parameters:

fieldGroup - A reference to a com.esri.arcgis.geodatabase.IFieldGroup (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setID

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

The unique ID of the contingent value.

Specified by:

setID in interface IContingentValueEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubType

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

The subtype the contingent value applies to (if on a subtype class).

Specified by:

setSubType in interface IContingentValueEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

allowAnyDomainValue

public void allowAnyDomainValue(int fieldIndex)
                         throws java.io.IOException,
                                AutomationException

This contingency allows any values from the field domain.

Specified by:

allowAnyDomainValue in interface IContingentValueEdit

Parameters:

fieldIndex - The fieldIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

requireNull

public void requireNull(int fieldIndex)
                 throws java.io.IOException,
                        AutomationException

This contingency requires that the field value be null.

Specified by:

requireNull in interface IContingentValueEdit

Parameters:

fieldIndex - The fieldIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCodedValue

public void setCodedValue(int fieldIndex,
                          java.lang.Object rhs2)
                   throws java.io.IOException,
                          AutomationException

This contingency limits the field value to a value from a coded value domain.

Specified by:

setCodedValue in interface IContingentValueEdit

Parameters:

fieldIndex - The fieldIndex (in)

rhs2 - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putRange

public void putRange(int fieldIndex,
                     double minValue,
                     double maxValue)
              throws java.io.IOException,
                     AutomationException

This contingency limits the field value to a sub-range of a range domain.

Specified by:

putRange in interface IContingentValueEdit

Parameters:

fieldIndex - The fieldIndex (in)

minValue - The minValue (in)

maxValue - The maxValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsRetired

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

Is this contingency retired?

Specified by:

setIsRetired in interface IContingentValueEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

renameFieldGroup

public void renameFieldGroup(java.lang.String fieldGroupName)
                      throws java.io.IOException,
                             AutomationException

Renames the underlying Field Group. It does not do any initialization

Specified by:

renameFieldGroup in interface IContingentValueEdit

Parameters:

fieldGroupName - The fieldGroupName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getID

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

The unique ID of the contingent value.

Specified by:

getID in interface IContingentValue

Returns:

The iD

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldGroup

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

The group of fields the contingent value applies to.

Specified by:

getFieldGroup in interface IContingentValue

Returns:

The fieldGroup

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubType

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

The subtype the contingent value applies to (if on a subtype class).

Specified by:

getSubType in interface IContingentValue

Returns:

The subType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

public int getType(int fieldIndex)
            throws java.io.IOException,
                   AutomationException

The type of contingency.

Specified by:

getType in interface IContingentValue

Parameters:

fieldIndex - The fieldIndex (in)

Returns:

A com.esri.arcgis.geodatabase.esriContingentValueType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCodedValue

public java.lang.Object getCodedValue(int fieldIndex)
                               throws java.io.IOException,
                                      AutomationException

The coded value of a coded value contingency.

Specified by:

getCodedValue in interface IContingentValue

Parameters:

fieldIndex - The fieldIndex (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRange

public void getRange(int fieldIndex,
                     double[] minValue,
                     double[] maxValue)
              throws java.io.IOException,
                     AutomationException

The range of a range contingency.

Specified by:

getRange in interface IContingentValue

Parameters:

fieldIndex - The fieldIndex (in)

minValue - The minValue (out: use single element array)

maxValue - The maxValue (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRetired

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

Is this contingency retired?

Specified by:

isRetired in interface IContingentValue

Returns:

The isRetired

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

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

Count of contingent values

Specified by:

getCount in interface IContingentValue

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.