JsonApiFindAllWithIds.java

package io.katharsis.repository.annotations;

import io.katharsis.queryParams.QueryParams;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Method annotated with this annotation will be used to perform find all operation constrained by a list of
 * identifiers. The method must be defined in a class annotated with {@link JsonApiResourceRepository}.
 * <p>
 * The requirements for the method parameters are as follows:
 * </p>
 * <ol>
 *     <li>An {@link Iterable} of resource identifiers</li>
 * </ol>
 * <p>
 * The return value must be an {@link Iterable} of resources of {@link JsonApiResourceRepository#value()} type.
 *
 * @see io.katharsis.repository.ResourceRepository#findAll(Iterable, QueryParams)
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface JsonApiFindAllWithIds {
}