BaseValidator.java

/*
 * RHQ Management Platform
 * Copyright (C) 2005-2008 Red Hat, Inc.
 * All rights reserved.
 *
 * 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 version 2 of the License.
 *
 * 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, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
package org.rhq.enterprise.gui.legacy.validator;

import javax.servlet.http.HttpServletRequest;
import org.apache.commons.validator.Field;
import org.apache.commons.validator.ValidatorAction;
import org.apache.struts.action.ActionMessages;

/**
 * This declares a common interface for validators. It is an abstract class in case we need to put common methods here.
 */
public abstract class BaseValidator {
    /**
     * Creates a new instance of BaseValidator
     */
    public BaseValidator() {
    }

    /**
     * This method should be overridden to perform whatever validation locgic is necessary.
     *
     * @param  bean
     * @param  va
     * @param  field
     * @param  errors  Any errors should be stored in the ActionErrors collection.
     * @param  request The current http request that is being processed.
     *
     * @return Returns true if the form is valid according to the logic in this method, false if not.
     */
    public abstract boolean validate(Object bean, ValidatorAction va, Field field, ActionMessages errors,
        HttpServletRequest request);
}