org.apache.olingo.ext.proxy.api.StructuredCollectionQuery Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of odata-client-proxy Show documentation

Java client API for OData services: Proxy.

There is a newer version: 5.0.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.ext.proxy.api;

import org.apache.olingo.client.api.uri.URIFilter;

public interface StructuredCollectionQuery>
        extends StructuredQuery, CollectionQuery {

  /**
   * Sets the $filter expression.
   * 

   * Any of available operators and functions can be embodied here.
   *
   * @param filter the $filter expression.
   * @return the same query instance.
   */
  CT filter(String filter);

  /**
   * Sets the filter generating the $filter expression.
   *
   * @param filter filter instance (to be obtained via factory): note that build() method will be immediately
   * invoked.
   * @return the same query instance.
   */
  CT filter(URIFilter filter);

  /**
   * Sets the $orderBy expression.
   *
   * @param sort sort options.
   * @return the same query instance.
   */
  CT orderBy(Sort... sort);

  /**
   * Sets the $orderBy expression.
   *
   * @param orderBy the $orderBy expression.
   * @return the same query instance.
   */
  CT orderBy(String orderBy);
}