001/*
002 * Copyright 2020 Global Biodiversity Information Facility (GBIF)
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.gbif.api.service.checklistbank;
017
018import org.gbif.api.model.common.paging.Pageable;
019import org.gbif.api.model.common.paging.PagingResponse;
020
021import javax.annotation.Nullable;
022
023/**
024 * Parameterized service interface for model classes extending a NameUsage.
025 * @param <T> the extension model class.
026 */
027public interface NameUsageExtensionService<T> {
028
029  /**
030   * Returns all extension records for a checklist usage.
031   *
032   * @param taxonKey the usage the extensions are related to
033   * @param page     paging parameters or null for first page with default size
034   *
035   * @return Wrapper that contains a potentially empty component list, but never null
036   */
037  PagingResponse<T> listByUsage(int taxonKey, @Nullable Pageable page);
038
039}