View Javadoc

1   /*
2    * ModeShape (http://www.modeshape.org)
3    * See the COPYRIGHT.txt file distributed with this work for information
4    * regarding copyright ownership.  Some portions may be licensed
5    * to Red Hat, Inc. under one or more contributor license agreements.
6    * See the AUTHORS.txt file in the distribution for a full listing of 
7    * individual contributors.
8    *
9    * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10   * is licensed to you under the terms of the GNU Lesser General Public License as
11   * published by the Free Software Foundation; either version 2.1 of
12   * the License, or (at your option) any later version.
13   * 
14   * ModeShape is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17   * Lesser General Public License for more details.
18   *
19   * You should have received a copy of the GNU Lesser General Public
20   * License along with this software; if not, write to the Free
21   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23   */
24  package org.modeshape.jcr.api.query.qom;
25  
26  import java.util.Collection;
27  import javax.jcr.query.qom.Constraint;
28  import javax.jcr.query.qom.DynamicOperand;
29  import javax.jcr.query.qom.StaticOperand;
30  
31  /**
32   * A constraint that evaluates to true when the value defined by the dynamic operand evaluates to be within the set of values
33   * specified by the collection of values.
34   */
35  public interface SetCriteria extends Constraint {
36  
37      /**
38       * Get the dynamic operand specification for the left-hand side of the set criteria.
39       * 
40       * @return the dynamic operand; never null
41       */
42      public DynamicOperand getOperand();
43  
44      /**
45       * Get the static operands for this set criteria.
46       * 
47       * @return the static operand; never null and never empty
48       */
49      public Collection<? extends StaticOperand> getValues();
50  }