InstituteApiService.java

/*
 * Copyright 2024 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.v2.facade;

import org.genesys.server.api.v2.model.impl.ArticleDTO;
import org.genesys.server.api.v2.model.impl.FaoInstituteDTO;
import org.genesys.server.api.v2.model.impl.SubsetDTO;
import org.genesys.server.api.v2.model.impl.TranslatedArticleDTO;
import org.genesys.server.api.v2.model.impl.VocabularyTermDTO;
import org.genesys.server.model.genesys.PDCIStatistics;
import org.genesys.server.model.impl.FaoInstitute;
import org.genesys.server.service.CRMException;
import org.genesys.server.service.ElasticsearchService;
import org.genesys.server.service.filter.InstituteFilter;

import java.util.List;
import java.util.Map;
import java.util.Set;

public interface InstituteApiService extends APIFilteredServiceFacade<FaoInstituteDTO, FaoInstitute, InstituteFilter> {

	FaoInstituteDTO findInstitute(String wiewsCode);

	InstituteDetails getDetails(String code);

	TranslatedArticleDTO updateArticle(FaoInstitute faoInstitute, ArticleDTO article) throws CRMException;

	FaoInstituteDTO update(String code, FaoInstituteDTO institute);

	VocabularyTermDTO getInstituteTerm(String code);

	List<VocabularyTermDTO> autocompleteTerm(String text);

	Map<String, String> decodeWiewsCodes(Set<String> codes);

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