com.esri.arcgis.geodatabase
Interface IRelationshipClassInfo

All Superinterfaces:
Serializable
All Known Implementing Classes:
IRelationshipClassInfoProxy

public interface IRelationshipClassInfo
extends Serializable

Provides access to members that return relationship class settings for the replica.

Product Availability

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


Method Summary
 IRelationshipClassName getRelationshipClassName()
          The relationship classes to replicate.
 int getRelExtractDirection()
          Indicates the direction of the relationship class to checkout.
 int getTargetID()
          Indicates if the targetID of the child replica.
 boolean isExcluded()
          Indicates if the relationship class to be excluded from the replica description.
 void setExcluded(boolean relExcluded)
          Indicates if the relationship class to be excluded from the replica description.
 void setRelExtractDirection(int relExtractDirection)
          Indicates the direction of the relationship class to checkout.
 

Method Detail

getRelationshipClassName

IRelationshipClassName getRelationshipClassName()
                                                throws IOException,
                                                       AutomationException
The relationship classes to replicate.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geodatabase.IRelationshipClassName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelExtractDirection

void setRelExtractDirection(int relExtractDirection)
                            throws IOException,
                                   AutomationException
Indicates the direction of the relationship class to checkout.

Product Availability

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

Parameters:
relExtractDirection - A com.esri.arcgis.geodatabase.esriRelExtractDirection constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelExtractDirection

int getRelExtractDirection()
                           throws IOException,
                                  AutomationException
Indicates the direction of the relationship class to checkout.

Product Availability

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

Returns:
A com.esri.arcgis.geodatabase.esriRelExtractDirection constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExcluded

void setExcluded(boolean relExcluded)
                 throws IOException,
                        AutomationException
Indicates if the relationship class to be excluded from the replica description.

Product Availability

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

Parameters:
relExcluded - The relExcluded (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExcluded

boolean isExcluded()
                   throws IOException,
                          AutomationException
Indicates if the relationship class to be excluded from the replica description.

Product Availability

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

Returns:
The relExcluded
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTargetID

int getTargetID()
                throws IOException,
                       AutomationException
Indicates if the targetID of the child replica.

Product Availability

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

Returns:
The targetID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.