Dépôt officiel du code source de l'ERP OpenConcerto

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 2011 OpenConcerto, by ILM Informatique. All rights reserved.
 * 
 * The contents of this file are subject to the terms of the GNU General Public License Version 3
 * only ("GPL"). You may not use this file except in compliance with the License. You can obtain a
 * copy of the License at http://www.gnu.org/licenses/gpl-3.0.html See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each file.
 */
 
 package org.openconcerto.sql.ui.light;

import org.openconcerto.sql.model.FieldPath;
import org.openconcerto.sql.model.SQLRowValues;
import org.openconcerto.sql.model.SQLSelect;
import org.openconcerto.sql.model.Where;
import org.openconcerto.ui.light.TableSearchParameterType;

import java.util.List;

public interface TableSearchMatcher {

    /**
     * Where to add to prefilter the result
     */
    public Where getWhere(SQLSelect sel, TableSearchParameterType type, String txt);

    /**
     * Fields to fetch for this matcher. The fields will be accessed in the match method, from the
     * SQLRowValues
     * 
     * @return the fields paths
     * @return null or emtpy List is nothing to fetch
     */
    public List<FieldPath> getAdditionnalFieldsToFetch();

    /**
     * @return true is the match method must be used
     */
    public boolean useMatch();

    /**
     * Match the SQLRowValues retrieve from the database (filtered by the Where from getWhere) using
     * the type and the user text
     */
    public boolean match(SQLRowValues r, TableSearchParameterType type, String txt);

}