com.onegini.sdk.model.CollectionField Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of idp-sdk Show documentation

Java SDK to connect to the Onegini platform

There is a newer version: 5.92.0

/*
 * Copyright 2013-2020 Onegini b.v.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.onegini.sdk.model;

import java.io.Serializable;

/**
 * Interface for Profile fields in a Collection
 */
public interface CollectionField extends Serializable {

  /**
   * Flag to indicate whether this is the primary object within the user's profile.
   *
   * @return {@link Boolean#TRUE} if this is the primary object
   */
  Boolean isPrimary();

  /**
   * An optional flag to indicate whether this object has been verified.
   *
   * @return {@link Boolean#TRUE} if this object has been verified
   */
  Boolean isVerified();

  /**
   * An optional tag to indicate the difference (e.g. home address, billing address, work email, fax)
   *
   * @return tag
   */
  String getTag();

  /**
   * @return String representation of the value of the CollectionField
   */
  String getValue();

}