com.esri.arcgis.geodatabase
Interface IRelQueryTableName2

All Superinterfaces:

Serializable

All Known Implementing Classes:

RelQueryTableName

public interface IRelQueryTableName2
extends Serializable

Provides access to members that define a relationship query table name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

IName	getRelationshipClassName() The name object for the RelationshipClass that defines the RelQueryTable.
IQueryFilter	getSrcQueryFilter() A QueryFilter applied to a cursor opened from the RelQueryTable.
ISelectionSet	getSrcSelectionSet() A SelectionSet applied to a cursor opened from the RelQueryTable.
String	getTargetColumns() The destination dataset columns available in a cursor opened from the RelTableTable.
boolean	isDoNotPushJoinToDB() Indicates if the join is processed on the client.
boolean	isFireRowChangedEvents() Indicates if Fire row changed events.
boolean	isForwardDirection() Indicates if the originPrimaryClass of the RelationshipClass is the SourceTable.
boolean	isLeftOuterJoin() Indicates if the type of join will be a left outer join.
void	setDoNotPushJoinToDB(boolean doNotPushJoinToDB) Indicates if the join is processed on the client.
void	setFireRowChangedEvents(boolean fireRowEvents) Indicates if Fire row changed events.
void	setForwardDirection(boolean forward) Indicates if the originPrimaryClass of the RelationshipClass is the SourceTable.
void	setLeftOuterJoin(boolean leftOuterJoin) Indicates if the type of join will be a left outer join.
void	setRelationshipClassNameByRef(IName relClassName) The name object for the RelationshipClass that defines the RelQueryTable.
void	setSrcQueryFilterByRef(IQueryFilter queryFilter) A QueryFilter applied to a cursor opened from the RelQueryTable.
void	setSrcSelectionSetByRef(ISelectionSet selectionSet) A SelectionSet applied to a cursor opened from the RelQueryTable.
void	setTargetColumns(String targetColumns) The destination dataset columns available in a cursor opened from the RelTableTable.

Method Detail

setRelationshipClassNameByRef

void setRelationshipClassNameByRef(IName relClassName)
                                   throws IOException,
                                          AutomationException

The name object for the RelationshipClass that defines the RelQueryTable.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

relClassName - A reference to a com.esri.arcgis.system.IName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationshipClassName

IName getRelationshipClassName()
                               throws IOException,
                                      AutomationException

The name object for the RelationshipClass that defines the RelQueryTable.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setForwardDirection

void setForwardDirection(boolean forward)
                         throws IOException,
                                AutomationException

Indicates if the originPrimaryClass of the RelationshipClass is the SourceTable.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

forward - The forward (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isForwardDirection

boolean isForwardDirection()
                           throws IOException,
                                  AutomationException

Indicates if the originPrimaryClass of the RelationshipClass is the SourceTable.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The forward

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSrcQueryFilterByRef

void setSrcQueryFilterByRef(IQueryFilter queryFilter)
                            throws IOException,
                                   AutomationException

A QueryFilter applied to a cursor opened from the RelQueryTable.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSrcQueryFilter

IQueryFilter getSrcQueryFilter()
                               throws IOException,
                                      AutomationException

A QueryFilter applied to a cursor opened from the RelQueryTable.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSrcSelectionSetByRef

void setSrcSelectionSetByRef(ISelectionSet selectionSet)
                             throws IOException,
                                    AutomationException

A SelectionSet applied to a cursor opened from the RelQueryTable.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

selectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSrcSelectionSet

ISelectionSet getSrcSelectionSet()
                                 throws IOException,
                                        AutomationException

A SelectionSet applied to a cursor opened from the RelQueryTable.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetColumns

void setTargetColumns(String targetColumns)
                      throws IOException,
                             AutomationException

The destination dataset columns available in a cursor opened from the RelTableTable.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

targetColumns - The targetColumns (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetColumns

String getTargetColumns()
                        throws IOException,
                               AutomationException

The destination dataset columns available in a cursor opened from the RelTableTable.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The targetColumns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDoNotPushJoinToDB

void setDoNotPushJoinToDB(boolean doNotPushJoinToDB)
                          throws IOException,
                                 AutomationException

Indicates if the join is processed on the client.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

doNotPushJoinToDB - The doNotPushJoinToDB (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDoNotPushJoinToDB

boolean isDoNotPushJoinToDB()
                            throws IOException,
                                   AutomationException

Indicates if the join is processed on the client.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The doNotPushJoinToDB

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeftOuterJoin

void setLeftOuterJoin(boolean leftOuterJoin)
                      throws IOException,
                             AutomationException

Indicates if the type of join will be a left outer join.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

leftOuterJoin - The leftOuterJoin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLeftOuterJoin

boolean isLeftOuterJoin()
                        throws IOException,
                               AutomationException

Indicates if the type of join will be a left outer join.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The leftOuterJoin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFireRowChangedEvents

boolean isFireRowChangedEvents()
                               throws IOException,
                                      AutomationException

Indicates if Fire row changed events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The fireRowEvents

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFireRowChangedEvents

void setFireRowChangedEvents(boolean fireRowEvents)
                             throws IOException,
                                    AutomationException

Indicates if Fire row changed events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

fireRowEvents - The fireRowEvents (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.