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

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

import com.geotab.model.Id;
import com.geotab.model.entity.diagnostic.DiagnosticType;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

/**
 * The object used to specify the arguments when searching for  {@link com.geotab.model.entity.diagnostic.Diagnostic}s.
 */
@Getter @Setter
@NoArgsConstructor
public class DiagnosticSearch extends Search {

  /**
   * Search for a Diagnostic by the code number.
   */
  private Integer code;

  /**
   * Search for {@link com.geotab.model.entity.diagnostic.Diagnostic}(s) with this EngineTypeSearchId.
   *
   * Available EngineTypeSearch options are:
   *  

   *     
   *         {@link Id}
   *     
   * 
   */
  private Search engineTypeSearch;

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

  /**
   * Search for {@link com.geotab.model.entity.diagnostic.Diagnostic}(s) with this Source id.
   *
   * Available SourceSearch options are:
   *  

   *     
   *         {@link Id}
   *     
   * 
   */
  private Search sourceSearch;

  /**
   * The {@link DiagnosticType} to search for in Diagnostics.
   */
  private DiagnosticType diagnosticType;

  @Builder
  public DiagnosticSearch(String id, Integer code, Search engineTypeSearch, String name,
      Search sourceSearch, DiagnosticType diagnosticType) {
    super(id);
    this.code = code;
    this.engineTypeSearch = engineTypeSearch;
    this.name = name;
    this.sourceSearch = sourceSearch;
    this.diagnosticType = diagnosticType;
  }
}