org.apache.olingo.client.api.uri.QueryOption Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of odata-v4-lib Show documentation
Repackaged OData V4 Olingo Library
There is a newer version: 3.4.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache 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://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.apache.olingo.client.api.uri;

/**
 * Query options.
 */
public enum QueryOption {

  /**
   * The entity-id specified by $id may be expressed absolute or relative to the request URL.
   */
  ID,
  /**
   * The $count system query option allows clients to request a count of the matching resources included with the
   * resources in the response. The $count query option has a Boolean value of true or false.
   */
  COUNT,
  /**
   * This option indicates entities associated with the EntityType instance or EntitySet, identified by the resource
   * path section of the URI, and MUST be represented inline in the data service's response.
   */
  EXPAND,
  /**
   * Cyclic navigation properties (whose target type is identical or can be cast to its source type) can be recursively
   * expanded using the special $levels option. The value of the $levels option is either a positive integer to
   * specify the number of levels to expand, or the literal string max to specify the maximum expansion level supported
   * by that service.
   */
  LEVELS,
  /**
   * This option specifies the media type acceptable in a response. If present, this value SHOULD take precedence over
   * value(s) specified in an Accept request header.
   */
  FORMAT,
  /**
   * This option is used to specify that a subset of the properties of the entities identified by the path of the
   * request URI and $expand query option SHOULD be returned in the response from the data service.
   */
  SELECT,
  /**
   * This option specifies the sort properties and sort direction (ascending or descending) that the data service MUST
   * use to order the entities in the EntitySet, identified by the resource path section of the URI.
   */
  ORDERBY,
  /**
   * This option specifies a positive integer N that is the maximum number of entities in the EntitySet, identified by
   * the resource path section of the URI, that the data service MUST return.
   */
  TOP,
  /**
   * This option specifies a positive integer N that represents the number of entities, counted from the first entity in
   * the EntitySet and ordered as specified by the $orderby option, that the data service should skip when returning the
   * entities in the EntitySet, which is identified by the resource path section of the URI. The data service SHOULD
   * return all subsequent entities, starting from the one in position N+1.
   */
  SKIP,
  /**
   * The value of a $skiptoken query option is an opaque token which identifies an index into the collection
   * of entities identified by the URI containing the $skiptoken parameter.
   */
  SKIPTOKEN,
  /**
   * This option specifies a predicate used to filter the elements from the EntitySet identified by the resource path
   * section of the URI.
   */
  FILTER,
  /**
   * Search expressions are used within the $search system query option to request entities matching the specified
   * expression.
   */
  SEARCH;

  @Override
  public String toString() {
    return name().toLowerCase();
  }
}