eu.erasmuswithoutpaper.registryclient.HeiEntry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ewp-registry-client Show documentation

Allows to run queries on EWP (Erasmus Without Paper) Registry Service.

The newest version!

package eu.erasmuswithoutpaper.registryclient;

import java.util.Collection;


/**
 * Describes a single HEI entry, as found in the EWP Registry's catalogue.
 *
 * 
 * Note, that the EWP Registry keeps only the very import attributes of each HEI (identifiers and
 * name). If you are looking for more information on HEIs, then you should make use of the
 * Institutions
 * API.
 * 
 *
 * @since 1.2.0
 */
public interface HeiEntry {

  /**
   * @return SCHAC ID of this HEI.
   */
  String getId();

  /**
   * Get the name of this HEI.
   *
   * @return We will try to return the name in English. If we cannot find it, we will return the
   *         name in any other language. If we fail this too, we will return the HEI's ID, so you
   *         will never get null here.
   */
  String getName();

  /**
   * Get a name in the given language, or null.
   *
   * 
   * Please note, that this operates on exact BCP 47 language tag values. This means that,
   * for example, if the HEI name was described with "ru-Latn" xml:lang, then (currently) you won't
   * retrieve this name by asking for "ru". This behavior MAY change in the future (we will probably
   * consider it a backward-compatible change).
   * 
   *
   * @param langCode BCP 47 language tag (e.g. "en" or "ru-Latn").
   * @return String (if exact match was found), or null (if it wasn't).
   */
  String getName(String langCode);

  /**
   * Get the English name of this HEI, or null.
   *
   * @return We will try to return the name in English. If we cannot find it, we will return
   *         null (this differs from the behavior of {@link #getName()}).
   */
  String getNameEnglish();

  /**
   * Get a non-English name of this HEI, or null.
   *
   * @return We will try to return the first non-English name of this HEI. If we cannot find it (the
   *         HEI supplied only its English name), then null will be returned.
   */
  String getNameNonEnglish();

  /**
   * Retrieve all <other-id> values of certain type.
   *
   * @param type type identifier, see {@link RegistryClient#findHei(String, String)} for more
   *        information on these types.
   * @return A collection of all matched values for the given type. In no matches were found, an
   *         empty collection will be returned.
   */
  Collection getOtherIds(String type);
}