ASelectQuery.java

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the License
 * at:
 *
 *   http://opensource.org/licenses/ecl2.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 */
package org.opencastproject.assetmanager.api.query;

/**
 * A select query for assets.
 *
 * @see AResult
 * @see ARecord
 */
public interface ASelectQuery {
  /**
   * Restrict the set of returned records by adding a predicate.
   * This method may be called multiple times combining predicates using logical AND.
   */

  ASelectQuery where(Predicate predicate);

  /**
   * Set paging information.
   */
  ASelectQuery page(int offset, int size);

  /**
   * Specify an order.
   */
  ASelectQuery orderBy(Order order);

  /**
   * Run the query and return the result.
   */
  AResult run();
}