com.unboundid.scim2.extension.messages.contactvalidation.TelephonyValidationRequest Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016-2019 Ping Identity Corporation
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License (GPLv2 only)
 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see .
 */

package com.unboundid.scim2.extension.messages.contactvalidation;

import com.unboundid.scim2.common.BaseScimResource;
import com.unboundid.scim2.common.annotations.Attribute;
import com.unboundid.scim2.common.annotations.Schema;
import com.unboundid.scim2.common.types.AttributeDefinition;

import java.util.Calendar;

/**
 * The request for validating a phone number.
 */
@Schema(description = "Telephony Validation Request",
    id = "urn:pingidentity:scim:api:messages:2.0:TelephonyValidationRequest",
    name = "TelephonyValidationRequest")
public class TelephonyValidationRequest extends BaseScimResource
{
  @Attribute(description = "The attribute path containing the telephone " +
      "number.",
      mutability = AttributeDefinition.Mutability.IMMUTABLE,
      isRequired = true,
      returned = AttributeDefinition.Returned.ALWAYS)
  private String attributePath;

  @Attribute(description = "The telephone number.",
      mutability = AttributeDefinition.Mutability.IMMUTABLE,
      returned = AttributeDefinition.Returned.ALWAYS)
  private String attributeValue;

  @Attribute(description = "The language and locale of the message.",
      mutability = AttributeDefinition.Mutability.IMMUTABLE,
      returned = AttributeDefinition.Returned.NEVER)
  private String language;

  @Attribute(description = "The messaging provider to use when sending the " +
      "verification code.",
      mutability = AttributeDefinition.Mutability.IMMUTABLE,
      isRequired = true,
      returned = AttributeDefinition.Returned.ALWAYS)
  private String messagingProvider;

  @Attribute(description = "The code to verify.",
      mutability = AttributeDefinition.Mutability.WRITE_ONLY,
      returned = AttributeDefinition.Returned.NEVER)
  private String verifyCode;

  @Attribute(description = "Whether the current telephone number was " +
      "successfully validated.",
      mutability = AttributeDefinition.Mutability.READ_ONLY,
      returned = AttributeDefinition.Returned.ALWAYS)
  private Boolean validated;

  @Attribute(description = "The last time the current telephone number was " +
      "successfully validated.",
      mutability = AttributeDefinition.Mutability.READ_ONLY,
      returned = AttributeDefinition.Returned.ALWAYS)
  private Calendar validatedAt;

  @Attribute(description = "Whether a verification code was sent and is " +
      "pending validation.",
      mutability = AttributeDefinition.Mutability.READ_ONLY,
      returned = AttributeDefinition.Returned.ALWAYS)
  private Boolean codeSent;

  private TelephonyValidationRequest()
  {
    // For Jackson
  }

  /**
   * Create a new EmailValidationRequest.
   *
   * @param attributePath The attribute path containing the email address to
   *                      verify.
   */
  public TelephonyValidationRequest(final String attributePath)
  {
    this.attributePath = attributePath;
  }

  /**
   * Retrieve the attribute path.
   * @return  The attribute path.
   */
  public String getAttributePath()
  {
    return attributePath;
  }



  /**
   * Set the attribute path.
   * @param attributePath  The attribute path.
   */
  public void setAttributePath(final String attributePath)
  {
    this.attributePath = attributePath;
  }



  /**
   * Retrieve the attribute value.
   * @return  The attribute value.
   */
  public String getAttributeValue()
  {
    return attributeValue;
  }



  /**
   * Set the attribute value.
   * @param attributeValue  The attribute value.
   */
  public void setAttributeValue(final String attributeValue)
  {
    this.attributeValue = attributeValue;
  }



  /**
   * Indicates whether the attribute value is validated.
   * @return  {@code true} iff the attribute value is validated.
   */
  public Boolean getValidated()
  {
    return validated;
  }



  /**
   * Specify whether the attribute value is validated.
   * @param validated  {@code true} iff the attribute value is validated.
   */
  public void setValidated(final Boolean validated)
  {
    this.validated = validated;
  }



  /**
   * Retrieve the time at which the attribute value was validated.
   * @return  The time at which the attribute value was validated.
   */
  public Calendar getValidatedAt()
  {
    return validatedAt;
  }



  /**
   * Set the time at which the attribute value was validated.
   * @param validatedAt  The time at which the attribute value was validated.
   */
  public void setValidatedAt(final Calendar validatedAt)
  {
    this.validatedAt = validatedAt;
  }



  /**
   * Indicates whether a verification code has been sent.
   * Only applicable in an intermediate response to update preferences.
   * @return  {@code true} iff a verification code has been sent.
   */
  public Boolean getCodeSent()
  {
    return codeSent;
  }



  /**
   * Specify whether a verification code has been sent.
   * Only applicable in an intermediate response to update preferences.
   * @param codeSent  {@code true} iff a verification code has been sent.
   */
  public void setCodeSent(final Boolean codeSent)
  {
    this.codeSent = codeSent;
  }


  /**
   * Retrieve the language and locale of the message.
   * @return  The language and locale of the message.
   */
  public String getLanguage()
  {
    return language;
  }


  /**
   * Specify the language and locale of the message.
   * @param language  The language and locale of the message.
   */
  public void setLanguage(final String language)
  {
    this.language = language;
  }


  /**
   * Retrieve the selected messaging provider.
   * @return  The selected messaging provider.
   */
  public String getMessagingProvider()
  {
    return messagingProvider;
  }

  /**
   * Specify the selected messaging provider.
   * @param  messagingProvider  The selected messaging provider.
   */
  public void setMessagingProvider(
      final String messagingProvider)
  {
    this.messagingProvider = messagingProvider;
  }

  /**
   * Retrieve the code to be verified against the delivered code.
   * @return  The code to be verified against the delivered code.
   */
  public String getVerifyCode()
  {
    return verifyCode;
  }



  /**
   * Specify the code to be verified against the delivered code.
   * @param verifyCode  The code to be verified against the delivered code.
   */
  public void setVerifyCode(final String verifyCode)
  {
    this.verifyCode = verifyCode;
  }
}