com.geotab.model.search.PropertySetSearch Maven / Gradle / Ivy

Go to download
package com.geotab.model.search;

import com.geotab.model.entity.customproperty.PropertySet;
import java.util.List;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

/**
 * The search criteria for {@link PropertySet}.
 */
@Getter @Setter
@NoArgsConstructor
public class PropertySetSearch extends Search {

  /**
   * Search for PropertySets with this External Reference. Wildcard can be used by prepending/appending "%" to string.
   * Example "%externalreference%".
   */
  private String externalReference;

  /**
   * Search for PropertySets with this Name. Wildcard can be used by prepending/appending "%" to string. Example
   * "%name%".
   */
  private String name;

  /**
   * Search for PropertySets that are members of these {@link GroupSearch}(s) one of it's children or one of it's
   * parents.
   *
   * Available GroupSearch options are:
   * 

   *    id
   * 
   */
  private List groups;

  @Builder
  public PropertySetSearch(String id, String externalReference, String name, List groups) {
    super(id);
    this.externalReference = externalReference;
    this.name = name;
    this.groups = groups;
  }
}