/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MyCoRe is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with MyCoRe.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.mycore.orcid2.client;

/**
 * Interface for client that is at least compatible with ORCID Public or Member API.
 */
public interface MCRORCIDReadClient {

    /**
     * Fetches section/object of ORCID profile and wraps response into type.
     * 
     * @param orcid the ORCID iD
     * @param section the ORCID section
     * @param <T> the result class
     * @param valueType the result class
     * @param putCodes optional put code(s)
     * @return transformed section/object
     * @throws org.mycore.orcid2.client.exception.MCRORCIDRequestException if request fails
     */
    <T> T fetch(String orcid, MCRORCIDSection section, Class<T> valueType, long... putCodes);

    /**
     * Queries section and wraps result into given class.
     * 
     * @param type the search section type
     * @param query the query
     * @param <T> the result type
     * @param valueType the result type
     * @return search result
     * @throws org.mycore.orcid2.client.exception.MCRORCIDRequestException if request fails
     */
    <T> T search(MCRORCIDSearch type, String query, Class<T> valueType);

    /**
     * Queries section and wraps result into given class.
     * 
     * @param type the search section type
     * @param query the query
     * @param offset offset
     * @param limit limit
     * @param <T> the result type
     * @param valueType the result type
     * @return search result
     * @throws org.mycore.orcid2.client.exception.MCRORCIDRequestException if request fails
     */
    <T> T search(MCRORCIDSearch type, String query, int offset, int limit, Class<T> valueType);
}
