io.katharsis.repository.LinksRepository 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.response.LinksInformation;

/**
 * An optional interface that can be implemented along with {@link ResourceRepository} or {@link
 * RelationshipRepository} to get links information about returned resource(s).
 */
public interface LinksRepository {
    /**
     * Return meta information about a resource. Can be called after find repository methods call
     *
     * @param resources a list of found resource(s)
     * @param queryParams parameters sent along with the request
     * @return meta information object
     */
    LinksInformation getLinksInformation(Iterable resources, QueryParams queryParams);
}