View Javadoc
1   /*
2    * Licensed to The Apereo Foundation under one or more contributor license
3    * agreements. See the NOTICE file distributed with this work for additional
4    * information regarding copyright ownership.
5    *
6    *
7    * The Apereo Foundation licenses this file to you under the Educational
8    * Community License, Version 2.0 (the "License"); you may not use this file
9    * except in compliance with the License. You may obtain a copy of the License
10   * at:
11   *
12   *   http://opensource.org/licenses/ecl2.txt
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
17   * License for the specific language governing permissions and limitations under
18   * the License.
19   *
20   */
21  package org.opencastproject.assetmanager.api.query;
22  
23  /**
24   * A select query for assets.
25   *
26   * @see AResult
27   * @see ARecord
28   */
29  public interface ASelectQuery {
30    /**
31     * Restrict the set of returned records by adding a predicate.
32     * This method may be called multiple times combining predicates using logical AND.
33     */
34  
35    ASelectQuery where(Predicate predicate);
36  
37    /**
38     * Set paging information.
39     */
40    ASelectQuery page(int offset, int size);
41  
42    /**
43     * Specify an order.
44     */
45    ASelectQuery orderBy(Order order);
46  
47    /**
48     * Run the query and return the result.
49     */
50    AResult run();
51  }