io.katharsis.repository.annotations.JsonApiFindManyTargets 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: 3.0.2

package io.katharsis.repository.annotations;

import io.katharsis.queryParams.QueryParams;

import java.io.Serializable;
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 many relationship resources on a particular
 * resource. The method must be defined in a class annotated with {@link JsonApiRelationshipRepository}.
 * 
 * 
 * The requirements for the method parameters are as follows:
 * 
 * 
 *     An identifier of a source resource
 *     Relationship's field name
 * 
 * 
 * The return value must be an {@link Iterable} of resources of {@link JsonApiRelationshipRepository#target()} type.
 * 
 *
 * @see io.katharsis.repository.RelationshipRepository#findManyTargets(Serializable, String, QueryParams)
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface JsonApiFindManyTargets {
}