com.xero.models.payrolluk.PayRunCalendar Maven / Gradle / Ivy

Go to download
/*
 * Xero Payroll UK
 * This is the Xero Payroll API for orgs in the UK region.
 *
 * Contact: [email protected]
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

package com.xero.models.payrolluk;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonValue;
import com.xero.api.StringUtil;
import io.swagger.annotations.ApiModelProperty;
import java.util.Objects;
import java.util.UUID;
import org.threeten.bp.LocalDate;
import org.threeten.bp.LocalDateTime;

/** PayRunCalendar */
public class PayRunCalendar {
  StringUtil util = new StringUtil();

  @JsonProperty("payrollCalendarID")
  private UUID payrollCalendarID;

  @JsonProperty("name")
  private String name;
  /** Type of the calendar */
  public enum CalendarTypeEnum {
    /** WEEKLY */
    WEEKLY("Weekly"),

    /** FORTNIGHTLY */
    FORTNIGHTLY("Fortnightly"),

    /** FOURWEEKLY */
    FOURWEEKLY("FourWeekly"),

    /** MONTHLY */
    MONTHLY("Monthly"),

    /** ANNUAL */
    ANNUAL("Annual"),

    /** QUARTERLY */
    QUARTERLY("Quarterly");

    private String value;

    CalendarTypeEnum(String value) {
      this.value = value;
    }

    /**
     * getValue
     *
     * @return String value
     */
    @JsonValue
    public String getValue() {
      return value;
    }

    /**
     * toString
     *
     * @return String value
     */
    @Override
    public String toString() {
      return String.valueOf(value);
    }

    /**
     * fromValue
     *
     * @param value String
     */
    @JsonCreator
    public static CalendarTypeEnum fromValue(String value) {
      for (CalendarTypeEnum b : CalendarTypeEnum.values()) {
        if (b.value.equals(value)) {
          return b;
        }
      }
      throw new IllegalArgumentException("Unexpected value '" + value + "'");
    }
  }

  @JsonProperty("calendarType")
  private CalendarTypeEnum calendarType;

  @JsonProperty("periodStartDate")
  private LocalDate periodStartDate;

  @JsonProperty("periodEndDate")
  private LocalDate periodEndDate;

  @JsonProperty("paymentDate")
  private LocalDate paymentDate;

  @JsonProperty("updatedDateUTC")
  private LocalDateTime updatedDateUTC;
  /**
   * Xero unique identifier for the payroll calendar
   *
   * @param payrollCalendarID UUID
   * @return PayRunCalendar
   */
  public PayRunCalendar payrollCalendarID(UUID payrollCalendarID) {
    this.payrollCalendarID = payrollCalendarID;
    return this;
  }

  /**
   * Xero unique identifier for the payroll calendar
   *
   * @return payrollCalendarID
   */
  @ApiModelProperty(value = "Xero unique identifier for the payroll calendar")
  /**
   * Xero unique identifier for the payroll calendar
   *
   * @return payrollCalendarID UUID
   */
  public UUID getPayrollCalendarID() {
    return payrollCalendarID;
  }

  /**
   * Xero unique identifier for the payroll calendar
   *
   * @param payrollCalendarID UUID
   */
  public void setPayrollCalendarID(UUID payrollCalendarID) {
    this.payrollCalendarID = payrollCalendarID;
  }

  /**
   * Name of the calendar
   *
   * @param name String
   * @return PayRunCalendar
   */
  public PayRunCalendar name(String name) {
    this.name = name;
    return this;
  }

  /**
   * Name of the calendar
   *
   * @return name
   */
  @ApiModelProperty(required = true, value = "Name of the calendar")
  /**
   * Name of the calendar
   *
   * @return name String
   */
  public String getName() {
    return name;
  }

  /**
   * Name of the calendar
   *
   * @param name String
   */
  public void setName(String name) {
    this.name = name;
  }

  /**
   * Type of the calendar
   *
   * @param calendarType CalendarTypeEnum
   * @return PayRunCalendar
   */
  public PayRunCalendar calendarType(CalendarTypeEnum calendarType) {
    this.calendarType = calendarType;
    return this;
  }

  /**
   * Type of the calendar
   *
   * @return calendarType
   */
  @ApiModelProperty(required = true, value = "Type of the calendar")
  /**
   * Type of the calendar
   *
   * @return calendarType CalendarTypeEnum
   */
  public CalendarTypeEnum getCalendarType() {
    return calendarType;
  }

  /**
   * Type of the calendar
   *
   * @param calendarType CalendarTypeEnum
   */
  public void setCalendarType(CalendarTypeEnum calendarType) {
    this.calendarType = calendarType;
  }

  /**
   * Period start date of the calendar
   *
   * @param periodStartDate LocalDate
   * @return PayRunCalendar
   */
  public PayRunCalendar periodStartDate(LocalDate periodStartDate) {
    this.periodStartDate = periodStartDate;
    return this;
  }

