org.camunda.bpm.engine.management.TablePageQuery Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camunda-bpm-engine-api Show documentation

There is a newer version: 7.22.0

Show newest version

/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.camunda.bpm.engine.management;



/**
 * Allows programmatic querying of {@link TablePage}s.
 * 
 * @author Joram Barrez
 */
public interface TablePageQuery {
  
  /** 
   * The name of the table of which a page must be fetched. 
   */
  TablePageQuery tableName(String tableName);
  
  /**
   * Orders the resulting table page rows by the given column in ascending order. 
   */
  TablePageQuery orderAsc(String column);
  
  /**
   * Orders the resulting table page rows by the given column in descending order. 
   */
  TablePageQuery orderDesc(String column);
  
  /**
   * Executes the query and returns the {@link TablePage}. 
   */
  TablePage listPage(int firstResult, int maxResults);
}