001/*
002 * (C) Copyright 2010 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Anahide Tchertchian
016 */
017
018package org.nuxeo.ecm.platform.query.api;
019
020import org.nuxeo.ecm.core.search.api.client.querymodel.Escaper;
021
022public interface WhereClauseDefinition {
023
024    String getDocType();
025
026    void setFixedPath(String fixedPart);
027
028    boolean getQuoteFixedPartParameters();
029
030    boolean getEscapeFixedPartParameters();
031
032    PredicateDefinition[] getPredicates();
033
034    void setPredicates(PredicateDefinition[] predicates);
035
036    String getFixedPart();
037
038    void setFixedPart(String fixedPart);
039
040    Class<? extends Escaper> getEscaperClass();
041
042    /**
043     * Return the custom select statement used by the fixed part ("select * from Document" for NXQL queries, for
044     * instance).
045     *
046     * @since 5.9.2
047     */
048    String getSelectStatement();
049
050}