Subversion Repositories eFlore/Applications.cel

package org.tela_botanica.client.interfaces;

/**
 * Les classes qui implémentent cette interface fonctionnent sous forme de
 * filtres et doivent être capable de rendre compte de leur état (modifié ou
 * non) et de renvoyer les valeurs de filtrage
 * 
 * @author aurelien
 * 
 */
public interface Filtrable {

        /**
         * Renvoie un tableau contenant le nom du filtre et sa valeur
         * 
         * @return un tableau contenant le nom du filtre (exemple :
         *         "ci_meta_mots_cle") et sa valeur
         */
        public String[] renvoyerValeursAFiltrer();

        /**
         * Renvoie le nom du filtre de manière lisible (exemple : Filtre pour les
         * mots clés)
         * 
         * @return le nom du filtre
         */
        public String renvoyerNomFiltre();

        /**
         * Renvoie l'état du filtre (modifié ou non)
         * 
         * @return true si le filtre à été modifié depuis le dernier appel, false
         *         sinon
         */
        public boolean renvoyerEtatFiltre();

        /**
         * Rassemble les valeurs contenant dans le ou les champs du filtre, les
         * vérifie, et si celles-ci on changées, appelle le médiateur
         */
        public void valider();
        
        /**
         * Vide le filtre en cours
         */
        public void viderFiltre();

}