com.esri.arcgis.carto

Interface IRelateDescription

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IRelateDescriptionProxy, RelateDescription

public interface IRelateDescription
extends java.io.Serializable

COM Interface 'IRelateDescription'. Generated 9/24/2024 11:01:31 AM from 'X:\ArcGIS\com\server\esriCarto.tlb'

Description: 'Provides access to the RelateDescription Interface.' 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

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IIDbadfd2ed_2776_4b21_879a_b99b2ea582a6
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
IGeometryResultOptions	getGeometryResultOptions() Indicates whether we need to modify Geometry.
IGeoTransformation	getGeoTransformation() Geo transformation required to transform the geometry if the requested GCS is different from the source.
ISpatialReference	getOutputSpatialReference() Spatial reference of the output geometry in the related records.
ITimeReference	getOutputTimeReference() Output time reference for the time fields.
java.lang.String	getRelatedTableDefinitionExpression() Definition expression of the related table for which related records are being requested.
java.lang.String	getRelatedTableFields() Table fields that need to be returned as a part of the relate results.
int	getRelationshipID() Relationship ID that uniquely idenentifies a relate to a table.
int	getResultFormat() Result format that indicates the type of content in the result.
boolean	isIncludeGeometry() Indicates whether we should include Geometry.
void	setGeometryResultOptionsByRef(IGeometryResultOptions geometryOptions) Indicates whether we need to modify Geometry.
void	setGeoTransformationByRef(IGeoTransformation geotransform) Geo transformation required to transform the geometry if the requested GCS is different from the source.
void	setIncludeGeometry(boolean includeGeometry) Indicates whether we should include Geometry.
void	setOutputSpatialReferenceByRef(ISpatialReference spatialReference) Spatial reference of the output geometry in the related records.
void	setOutputTimeReferenceByRef(ITimeReference timeReference) Output time reference for the time fields.
void	setRelatedTableDefinitionExpression(java.lang.String expression) Definition expression of the related table for which related records are being requested.
void	setRelatedTableFields(java.lang.String tableFields) Table fields that need to be returned as a part of the relate results.
void	setRelationshipID(int relationshipID) Relationship ID that uniquely idenentifies a relate to a table.
void	setResultFormat(int resultFormat) Result format that indicates the type of content in the result.

Field Detail

IIDbadfd2ed_2776_4b21_879a_b99b2ea582a6

static final int IIDbadfd2ed_2776_4b21_879a_b99b2ea582a6

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getRelationshipID

int getRelationshipID()
               throws java.io.IOException,
                      AutomationException

Relationship ID that uniquely idenentifies a relate to a table.

Returns:

The relationshipID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelationshipID

void setRelationshipID(int relationshipID)
                throws java.io.IOException,
                       AutomationException

Relationship ID that uniquely idenentifies a relate to a table.

Parameters:

relationshipID - The relationshipID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelatedTableDefinitionExpression

java.lang.String getRelatedTableDefinitionExpression()
                                              throws java.io.IOException,
                                                     AutomationException

Definition expression of the related table for which related records are being requested.

Returns:

The expression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelatedTableDefinitionExpression

void setRelatedTableDefinitionExpression(java.lang.String expression)
                                  throws java.io.IOException,
                                         AutomationException

Definition expression of the related table for which related records are being requested.

Parameters:

expression - The expression (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelatedTableFields

java.lang.String getRelatedTableFields()
                                throws java.io.IOException,
                                       AutomationException

Table fields that need to be returned as a part of the relate results.

Returns:

The tableFields

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelatedTableFields

void setRelatedTableFields(java.lang.String tableFields)
                    throws java.io.IOException,
                           AutomationException

Table fields that need to be returned as a part of the relate results.

Parameters:

tableFields - The tableFields (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

void setOutputSpatialReferenceByRef(ISpatialReference spatialReference)
                             throws java.io.IOException,
                                    AutomationException

Spatial reference of the output geometry in the related records.

Parameters:

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputSpatialReference

ISpatialReference getOutputSpatialReference()
                                     throws java.io.IOException,
                                            AutomationException

Spatial reference of the output geometry in the related records.

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeoTransformation

IGeoTransformation getGeoTransformation()
                                 throws java.io.IOException,
                                        AutomationException

Geo transformation required to transform the geometry if the requested GCS is different from the source.

Returns:

A reference to a com.esri.arcgis.geometry.IGeoTransformation

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeoTransformationByRef

void setGeoTransformationByRef(IGeoTransformation geotransform)
                        throws java.io.IOException,
                               AutomationException

Geo transformation required to transform the geometry if the requested GCS is different from the source.

Parameters:

geotransform - A reference to a com.esri.arcgis.geometry.IGeoTransformation (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResultFormat

int getResultFormat()
             throws java.io.IOException,
                    AutomationException

Result format that indicates the type of content in the result.

Returns:

A com.esri.arcgis.carto.esriRelateResultFormat constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResultFormat

void setResultFormat(int resultFormat)
              throws java.io.IOException,
                     AutomationException

Result format that indicates the type of content in the result.

Parameters:

resultFormat - A com.esri.arcgis.carto.esriRelateResultFormat constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIncludeGeometry

void setIncludeGeometry(boolean includeGeometry)
                 throws java.io.IOException,
                        AutomationException

Indicates whether we should include Geometry.

Parameters:

includeGeometry - The includeGeometry (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIncludeGeometry

boolean isIncludeGeometry()
                   throws java.io.IOException,
                          AutomationException

Indicates whether we should include Geometry.

Returns:

The includeGeometry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeometryResultOptionsByRef

void setGeometryResultOptionsByRef(IGeometryResultOptions geometryOptions)
                            throws java.io.IOException,
                                   AutomationException

Indicates whether we need to modify Geometry.

Parameters:

geometryOptions - A reference to a com.esri.arcgis.geodatabase.IGeometryResultOptions (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeometryResultOptions

IGeometryResultOptions getGeometryResultOptions()
                                         throws java.io.IOException,
                                                AutomationException

Indicates whether we need to modify Geometry.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputTimeReferenceByRef

void setOutputTimeReferenceByRef(ITimeReference timeReference)
                          throws java.io.IOException,
                                 AutomationException

Output time reference for the time fields.

Parameters:

timeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputTimeReference

ITimeReference getOutputTimeReference()
                               throws java.io.IOException,
                                      AutomationException

Output time reference for the time fields.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.