Packagecom.esri.ags.tasks.supportClasses
Classpublic class RelationshipQuery
InheritanceRelationshipQuery Inheritance flash.events.EventDispatcher

Since : ArcGIS API for Flex 2.0

Input parameters when querying for related features with FeatureLayer and QueryTask.

See also

com.esri.ags.tasks.QueryTask.executeRelationshipQuery()
com.esri.ags.layers.FeatureLayer.queryRelatedFeatures()


Public Properties
 PropertyDefined By
  definitionExpression : String
The definition expression to be applied to the related table / layer.
RelationshipQuery
  maxAllowableOffset : Number
The maximum allowable offset used for generalizing geometries returned by the query operation.
RelationshipQuery
  objectIds : Array
The object IDs of this layer (or table) to be queried.
RelationshipQuery
  outFields : Array
The list of fields from the related table / layer to be included in the returned featureset.This list is a comma delimited list of field names.
RelationshipQuery
  outSpatialReference : SpatialReference
The well-known ID of the spatial reference for the returned geometry.
RelationshipQuery
  relationshipId : Number
The ID of the relationship to be queried.
RelationshipQuery
  returnGeometry : Boolean
If true, each feature in the FeatureSet includes the geometry.
RelationshipQuery
Property Detail
definitionExpressionproperty
definitionExpression:String

The definition expression to be applied to the related table / layer. From the list of objectIds, only those records that conform to this expression will be returned.

This property can be used as the source for data binding.


Implementation
    public function get definitionExpression():String
    public function set definitionExpression(value:String):void
maxAllowableOffsetproperty 
maxAllowableOffset:Number

The maximum allowable offset used for generalizing geometries returned by the query operation. The offset is in the units of the spatialReference. If a spatialReference is not defined the spatial reference of the map is used.

This property can be used as the source for data binding.


Implementation
    public function get maxAllowableOffset():Number
    public function set maxAllowableOffset(value:Number):void
objectIdsproperty 
objectIds:Array

The object IDs of this layer (or table) to be queried. Records related to these object IDs will be queried.

This property can be used as the source for data binding.


Implementation
    public function get objectIds():Array
    public function set objectIds(value:Array):void
outFieldsproperty 
outFields:Array

The list of fields from the related table / layer to be included in the returned featureset.This list is a comma delimited list of field names. If you specify the shape field in the list of return fields, it is ignored. To request geometry, set returnGeometry to true. To return all fields, specify the wildcard "*" as the value of this parameter. In this case, the query results include all the field values. Note that the wildcard also implicitly implies returnGeometry=true and setting returnGeometry to false will have no effect.

This property can be used as the source for data binding.


Implementation
    public function get outFields():Array
    public function set outFields(value:Array):void
outSpatialReferenceproperty 
outSpatialReference:SpatialReference

The well-known ID of the spatial reference for the returned geometry. If not specified, the geometry is returned in the spatial reference of the map.

This property can be used as the source for data binding.


Implementation
    public function get outSpatialReference():SpatialReference
    public function set outSpatialReference(value:SpatialReference):void
relationshipIdproperty 
relationshipId:Number

The ID of the relationship to be queried. The relationships that this layer/table participates in are included in the Layer/Table Resource response. Records in tables / layers corresponding to the related table / layer of the relationship are queried.

This property can be used as the source for data binding.


Implementation
    public function get relationshipId():Number
    public function set relationshipId(value:Number):void
returnGeometryproperty 
returnGeometry:Boolean

If true, each feature in the FeatureSet includes the geometry. Since the geometry makes up a significant portion of the response, only use when you plan to use the geometry of the feature, for example, to include them on a map.

The default value is false.

This property can be used as the source for data binding.


Implementation
    public function get returnGeometry():Boolean
    public function set returnGeometry(value:Boolean):void