/*
* eGov suite of products aim to improve the internal efficiency,transparency,
* accountability and the service delivery of the government organizations.
*
* Copyright (C) <2015> eGovernments Foundation
*
* The updated version of eGov suite of products as by eGovernments Foundation
* is available at http://www.egovernments.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see http://www.gnu.org/licenses/ or
* http://www.gnu.org/licenses/gpl.html .
*
* In addition to the terms of the GPL license to be adhered to in using this
* program, the following additional terms are to be complied with:
*
* 1) All versions of this program, verbatim or modified must carry this
* Legal Notice.
*
* 2) Any misrepresentation of the origin of the material is prohibited. It
* is required that all modified versions of this material be marked in
* reasonable ways as different from the original version.
*
* 3) This license does not grant any rights to any user of the program
* with regards to rights under trademark law for use of the trade names
* or trademarks of eGovernments Foundation.
*
* In case of any queries, you can reach eGovernments Foundation at contact@egovernments.org.
*/
package org.egov.infra.web.struts.annotation;
import com.opensymphony.xwork2.validator.ValidationInterceptor;
import org.egov.infra.validation.exception.ValidationException;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* This annotation is used to annotate, action's method which possibly
* throws a {@link ValidationException}. {@link ValidationInterceptor}
* will invoke the {@link ValidationErrorPageForward#forwarderMethod()}
* and the returned result name will be used forward the request.
* The value for {@link ValidationErrorPageForward#forwarderMethod()}
* must follow certain rules as follows
* (a) It must be a valid method name
* (b) Method must exist in the same or parent class.
* (c) Method should be public
* (d) Method should always return a String value
* (e) The returning string value must be a valid result name
* (f) Method signature should not contain parameter.
* e.g.
* <code>
* @ValidationErrorPageForward(forwarderMethod="getResult")
* public String save() {
* //.......
* //do your code
* }
*
* public String getResult() {
* //.... do your code
* return your result name;
* }
* </code>
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface ValidationErrorPageForward {
String forwarderMethod();
}