001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.gwt.shared;
029
030import com.google.gwt.user.client.rpc.IsSerializable;
031
032/**
033 * A simple bean class which represents a validation request for a single form field.<p>
034 *
035 * @since 8.0.0
036 */
037public class CmsValidationQuery implements IsSerializable {
038
039    /** The configuration string for the server-side validator. */
040    private String m_config;
041
042    /** The class name of the server-side validator. */
043    private String m_validatorId;
044
045    /** The value which should be validated. */
046    private String m_value;
047
048    /**
049     * Constructor.<p>
050     *
051     * @param validator the server-side validator class name
052     * @param value the value to validate
053     * @param config the configuration string for the server-side validator
054     */
055    public CmsValidationQuery(String validator, String value, String config) {
056
057        m_validatorId = validator;
058        m_value = value;
059        m_config = config;
060    }
061
062    /**
063     * Hidden default constructor.<p>
064     */
065    protected CmsValidationQuery() {
066
067        // do nothing
068    }
069
070    /**
071     * Gets the configuration string for the server-side validator.<p>
072     *
073     * @return a configuration string
074     */
075    public String getConfig() {
076
077        return m_config;
078    }
079
080    /**
081     * Gets the class name of the server-side validator.<p>
082     *
083     * @return  the class name of the server-side validator
084     */
085    public String getValidatorId() {
086
087        return m_validatorId;
088    }
089
090    /**
091     * Returns the value to validate.<p>
092     *
093     * @return the value which should be validated
094     */
095    public String getValue() {
096
097        return m_value;
098    }
099}