Class QueryParameters.OrderBy

  • Enclosing class:
    QueryParameters

    public static final class QueryParameters.OrderBy
    extends java.lang.Object
    Represents the field the results are sorted by, and the sort order.
    Since:
    100.0.0
    • Constructor Detail

      • OrderBy

        public OrderBy​(java.lang.String fieldName,
                       QueryParameters.SortOrder sortOrder)
        Creates an instance of OrderBy.
        Parameters:
        fieldName - field name to order by
        sortOrder - sort order to be applied on the field
        Throws:
        java.lang.IllegalArgumentException - if any of the input is null, or if the field name is empty
        Since:
        100.0.0
    • Method Detail

      • getFieldName

        public java.lang.String getFieldName()
        Gets the field name.
        Returns:
        the field name
        Since:
        100.0.0
      • getSortOrder

        public QueryParameters.SortOrder getSortOrder()
        Gets the sort order.
        Returns:
        the sort order applied to be applied on the field
        Since:
        100.0.0