001 package org.apache.fulcrum.intake.validator;
002
003 /*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements. See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership. The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License. You may obtain a copy of the License at
011 *
012 * http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied. See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022 /**
023 * A constraint has a name and a value and an optional message.
024 * The name/value pair will have meaning to a Validator and the
025 * message will serve as an error message in the event the Validator
026 * determines the constraint is violated.
027 * example:
028 * name="maxLength"
029 * value="255"
030 * message="Value cannot be longer than 255 characters."
031 *
032 * @author <a href="mailto:jmcnally@collab.net">John McNally</a>
033 * @version $Id: Constraint.java 535465 2007-05-05 06:58:06Z tv $
034 */
035 public interface Constraint
036 {
037 /**
038 * Get the name of the constraint.
039 */
040 String getName();
041
042 /**
043 * Get the value of the constraint.
044 */
045 String getValue();
046
047 /**
048 * Get the error message.
049 */
050 String getMessage();
051 }