Interface IdentifierService

All Known Subinterfaces:
CollectionEntityService<T>, CollectionService, DatasetService, InstallationService, InstitutionService, NetworkEntityService<T>, NetworkService, NodeService, OrganizationService, PrimaryIdentifierService

public interface IdentifierService
Service provides a set of operations on Identifier.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    addIdentifier(@NotNull UUID targetEntityKey, @NotNull @Valid Identifier identifier)
    Add a new Identifier to a target entity.
    void
    deleteIdentifier(@NotNull UUID targetEntityKey, int identifierKey)
    Delete an existing Identifier from a target entity by identifier key.
    listIdentifiers(@NotNull UUID targetEntityKey)
    List all identifiers of a target entity.
  • Method Details

    • addIdentifier

      int addIdentifier(@NotNull @NotNull UUID targetEntityKey, @NotNull @Valid @NotNull @Valid Identifier identifier)
      Add a new Identifier to a target entity.
      Parameters:
      targetEntityKey - key of target entity
      identifier - Identifier to add
      Returns:
      key of Identifier added
    • deleteIdentifier

      void deleteIdentifier(@NotNull @NotNull UUID targetEntityKey, int identifierKey)
      Delete an existing Identifier from a target entity by identifier key.
      Parameters:
      targetEntityKey - key of target entity
      identifierKey - Identifier key to delete
    • listIdentifiers

      List<Identifier> listIdentifiers(@NotNull @NotNull UUID targetEntityKey)
      List all identifiers of a target entity.
      Parameters:
      targetEntityKey - key of target entity
      Returns:
      list of identifiers that belong to the entity