001/*
002 * (C) Copyright 2006-2008 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.ecm.webengine.forms.validation;
020
021import java.util.Collection;
022import java.util.Map;
023
024import org.nuxeo.ecm.webengine.forms.FormDataProvider;
025
026/**
027 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
028 */
029public interface Form {
030    // TODO remove it?
031    Collection<String> unknownKeys();
032
033    /**
034     * Before using the form, implementors must ensure this method is called to initialize form data, otherwise NPE will
035     * be thrown. This method must never be called by clients. It is internal to validation implementation and should be
036     * called only by implementors when creating a form.
037     *
038     * @param data the form data source
039     * @param proxy the proxy to the user form
040     * @throws ValidationException
041     */
042    void load(FormDataProvider data, Form proxy) throws ValidationException;
043
044    /**
045     * Get the form fields as submitted by the client. The fields are present even if the form is not valid
046     *
047     * @return the form fields or an empty map if none
048     */
049    Map<String, String[]> fields();
050
051}