Module com.esri.arcgisruntime
Class PopupRelatedFeaturesSortOrder
java.lang.Object
com.esri.arcgisruntime.mapping.popup.PopupRelatedFeaturesSortOrder
Defines the order in which related features of a particular relationship are sorted for displaying in a popup.
- Since:
- 100.1.0
-
Constructor Summary
ConstructorDescriptionCreates an instance of PopupRelatedFeaturesSortOrder. -
Method Summary
Modifier and TypeMethodDescriptionGets theQueryParameters.OrderBy
object that contains the field in the related table by which the related features should be sorted for displaying in a popup.long
Gets the id of the relationship for which related features should be sorted for displaying in a popup.void
setOrderByField
(QueryParameters.OrderBy orderBy) Sets theQueryParameters.OrderBy
object that contains the field in the related table by which the related features should be sorted for displaying in a popup.void
setRelationshipId
(long relationshipId) Sets the id of the relationship for which related features should be sorted for displaying in a popup.
-
Constructor Details
-
PopupRelatedFeaturesSortOrder
public PopupRelatedFeaturesSortOrder()Creates an instance of PopupRelatedFeaturesSortOrder.- Since:
- 100.1.0
-
-
Method Details
-
getOrderByField
Gets theQueryParameters.OrderBy
object that contains the field in the related table by which the related features should be sorted for displaying in a popup.- Returns:
- the OrderBy object
- Since:
- 100.1.0
-
setOrderByField
Sets theQueryParameters.OrderBy
object that contains the field in the related table by which the related features should be sorted for displaying in a popup.- Parameters:
orderBy
- the OrderBy object to use, cannot be null- Throws:
IllegalArgumentException
- if orderBy is null- Since:
- 100.1.0
-
getRelationshipId
public long getRelationshipId()Gets the id of the relationship for which related features should be sorted for displaying in a popup.- Returns:
- the relationship id, or -1 if not set
- Since:
- 100.1.0
-
setRelationshipId
public void setRelationshipId(long relationshipId) Sets the id of the relationship for which related features should be sorted for displaying in a popup.- Parameters:
relationshipId
- the relationship id, cannot be negative- Throws:
IllegalArgumentException
- if relationshipId is negative- Since:
- 100.1.0
-