001/*
002 * (C) Copyright 2010 Nuxeo SAS (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 *     Nuxeo - initial API and implementation
016 */
017
018package org.nuxeo.ecm.platform.query.api;
019
020import org.nuxeo.common.xmap.annotation.XNode;
021
022public interface PredicateDefinition {
023
024    String ATOMIC_PREDICATE = "atomic";
025
026    String SUB_CLAUSE_PREDICATE = "subClause";
027
028    @XNode("@operator")
029    void setOperator(String operator);
030
031    String getOperator();
032
033    String getParameter();
034
035    void setParameter(String parameter);
036
037    PredicateFieldDefinition[] getValues();
038
039    void setValues(PredicateFieldDefinition[] values);
040
041    String getType();
042
043    String getOperatorField();
044
045    String getOperatorSchema();
046
047    /**
048     * @since 7.3
049     */
050    String getHint();
051
052    /**
053     * @since 7.3
054     */
055    void setHint(String hint);
056
057    /**
058     * @since 5.6
059     */
060    PredicateDefinition clone();
061
062}