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

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

import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.geotab.model.Id;
import com.geotab.model.entity.textmessage.MessageContentType;
import com.geotab.model.entity.textmessage.TextMessage;
import com.geotab.model.serialization.serdes.IdAsStringSerializer;
import java.time.LocalDateTime;
import java.util.List;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

/**
 * The object used to specify the arguments when searching for a {@link TextMessage}.
 */
@Getter @Setter
@NoArgsConstructor
public class TextMessageSearch extends Search {

  /**
   * Gets or sets search for TextMessages sent to or received from this {@link DeviceSearch}.
   *
   * Available DeviceSearch options are:
   *  

   *     
   *         {@link Id}
   *     
   * 
   */
  private DeviceSearch deviceSearch;

  /**
   * Gets or sets search for TextMessages that were delivered/sent/read since this date.
   */
  private LocalDateTime modifiedSinceDate;

  /**
   * Gets or sets search for TextMessages that were sent at this date or before.
   */
  private LocalDateTime toDate;

  /**
   * Gets or sets search for TextMessages that have parent id as this id.
   *
   * ParentTextMessageId is obsolete and will be removed. Please use ParentMessageId search
   * property.
   */
  private Long parentTextMessageId;

  /**
   * Gets or sets search for TextMessages that have parent id as this Id.
   */
  @JsonSerialize(using = IdAsStringSerializer.class)
  private Id parentMessageId;

  /**
   * Gets or sets search for TextMessages filtered based on the {@link MessageContentType}.
   */
  private List contentTypes;

  @Builder
  public TextMessageSearch(String id, DeviceSearch deviceSearch, LocalDateTime modifiedSinceDate,
      LocalDateTime toDate, Long parentTextMessageId, Id parentMessageId,
      List contentTypes) {
    super(id);
    this.deviceSearch = deviceSearch;
    this.modifiedSinceDate = modifiedSinceDate;
    this.toDate = toDate;
    this.parentTextMessageId = parentTextMessageId;
    this.parentMessageId = parentMessageId;
    this.contentTypes = contentTypes;
  }
}