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

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

import com.geotab.model.entity.ioxaddon.IoxAddOn;
import com.geotab.model.entity.ioxaddon.KnownIoxAddOnType;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

/**
 * The object used to specify the arguments when searching for {@link IoxAddOn}(s).
 */
@Getter @Setter
@NoArgsConstructor
public class IoxAddOnSearch extends Search {

  /**
   * Search for {@link IoxAddOn} with this DeviceSearch Id.
   *
   * Available DeviceSearch options are:
   * 

   *    id
   * 
   */
  private DeviceSearch deviceSearch;

  /**
   * Search for Iox Add-Ons of a specific type (Garmin, GoTalk etc). See {@link KnownIoxAddOnType}.
   */
  private Integer type;

  /**
   * If true only Iox Add-Ons that are currently connected to a device will be returned.
   */
  private Boolean connectedOnly;

  @Builder
  public IoxAddOnSearch(String id, DeviceSearch deviceSearch, Integer type,
      Boolean connectedOnly) {
    super(id);
    this.deviceSearch = deviceSearch;
    this.type = type;
    this.connectedOnly = connectedOnly;
  }
}