AGSRelationshipQuery Class Reference
Description
Instances of this class represent parameters for executing queries with AGSQueryTask that fetch related records. Parameters define the criteria for finding related records and provide options for how the results should be returned.
All parameters related to geometry will be ignored when fetching related records from a table.
- Defined in:
- AGSQueryTask.h ( ArcGIS library)
- Since:
- 1.0
Public Member Functions | |
| (void) | - decodeWithJSON: |
| (NSDictionary *) | - encodeToJSON |
| (id) | - initWithJSON: |
Static Public Member Functions | |
| (id) | + relationshipQuery |
Properties | |
| NSString * | definitionExpression |
| double | maxAllowableOffset |
| NSArray * | objectIds |
| NSArray * | outFields |
| AGSSpatialReference * | outSpatialReference |
| NSInteger | relationshipId |
| BOOL | returnGeometry |
Member Function Documentation
| - (void) decodeWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Decode object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be decoded.
- Since:
- 1.0
| - (NSDictionary *) encodeToJSON | [optional, inherited] |
Encode and return JSON representation for object.
- Returns:
- JSON representation of object.
- Since:
- 1.0
| - (id) initWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Initialize and return object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be created.
- Returns:
- Object decoded from JSON representation.
- Since:
- 1.0
| + (id) relationshipQuery |
Initialize autoreleased AGSRelationshipQuery object with defaults.
- Returns:
- A new, autoreleased, relationship query object.
- Since:
- 1.0
Property Documentation
- (NSString*) definitionExpression [read, write, retain] |
The definition expression to be applied to the related layer or table. Only features that satisfy both the definition expression and the query criteria will be returned.
- Since:
- 1.0
- (double) maxAllowableOffset [read, write, assign] |
The maximum allowable offset used for generalizing geometries returned by the query operation. The default is 0. If 0 is specified the value is not passed to the server in a query. The offset is in the units of the spatialReference. If a spatialReference is not defined the spatial reference of the map is used.
- Availability:
- This feature is only available with services from ArcGIS Server 10.0 or above
- Since:
- 1.0
- (NSArray*) objectIds [read, write, retain] |
IDs of features whose related records are to be queried.
- Since:
- 1.0
- (NSArray*) outFields [read, write, retain] |
Attribute fields to be included for the result features or records. To include geometry information in the results, use returnGeometry. You must use the actual field names rather than the field aliases. As a best practice, you should try to limit the fields to only those you expect to use. The fewer fields you include, the faster the response will be.
This parameter must be specified. You can use the wildcard "*" to include all fields.
- Since:
- 1.0
- (AGSSpatialReference*) outSpatialReference [read, write, retain] |
The spatial reference in which result geometries are to be returned. If not specified, geometries are returned in the spatial reference of the service. If the results originate from a table, they will not contain geometries.
- Since:
- 1.0
- (NSInteger) relationshipId [read, write, assign] |
The ID of the relationship this query should be based on. The IDs of relationships that a layer or table participates in are listed in the ArcGIS Services Directory.
- Since:
- 1.0
- (BOOL) returnGeometry [read, write, assign] |
If YES, result features will include their geometry. This is needed when you want to display the features on the map. Default is NO to get better performance since geometries makes up a significant portion of the response. If the results originate from a table, they will not contain geometries.
- Since:
- 1.0