Provide API for querying experiment information (#1121)

* Provide API for querying experiment information

* Throw runtime exception

Author: sven1103

project-management/src/main/java/life/qbic/projectmanagement/application/api/AsyncProjectService.java

@@ -110,8 +110,9 @@ public interface AsyncProjectService {
    * the throw section below.
    *
    * @param request the actual {@link ProjectDeletionRequest}
-   * @return a {@link Mono<ProjectDeletionResponse>} object publishing an {@link ProjectDeletionResponse} on success.
-   * Exceptions are provided as {@link Mono#error(Throwable)}
+   * @return a {@link Mono<ProjectDeletionResponse>} object publishing an
+   * {@link ProjectDeletionResponse} on success. Exceptions are provided as
+   * {@link Mono#error(Throwable)}
    * @throws UnknownRequestException if an unknown request has been used in the service call
    * @throws RequestFailedException  if the request was not successfully executed
    * @throws AccessDeniedException   if the user has insufficient rights
@@ -171,6 +172,22 @@ Mono<ProjectCreationResponse> create(ProjectCreationRequest request)
   Flux<ByteBuffer> roCrateSummary(String projectId)
       throws RequestFailedException, AccessDeniedException;
 
+  /**
+   * Return a reactive stream of {@link ExperimentDescription} for a given project.
+   * <p>
+   * <b>Exceptions</b>
+   * <p>
+   * Exceptions are wrapped as {@link Mono#error(Throwable)} and are one of the types described in
+   * the throw section below.
+   * @param projectId the identifier of the project to get the experiments for
+   * @return a {@link Flux} of {@link ExperimentDescription}. Exceptions are provided as
+   * {@link Mono#error(Throwable)}.
+   * @throws RequestFailedException in case the request cannot be processed
+   * @throws AccessDeniedException  in case of insufficient rights
+   * @since 1.10.0
+   */
+  Flux<ExperimentDescription> getExperiments(String projectId);
+
   /**
    * Requests {@link SamplePreview} for a given experiment with pagination support.
    * <p>
@@ -827,6 +844,7 @@ record SampleRegistrationInformation(
       String experimentId,
       String projectId
   ) implements ValidationRequestBody {
+
   }
 
   /**
@@ -866,7 +884,6 @@ record SampleUpdateInformation(
   }
 
 
-
   record MeasurementRegistrationInformationNGS(
       Collection<String> sampleCodes,
       String organisationId, String instrumentCURI, String facility,
@@ -875,6 +892,7 @@ record MeasurementRegistrationInformationNGS(
       String indexI7, String indexI5,
       String comment
   ) implements ValidationRequestBody {
+
   }
 
   record MeasurementUpdateInformationNGS(
@@ -887,6 +905,7 @@ record MeasurementUpdateInformationNGS(
       String sequencingRunProtocol, String samplePoolGroup,
       String indexI7, String indexI5,
       String comment) implements ValidationRequestBody {
+
   }
 
   record MeasurementRegistrationInformationPxP(
@@ -972,7 +991,9 @@ public ProjectUpdateRequest(String projectId, ProjectUpdateRequestBody requestBo
 
   }
 
-  record ProjectDeletionRequest(String projectId, String requestId, ProjectDeletionRequestBody body) {
+  record ProjectDeletionRequest(String projectId, String requestId,
+                                ProjectDeletionRequestBody body) {
+
     public ProjectDeletionRequest {
       if (projectId == null) {
         throw new IllegalArgumentException("Project ID cannot be null");

project-management/src/main/java/life/qbic/projectmanagement/application/api/AsyncProjectServiceImpl.java

@@ -160,6 +160,11 @@ public Flux<ByteBuffer> roCrateSummary(String projectId) {
         original -> writeSecurityContextMany(original, securityContext));
   }
 
+  @Override
+  public Flux<ExperimentDescription> getExperiments(String projectId) {
+    throw new RuntimeException("Not yet implemented");
+  }
+
   // Requires the SecurityContext to work
   private Flux<ByteBuffer> getByteBufferFlux(String projectId) {
     var search = projectService.find(projectId);