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