001/*
002 * (C) Copyright 2010 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 *     Anahide Tchertchian
018 */
019
020package org.nuxeo.ecm.platform.query.api;
021
022import org.nuxeo.ecm.core.search.api.client.querymodel.Escaper;
023
024public interface WhereClauseDefinition {
025
026    String getDocType();
027
028    void setFixedPath(String fixedPart);
029
030    boolean getQuoteFixedPartParameters();
031
032    boolean getEscapeFixedPartParameters();
033
034    PredicateDefinition[] getPredicates();
035
036    void setPredicates(PredicateDefinition[] predicates);
037
038    String getFixedPart();
039
040    void setFixedPart(String fixedPart);
041
042    Class<? extends Escaper> getEscaperClass();
043
044    /**
045     * Return the custom select statement used by the fixed part ("select * from Document" for NXQL queries, for
046     * instance).
047     *
048     * @since 5.9.2
049     */
050    String getSelectStatement();
051
052}