fr.ird.observe.services.service.api.ReferentialEntityService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of toolkit-service Show documentation
ObServe Toolkit Service module
The newest version!
package fr.ird.observe.services.service.api;

/*-
 * #%L
 * ObServe Toolkit :: Service
 * %%
 * Copyright (C) 2017 - 2021 Ultreia.io
 * %%
 * This program 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.
 *
 * This program 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 this program.  If not, see
 * .
 * #L%
 */

import fr.ird.observe.dto.ToolkitId;
import fr.ird.observe.dto.referential.ReferentialDto;
import fr.ird.observe.security.Permission;
import fr.ird.observe.services.service.ObserveService;
import fr.ird.observe.services.spi.MethodCredential;
import fr.ird.observe.toolkit.navigation.tree.io.ToolkitTreeNodeStates;
import fr.ird.observe.toolkit.navigation.tree.io.request.OrderEnum;
import fr.ird.observe.toolkit.navigation.tree.io.request.ToolkitRequestConfig;
import io.ultreia.java4all.http.spi.Delete;
import io.ultreia.java4all.http.spi.Get;
import io.ultreia.java4all.http.spi.Nullable;
import io.ultreia.java4all.http.spi.Post;
import io.ultreia.java4all.http.spi.Put;
import io.ultreia.java4all.http.spi.Write;

import java.util.Map;

/**
 * Created on 18/04/2021.
 *
 * @author Tony Chemit - [email protected]
 * @since 5.0.17
 */
public interface ReferentialEntityService extends ObserveService {

    @Get
    @MethodCredential(Permission.READ_REFERENTIAL)
    ToolkitTreeNodeStates getByModule(@Nullable String moduleName, @Nullable ToolkitRequestConfig config);

    @Get
    @MethodCredential(Permission.READ_REFERENTIAL)
    ToolkitTreeNodeStates getByPackage(@Nullable String packageName, @Nullable ToolkitRequestConfig config);

    @Get
    @MethodCredential(Permission.READ_REFERENTIAL)
    ToolkitTreeNodeStates getOne(Class dtoType, @Nullable ToolkitRequestConfig config, String id);

    @Get
    @MethodCredential(Permission.READ_REFERENTIAL)
    ToolkitTreeNodeStates getAll(Class dtoType, @Nullable ToolkitRequestConfig config, @Nullable Map orders);

    @Get
    @MethodCredential(Permission.READ_REFERENTIAL)
    default ToolkitTreeNodeStates getAll(Class dtoType, @Nullable ToolkitRequestConfig config) {
        return getAll(dtoType, config, null);
    }

    @Get
    @MethodCredential(Permission.READ_REFERENTIAL)
    ToolkitTreeNodeStates getSome(Class dtoType, @Nullable ToolkitRequestConfig config, Map filters, @Nullable Map orders);

    @Get
    @MethodCredential(Permission.READ_REFERENTIAL)
    default ToolkitTreeNodeStates getSome(Class dtoType, @Nullable ToolkitRequestConfig config, Map filters) {
        return getSome(dtoType, config, filters, Map.of());
    }

    @Post(useMultiPartForm = true)
    @MethodCredential(Permission.WRITE_REFERENTIAL)
    @Write
    ToolkitId create(Class dtoType, String content) throws InvalidDataException;

    @Put(useMultiPartForm = true)
    @MethodCredential(Permission.WRITE_REFERENTIAL)
    @Write
    ToolkitId update(Class dtoType, String id, String content) throws InvalidDataException;

    @Delete
    @MethodCredential(Permission.WRITE_REFERENTIAL)
    @Write
    void delete(Class dtoType, String id);

}