io.katharsis.repository.ResourceRepository Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of katharsis-core Show documentation

Core Katharsis library

There is a newer version: 2.6.3

package io.katharsis.repository;

import io.katharsis.queryParams.QueryParams;
import io.katharsis.resource.exception.ResourceNotFoundException;

import java.io.Serializable;

/**
 * Base repository which is used to operate on the resources. Each resource should have a corresponding repository
 * implementation.
 *
 * @param   Type of an entity
 * @param  Type of Identifier of an entity
 */
public interface ResourceRepository {

    /**
     * Search one resource with a given ID. If a resource cannot be found, a {@link ResourceNotFoundException}
     * exception should be thrown.
     *
     * @param id an identifier of the resource
     * @param queryParams parameters sent along with the request
     * @return an instance of the resource
     */
    T findOne(ID id, QueryParams queryParams);

    /**
     * Search for all of the resources. An instance of {@link QueryParams} can be used if necessary. If no
     * resources can be found, an empty {@link Iterable} or null must be returned.
     *
     * @param queryParams parameters send with the request
     * @return a list of found resources
     */
    Iterable findAll(QueryParams queryParams);

    /**
     * Search for resources constrained by a list of identifiers. An instance of {@link QueryParams} can be used if
     * necessary. If no resources can be found, an empty {@link Iterable} or null must be returned.
     *
     * @param ids an {@link Iterable} of passed resource identifiers
     * @param queryParams parameters send with the request
     * @return a list of found resources
     */
    Iterable findAll(Iterable ids, QueryParams queryParams);

    /**
     * Saves a resource. A Returning resource must include assigned identifier created for the instance of resource.
     *
     * @param entity resource to be saved
     * @param  type of the resource
     * @return saved resource. Must include set identifier.
     */
     S save(S entity);

    /**
     * Removes a resource identified by id parameter.
     *
     * @param id identified of the resource to be removed
     */
    void delete(ID id);
}