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.xml.types;
029
030import org.opencms.i18n.CmsMessageContainer;
031import org.opencms.xml.content.CmsDefaultXmlContentHandler;
032
033/**
034 * Interface to provide specific error messages on validation</p>
035 * Should be used as an extension of {@link I_CmsXmlSchemaType}.
036 * The {@link CmsDefaultXmlContentHandler} checks for that interface when it validates values.
037 */
038public interface I_CmsXmlValidateWithMessage {
039
040    /**
041     * Checks if a given value is valid according validation rules of this schema type in the XML schema.<p>
042     *
043     * In contrast to {@link I_CmsXmlSchemaType#validateValue(String)} a specific error message is returned
044     * in the case of validation errors.<p>
045     *
046     * @param value the value to validate
047     *
048     * @return <code>null</code> if the value is valid, a localized error message otherwise.
049     */
050    CmsMessageContainer validateWithMessage(String value);
051}