view gnv-artifacts/src/main/java/de/intevation/gnv/state/InputValue.java @ 805:bb7afd783321

Removed trailing whitespace. Added more javadoc. gnv-artifacts/trunk@887 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Thu, 08 Apr 2010 11:31:44 +0000
parents feae2f9d6c6f
children f953c9a559d8
line wrap: on
line source
package de.intevation.gnv.state;

import java.io.Serializable;

/**
 * This interface defines some basic methods to retrieve information about the
 * type of an user input.
 *
 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
 *
 */
public interface InputValue extends Serializable {

    /**
     * Retrieve the name of the inserted data.
     *
     * @return the input data name.
     */
    public String getName();

    /**
     * Retrieve the type of the input.
     *
     * @return the input data type.
     */
    public String getType();

    /**
     * Retrieve the default value used when no input is done.
     *
     * @return the input data default value.
     */
    public String getDefaultValue();

    /**
     * Retrieve information about mutliselect fields.
     *
     * @return true, if the input data is a multiselect, otherwise false.
     */
    public boolean isMultiselect();

    /**
     * Retrieve information about the occurance of this input in an sql
     * statement.
     *
     * @return the number of times, this data is used in a sql query.
     */
    public int usedInQueries();
}
// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org