io.katharsis.repository.MetaRepositoryV2 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

The newest version!

package io.katharsis.repository;

import io.katharsis.legacy.repository.RelationshipRepository;
import io.katharsis.legacy.repository.ResourceRepository;
import io.katharsis.queryspec.QuerySpec;
import io.katharsis.resource.meta.MetaInformation;

/**
 * An optional interface that can be implemented along with {@link ResourceRepository} or {@link
 * RelationshipRepository} to get meta information about returned resource(s).
 * 
 * Consider the use use ResourceList instead
 */
public interface MetaRepositoryV2 {

	/**
	 * Return meta information about a resource. Can be called after find repository methods call
	 *
	 * @param resources a list of found resource(s)
	 * @param querySpec sent along with the request
	 * @return meta information object
	 */
	MetaInformation getMetaInformation(Iterable resources, QuerySpec querySpec);
}