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    import java.util.Map;
023    
024    /**
025     * This interface marks a bean/class that can have its properties set
026     * by values in a Map.
027     *
028     * @author <a href="mailto:jmcnally@collab.net">John McNally</a>
029     * @version $Id: InitableByConstraintMap.java 535465 2007-05-05 06:58:06Z tv $
030     */
031    public interface InitableByConstraintMap
032    {
033        /**
034         * Extract the relevant parameters from the constraints listed
035         * in <input-param> tags within the intake.xml file.
036         *
037         * @param inputParameters a <code>Map</code> of <code>Constraint</code>'s
038         * containing rules and error messages.
039         * @exception InvalidMaskException one of the mask rules is invalid
040         */
041        void init(Map inputParameters)
042                throws InvalidMaskException;
043    }