com.esri.arcgis.carto
Interface IMapServerRelationship

All Superinterfaces:
Serializable
All Known Implementing Classes:
MapServerRelationship

public interface IMapServerRelationship
extends Serializable

Provides access to the Map Server Relationship Interface.

Remarks

A layer can be related to a table or layer. Name refers to the name of relationship set in the map document or in the GeoDatabase. For example, a relationship may be named "Is owned by". If the layer is related to another layer/table e.g. Layer A is related to Layer B, or a Table C, IMapServerRelationship::Name is same as the destination layer/table i.e. “Layer B” or “Table C”.

The property RelatedRows on the IMapServerIdentifyResult interface returns a collection of MapServerRelationship objects. The IMapServerRelationship interface contains the name of the relate and the property Rows. This property returns a collection of MapServerRow objects. MapServerRow objects honor all field aliases, field visibility and field formatting set in the map document or the GeoDatabase. Using the IMapServerRow interface you can access properties (Name, PropertySet and RelatedRows) of the row of a related table.

When To Use

Use IMapServerRelationship to access the name and rows of a related table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 String getName()
          The name of the relationship.
 IMapServerRows getRows()
          The rows.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
The name of the relationship.

Remarks

Name refers to the name of relationship set in the map document or in the GeoDatabase. For example, a relationship may be named "Is owned by". If the layer is related to another layer, Layer A is related to Layer B, Name will be appended with ":Layer B". The full Name in this example would be "Is owned by: Layer B". If the layer is related to a table, Name does not contain the table name. Using the example above, Name would be "Is owned by". Name from IMapServerRow refers to the string value of the Primary Display Field of the related table or layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getRows

IMapServerRows getRows()
                       throws IOException,
                              AutomationException
The rows.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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