com.groupbyinc.api.request.sort.FieldSort Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of common-api Show documentation

${project.name}

The newest version!

package com.groupbyinc.api.request.sort;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.groupbyinc.api.request.Sort;
import com.groupbyinc.util.defaults.FieldSortOrderDefault;

/**
 * 
 *     Object that specifies sort field and direction
 * 
 */
public class FieldSort implements Sort {

  public static com.groupbyinc.api.request.sort.FieldSort RELEVANCE = new com.groupbyinc.api.request.sort.FieldSort().setField(com.groupbyinc.api.model.sort.FieldSort.RELEVANCE.getField());

  private String field;

  @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = FieldSortOrderDefault.class) private Order order = Order.Ascending;

  public String getField() {
    return field;
  }

  /**
   * @param field The source field name to sort by.
   */
  public com.groupbyinc.api.request.sort.FieldSort setField(String field) {
    this.field = field;
    return this;
  }

  /**
   *
   * @return The order Ascending or Descending
   */
  public Order getOrder() {
    return order;
  }

  /**
   * 
   *     Order in which the field will be applied.  Takes either
   *     `Ascending` or `Descending`
   * 
   * @param order The order in which the field will be applied
   */
  public com.groupbyinc.api.request.sort.FieldSort setOrder(Order order) {
    this.order = order;
    return this;
  }

  /**
   * Returns a string representation of the sort object.
   * @return sort details, i.e. field and order
   */
  @Override
  public String toString() {
    return "Sort field: [" + this.getField() + "], sort order: [" + this.getOrder() + "]";
  }
}