InstituteApiService.java

/*
 * Copyright 2025 Global Crop Diversity Trust
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.genesys.server.api.v1.facade;

import org.genesys.server.api.v1.model.Article;
import org.genesys.server.api.v1.model.FaoInstitute;
import org.genesys.server.exception.SearchException;
import org.genesys.server.model.genesys.PDCIStatistics;
import org.genesys.server.model.impl.Subset;
import org.genesys.server.service.ElasticsearchService;
import org.genesys.server.service.filter.InstituteFilter;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.List;
import java.util.Map;

public interface InstituteApiService {

	Page<FaoInstitute> list(InstituteFilter filter, Pageable page) throws SearchException;

	FaoInstitute findInstitute(String code);

	InstituteApiService.InstituteDetails details(String code);

	Map<String, Long> getCoverage(String code);

	FaoInstitute getInstitute(String wiewsCode);

	void downloadAuditLog(String wiewsCode, HttpServletResponse response) throws IOException;

	FaoInstitute update(String code, FaoInstitute institute);

	class InstituteDetails {
		public FaoInstitute details;
		public Article blurb;
		public PDCIStatistics pdciStats;
		public List<Object[]> lastUpdates;
		public Map<String, ElasticsearchService.TermResult> overview;
		public List<Subset> recentSubsets;
	}
}