ca.gc.aafc.dina.vocabulary.VocabularyElement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dina-base-api Show documentation

Base DINA API package for Java built on SpringBoot and Crnk

The newest version!

package ca.gc.aafc.dina.vocabulary;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Pattern;

import ca.gc.aafc.dina.i18n.MultilingualTitle;

/**
 * Define the main interface of a vocabulary element in its simplest form.
 *
 */
public interface VocabularyElement {

  /**
   * Immutable and stable key representing the vocabulary.
   * Used as stable identifier within the system boundaries.
   *
   * The key is mandatory and can't contain a dot (.).
   *
   * @return
   */
  @NotBlank
  @Pattern(regexp = "^[^.]+$")
  String getKey();

  /**
   * Common human-readable name given to the vocabulary.
   * Optional.
   * @return
   */
  String getName();

  /**
   * Usually a URI pointing to a term definition outside the system boundaries.
   * Optional.
   * @return
   */
  String getTerm();

  MultilingualTitle getMultilingualTitle();

}