DiversityTreeApiService.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.v2.facade;

import java.io.IOException;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;

import org.genesys.filerepository.InvalidRepositoryFileDataException;
import org.genesys.filerepository.InvalidRepositoryPathException;
import org.genesys.server.api.FilteredPage;
import org.genesys.server.api.v2.model.impl.DiversityTreeAccessionRefDTO;
import org.genesys.server.api.v2.model.impl.DiversityTreeCreatorDTO;
import org.genesys.server.api.v2.model.impl.DiversityTreeDTO;
import org.genesys.server.exception.SearchException;
import org.genesys.server.service.ElasticsearchService;
import org.genesys.server.service.filter.DiversityTreeFilter;

import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.web.multipart.MultipartFile;

import com.fasterxml.jackson.annotation.JsonUnwrapped;

public interface DiversityTreeApiService {

	DiversityTreeDTO load(UUID uuid);

	DiversityTreeDTO create(DiversityTreeDTO source);

	DiversityTreeDTO update(DiversityTreeDTO source);

	DiversityTreeDTO remove(UUID uuid, int version);

	Page<DiversityTreeDTO> list(DiversityTreeFilter filter, Pageable id) throws SearchException;

	Page<DiversityTreeDTO> listForCurrentUser(DiversityTreeFilter filter, Pageable lastModifiedDate);

	Page<DiversityTreeAccessionRefDTO> listAccessions(UUID uuid, Pageable page);

	DiversityTreeDTO addAccessions(UUID uuid, int version, Set<DiversityTreeAccessionRefDTO> accessionRefs);

	DiversityTreeDTO setAccessions(UUID uuid, int version, Set<DiversityTreeAccessionRefDTO> accessionRefs);

	DiversityTreeDTO uploadAccessions(UUID uuid, int version, char separator, char quotechar, MultipartFile file) throws IOException;

	DiversityTreeDTO rematchAccessions(UUID uuid, int version);

	DiversityTreeDTO approve(UUID uuid, int version);

	DiversityTreeDTO reject(UUID uuid, int version);

	DiversityTreeDTO createNewVersion(UUID uuid);

	DiversityTreeDTO uploadFile(UUID uuid, MultipartFile file) throws IOException, InvalidRepositoryPathException, InvalidRepositoryFileDataException;

	Page<DiversityTreeCreatorDTO> listCreators(UUID uuid, Pageable page);

	DiversityTreeCreatorDTO loadCreator(UUID creatorUuid);

	DiversityTreeCreatorDTO create(UUID uuid, DiversityTreeCreatorDTO creator);

	DiversityTreeCreatorDTO update(UUID uuid, DiversityTreeCreatorDTO creator);

	DiversityTreeCreatorDTO remove(UUID treeUuid, UUID creatorUuid, int version);

	List<DiversityTreeCreatorDTO> autocompleteCreators(String term);


	public static class DiversityTreeSuggestionPageDTO {
		@JsonUnwrapped
		public FilteredPage<DiversityTreeDTO, DiversityTreeFilter> page;
		public Map<String, ElasticsearchService.TermResult> suggestions;

		public static DiversityTreeSuggestionPageDTO from(FilteredPage<DiversityTreeDTO, DiversityTreeFilter> page, Map<String, ElasticsearchService.TermResult> suggestions) {
			DiversityTreeSuggestionPageDTO res = new DiversityTreeSuggestionPageDTO();
			res.page = page;
			res.suggestions = suggestions;
			return res;
		}
	}
}