InventoryViabilityService.java

/*
 * Copyright 2026 Global Crop Diversity Trust
 * Licensed under the Apache License, Version 2.0
 * See LICENSE file in project root folder or http://www.apache.org/licenses/LICENSE-2.0
 */

package org.gringlobal.service;

import java.util.Collection;
import java.util.List;
import java.util.Map;
import javax.validation.constraints.NotNull;

import org.gringlobal.model.Cooperator;
import org.gringlobal.model.Inventory;
import org.gringlobal.model.InventoryViability;
import org.gringlobal.model.InventoryViabilityData;
import org.gringlobal.model.InventoryViabilityRule;
import org.gringlobal.model.OrderRequest;
import org.gringlobal.model.Site;
import org.gringlobal.service.filter.InventoryViabilityFilter;

import com.fasterxml.jackson.annotation.JsonUnwrapped;

/**
 * The Interface InventoryViabilityService.
 */
public interface InventoryViabilityService extends FilteredCRUDService2<InventoryViability, InventoryViabilityFilter> {

	/**
	 * Set up viability tests for selected inventories.
	 *
	 * @param inventoriesAndRules the map of inventory and corresponding rule
	 * {#link {@link InventoryViabilityRule}
	 * @return the order request
	 */
	OrderRequest orderViabilityTest(Site site, Map<Inventory, InventoryViabilityRule> inventoriesAndRules, Cooperator viabilityCooperator);

	/**
	 * List {@link InventoryViabilityData} for selected inventoryViability
	 * @param inventoryViability
	 * @return
	 */
	InventoryViabilityDetails loadDetails(InventoryViability inventoryViability);

	/**
	 * Retruns a summarized version of viability results across replicates
	 *
	 * @param inventoryViability record to analyze
	 * @param selectedReplicationNumbers select the replicates to use, if null or empty then all are used
	 * @return results for selected replicates
	 */
	InventoryViabilityDetails calculateResult(@NotNull InventoryViability inventoryViability, Collection<Integer> selectedReplicationNumbers);

	public static class InventoryViabilityDetails {
		public InventoryViabilityDetails(InventoryViability inventoryViability) {
			this.inventoryViability = inventoryViability;
		}

		@JsonUnwrapped
		public InventoryViability inventoryViability;

		public List<InventoryViabilityData> datas;
	}
}