  /**
   * Period start date of the calendar
   *
   * @return periodStartDate
   */
  @ApiModelProperty(required = true, value = "Period start date of the calendar")
  /**
   * Period start date of the calendar
   *
   * @return periodStartDate LocalDate
   */
  public LocalDate getPeriodStartDate() {
    return periodStartDate;
  }

  /**
   * Period start date of the calendar
   *
   * @param periodStartDate LocalDate
   */
  public void setPeriodStartDate(LocalDate periodStartDate) {
    this.periodStartDate = periodStartDate;
  }

  /**
   * Period end date of the calendar
   *
   * @param periodEndDate LocalDate
   * @return PayRunCalendar
   */
  public PayRunCalendar periodEndDate(LocalDate periodEndDate) {
    this.periodEndDate = periodEndDate;
    return this;
  }

  /**
   * Period end date of the calendar
   *
   * @return periodEndDate
   */
  @ApiModelProperty(value = "Period end date of the calendar")
  /**
   * Period end date of the calendar
   *
   * @return periodEndDate LocalDate
   */
  public LocalDate getPeriodEndDate() {
    return periodEndDate;
  }

  /**
   * Period end date of the calendar
   *
   * @param periodEndDate LocalDate
   */
  public void setPeriodEndDate(LocalDate periodEndDate) {
    this.periodEndDate = periodEndDate;
  }

  /**
   * Payment date of the calendar
   *
   * @param paymentDate LocalDate
   * @return PayRunCalendar
   */
  public PayRunCalendar paymentDate(LocalDate paymentDate) {
    this.paymentDate = paymentDate;
    return this;
  }

  /**
   * Payment date of the calendar
   *
   * @return paymentDate
   */
  @ApiModelProperty(required = true, value = "Payment date of the calendar")
  /**
   * Payment date of the calendar
   *
   * @return paymentDate LocalDate
   */
  public LocalDate getPaymentDate() {
    return paymentDate;
  }

  /**
   * Payment date of the calendar
   *
   * @param paymentDate LocalDate
   */
  public void setPaymentDate(LocalDate paymentDate) {
    this.paymentDate = paymentDate;
  }

  /**
   * UTC timestamp of the last update to the pay run calendar
   *
   * @param updatedDateUTC LocalDateTime
   * @return PayRunCalendar
   */
  public PayRunCalendar updatedDateUTC(LocalDateTime updatedDateUTC) {
    this.updatedDateUTC = updatedDateUTC;
    return this;
  }

  /**
   * UTC timestamp of the last update to the pay run calendar
   *
   * @return updatedDateUTC
   */
  @ApiModelProperty(value = "UTC timestamp of the last update to the pay run calendar")
  /**
   * UTC timestamp of the last update to the pay run calendar
   *
   * @return updatedDateUTC LocalDateTime
   */
  public LocalDateTime getUpdatedDateUTC() {
    return updatedDateUTC;
  }

  /**
   * UTC timestamp of the last update to the pay run calendar
   *
   * @param updatedDateUTC LocalDateTime
   */
  public void setUpdatedDateUTC(LocalDateTime updatedDateUTC) {
    this.updatedDateUTC = updatedDateUTC;
  }

  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    PayRunCalendar payRunCalendar = (PayRunCalendar) o;
    return Objects.equals(this.payrollCalendarID, payRunCalendar.payrollCalendarID)
        && Objects.equals(this.name, payRunCalendar.name)
        && Objects.equals(this.calendarType, payRunCalendar.calendarType)
        && Objects.equals(this.periodStartDate, payRunCalendar.periodStartDate)
        && Objects.equals(this.periodEndDate, payRunCalendar.periodEndDate)
        && Objects.equals(this.paymentDate, payRunCalendar.paymentDate)
        && Objects.equals(this.updatedDateUTC, payRunCalendar.updatedDateUTC);
  }

  @Override
  public int hashCode() {
    return Objects.hash(
        payrollCalendarID,
        name,
        calendarType,
        periodStartDate,
        periodEndDate,
        paymentDate,
        updatedDateUTC);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class PayRunCalendar {\n");
    sb.append("    payrollCalendarID: ").append(toIndentedString(payrollCalendarID)).append("\n");
    sb.append("    name: ").append(toIndentedString(name)).append("\n");
    sb.append("    calendarType: ").append(toIndentedString(calendarType)).append("\n");
    sb.append("    periodStartDate: ").append(toIndentedString(periodStartDate)).append("\n");
    sb.append("    periodEndDate: ").append(toIndentedString(periodEndDate)).append("\n");
    sb.append("    paymentDate: ").append(toIndentedString(paymentDate)).append("\n");
    sb.append("    updatedDateUTC: ").append(toIndentedString(updatedDateUTC)).append("\n");
    sb.append("}");
    return sb.toString();
  }

  /**
   * Convert the given object to string with each line indented by 4 spaces (except the first line).
   */
  private String toIndentedString(java.lang.Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }
}