com.groupbyinc.api.request.sort.SortByIds 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 java.util.ArrayList;
import java.util.List;

/**
 * 
 *     Object that specifies the order of the result set, by IDs. Any record included in the result set, but not this sort,
 *     will be moved to the end of the result set and will maintain the original ordering.
 * 
 */
public class SortByIds implements Sort {

  @JsonInclude(JsonInclude.Include.NON_EMPTY) private List ids = new ArrayList();

  public List getIds() {
    return ids;
  }

  /**
   * 
   *     The product IDs in the expected order for the result set.
   * 
   * @param ids
   *      The products IDs in the expected order for the result set.
   */
  public com.groupbyinc.api.request.sort.SortByIds setIds(List ids) {
    this.ids = ids;
    return this;
  }
}