Class PopupRelatedFeaturesSortOrder
- java.lang.Object
-
- com.esri.arcgisruntime.mapping.popup.PopupRelatedFeaturesSortOrder
-
public final class PopupRelatedFeaturesSortOrder extends Object
Defines the order in which related features of a particular relationship are sorted for displaying in a popup.- Since:
- 100.1.0
-
-
Constructor Summary
Constructors Constructor Description PopupRelatedFeaturesSortOrder()Creates an instance of PopupRelatedFeaturesSortOrder.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description QueryParameters.OrderBygetOrderByField()Gets theQueryParameters.OrderByobject that contains the field in the related table by which the related features should be sorted for displaying in a popup.longgetRelationshipId()Gets the id of the relationship for which related features should be sorted for displaying in a popup.voidsetOrderByField(QueryParameters.OrderBy orderBy)Sets theQueryParameters.OrderByobject that contains the field in the related table by which the related features should be sorted for displaying in a popup.voidsetRelationshipId(long relationshipId)Sets the id of the relationship for which related features should be sorted for displaying in a popup.
-
-
-
Method Detail
-
getOrderByField
public QueryParameters.OrderBy getOrderByField()
Gets theQueryParameters.OrderByobject 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
public void setOrderByField(QueryParameters.OrderBy orderBy)
Sets theQueryParameters.OrderByobject 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
-
-