| java.lang.Object | |
| ↳ | com.esri.core.tasks.ags.query.RelationshipQuery |
Class Overview
Defines parameters of a query to be executed on the server that fetches related records.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
RelationshipQuery()
Default constructor.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String |
getDefintionExpression()
Gets the definition expression.
| ||||||||||
| double |
getMaxAllowableOffset()
Gets the maximum allowable offset, which is used to generalize the geometry in the returned features.
| ||||||||||
| int[] |
getObjectIds()
Gets the object IDs to be queried.
| ||||||||||
| String[] |
getOutFields()
Gets the array of fields to be included in the returned result set.
| ||||||||||
| SpatialReference |
getOutSpatialReference()
Gets the spatial reference of the returned geometry.
| ||||||||||
| int |
getRelationshipId()
Gets the ID of the relationship that this query is based on.
| ||||||||||
| boolean |
isReturnGeometry()
Returns true if the result features include geometry.
| ||||||||||
| void |
setDefinitionExpression(String defintionExpression)
Sets the definition expression.
| ||||||||||
| void |
setMaxAllowableOffset(double offset)
Sets the maximum allowable offset, which is used to generalize the geometry in the returned features.
| ||||||||||
| void |
setObjectIds(int[] objectIds)
Sets the object IDs to be queried.
| ||||||||||
| void |
setOutFields(String[] outFields)
Sets the array of fields to be included in the returned result set.
| ||||||||||
| void |
setOutSpatialReference(SpatialReference outSR)
Sets the spatial reference of the returned geometry.
| ||||||||||
| void |
setRelationshipId(int id)
Sets the ID of the relationship that this query is based on.
| ||||||||||
| void |
setReturnGeometry(boolean returnGeometry)
Sets if the result features should include geometry.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public RelationshipQuery ()
Default constructor.
Public Methods
public String getDefintionExpression ()
Gets the definition expression.
Returns
- definition expression.
public double getMaxAllowableOffset ()
Gets the maximum allowable offset, which is used to generalize the geometry in the returned features.
Returns
- maximum allowable offset.
public int[] getObjectIds ()
Gets the object IDs to be queried.
Returns
- object IDs.
public String[] getOutFields ()
Gets the array of fields to be included in the returned result set. A wildcard "*" means that all fields are included.
Returns
- an array of field names.
public SpatialReference getOutSpatialReference ()
Gets the spatial reference of the returned geometry.
Returns
- spatial reference of the returned geometry.
public int getRelationshipId ()
Gets the ID of the relationship that this query is based on.
Returns
- relationship ID.
public boolean isReturnGeometry ()
Returns true if the result features include geometry.
Returns
- true if the result features include geometry.
public void setDefinitionExpression (String defintionExpression)
Sets the definition expression.
Parameters
| defintionExpression | definition expression. |
|---|
public void setMaxAllowableOffset (double offset)
Sets the maximum allowable offset, which is used to generalize the geometry in the returned features.
Parameters
| offset | maximum allowable offset. |
|---|
public void setObjectIds (int[] objectIds)
Sets the object IDs to be queried.
Parameters
| objectIds | the object ids |
|---|
public void setOutFields (String[] outFields)
Sets the array of fields to be included in the returned result set. A wildcard "*" means that all fields are included.
Parameters
| outFields | an array of field names. |
|---|
public void setOutSpatialReference (SpatialReference outSR)
Sets the spatial reference of the returned geometry.
Parameters
| outSR | spatial reference of the returned geometry. |
|---|
public void setRelationshipId (int id)
Sets the ID of the relationship that this query is based on.
Parameters
| id | relationship ID. |
|---|
public void setReturnGeometry (boolean returnGeometry)
Sets if the result features should include geometry.
Parameters
| returnGeometry | true for the result features to include geometry. |
|---|