/***
 * Copyright (c) 2009 Caelum - www.caelum.com.br/opensource
 * All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * 	http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package br.com.caelum.vraptor;

import java.util.Collection;
import java.util.List;

import br.com.caelum.vraptor.validator.Message;
import br.com.caelum.vraptor.validator.Validations;

/**
 * A validator interface for vraptor3.<br>
 * Based on hamcrest, it allows you to assert for specific situations.
 *
 * @author Guilherme Silveira
 */
public interface Validator {

	void checking(Validations rules);

	/**
	 * Validate an object using some Bean Validation engine. If the object is null,
	 * the validation will be skipped.
	 *
	 * @param object The object to be validated.
	 * @param groups The groups to be validated.
	 * @since vraptor3.1.2
	 */
	void validate(Object object, Class<?>... groups);

	/**
	 * Validate the specifics propeties of an object using some Bean Validation engine. If the object is null,
	 * the validation will be skipped.
	 * 
	 * @param object The object to be validated.
	 * @param properties The names of properties to be validated.
	 */
	void validateProperties(Object object, String... properties);
	
	/**
	 * Validate the specific property of an object using some Bean Validation engine. If the object is null,
	 * the validation will be skipped.
	 * 
	 * @param object The object to be validated.
	 * @param property The name of property to be validated.
	 * @param groups The groups to be validated.
	 */
	void validateProperty(Object object, String property, Class<?>... groups);

	<T extends View> T onErrorUse(Class<T> view);

	void addAll(Collection<? extends Message> message);

	void add(Message message);

	List<Message> getErrors();
	
	boolean hasErrors();

	/**
	 * Shortcut for <br>
	 * <pre>onErrorUse(logic()).forwardTo(controller);</pre>
	 */
	<T> T onErrorForwardTo(Class<T> controller);
	/**
	 * Shortcut for <br>
	 * <pre>onErrorUse(logic()).forwardTo(controller.getClass());</pre>
	 *
	 * For usage in the same controller:<br>
	 * <pre>validator.onErrorForwardTo(this).someLogic();</pre>
	 */
	<T> T onErrorForwardTo(T controller);

	/**
	 * Shortcut for <br>
	 * <pre>onErrorUse(logic()).redirectTo(controller);</pre>
	 */
	<T> T onErrorRedirectTo(Class<T> controller);
	/**
	 * Shortcut for <br>
	 * <pre>onErrorUse(logic()).redirectTo(controller.getClass());</pre>
	 *
	 * For usage in the same controller:<br>
	 * <pre>validator.onErrorRedirectTo(this).someLogic();</pre>
	 */
	<T> T onErrorRedirectTo(T controller);

	/**
	 * Shortcut for <br>
	 * <pre>onErrorUse(page()).of(controller);</pre>
	 */
	<T> T onErrorUsePageOf(Class<T> controller);
	/**
	 * Shortcut for <br>
	 * <pre>onErrorUse(page()).of(controller.getClass());</pre>
	 *
	 * For usage in the same controller:<br>
	 * <pre>validator.onErrorUsePageOf(this).someLogic();</pre>
	 */
	<T> T onErrorUsePageOf(T controller);

	/**
	 * Shortcut for <br>
	 * <pre>onErrorUse(status()).badRequest(errors);</pre>
	 *
	 * the actual validation errors list will be used.
	 */
	void onErrorSendBadRequest();

}