Interface CompositionEndpoint

All Known Implementing Classes:
DefaultRestCompositionEndpoint

public interface CompositionEndpoint
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete(com.nedap.archie.rm.support.identification.ObjectVersionId precedingVersionUid)
    Deletes a Composition by preceding version uid.
    <T> Optional<T>
    find(UUID compositionId, Class<T> clazz)
    Finds a Flat-Entity by
    Optional<com.nedap.archie.rm.composition.Composition>
    findRaw(UUID compositionId)
     
    <T> T
    Save a Flat-Entity to remote systems.
    com.nedap.archie.rm.support.identification.ObjectVersionId
    mergeRaw(com.nedap.archie.rm.composition.Composition composition)
     
  • Method Details

    • mergeCompositionEntity

      <T> T mergeCompositionEntity(T entity)
      Save a Flat-Entity to remote systems.
      Parameters:
      entity - Flat-Entity to save. Has to be annotated with Template
      Returns:
      CompositionId
      Throws:
      ClientException
      WrongStatusCodeException
    • mergeRaw

      com.nedap.archie.rm.support.identification.ObjectVersionId mergeRaw(com.nedap.archie.rm.composition.Composition composition)
    • find

      <T> Optional<T> find(UUID compositionId, Class<T> clazz)
      Finds a Flat-Entity by
      Parameters:
      compositionId - CompositionId of the flat-Entity to retrieve.
      clazz - class of the flat-Entity to retrieve. Has to be annotated with Template
      Returns:
      The Flat-Entity
      Throws:
      ClientException
      WrongStatusCodeException
    • findRaw

      Optional<com.nedap.archie.rm.composition.Composition> findRaw(UUID compositionId)
    • delete

      void delete(com.nedap.archie.rm.support.identification.ObjectVersionId precedingVersionUid)
      Deletes a Composition by preceding version uid.
      Parameters:
      precedingVersionUid - identifier of the Composition to be deleted. This MUST be the last (most recent) version.
      Throws:
      ClientException
      WrongStatusCodeException