br.eti.clairton.gson.hypermedia.HypermediableRule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gson-hypermedia Show documentation

Possibilidade de usar Hypermedia com o GSON

The newest version!

package br.eti.clairton.gson.hypermedia;

import java.util.Collection;
import java.util.Set;

/**
 * Serviço que deve retornar os links possíveis.

 * Mediante a posição atual ele deverá retornar quais os possíveis

 * caminhos poderão ser seguidos.
 * 
 * @author Clairton Rodrigo Heinzen
 */
public interface HypermediableRule {

	/**
	 * Deve retornar os links possíveis para navegação.

	 * Mediante o recurso, operação e instancia do objeto passadas como
	 * parametros deve recuperar os links.
	 * 
	 * @param target
	 *            objeto que esta sendo retornado na atual requisicao
	 * 
	 * @param resource
	 *            recurso atual
	 * 
	 * @param operation
	 *            operação atual
	 * @return {@link Set} de {@link Link}
	 */
	 Set from(final Collection target, final String resource, final String operation);

	/**
	 * Deve retornar os links possíveis para navegação.

	 * Mediante o recurso, operação e instancia do objeto passadas como
	 * parametros deve recuperar os links.
	 * 
	 * @param target
	 *            objeto que esta sendo retornado na atual requisicao
	 * 
	 * @param resource
	 *            recurso atual
	 * 
	 * @param operation
	 *            operação atual
	 * @return {@link Set} de {@link Link}
	 */
	 Set from(final T target, final String resource, final String operation);
}