odata2-lib/odata-api/src/main/java/org/apache/olingo/odata2/api/uri/NavigationSegment.java

/*******************************************************************************
 * 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.odata2.api.uri;

import java.util.List;

import org.apache.olingo.odata2.api.edm.EdmEntitySet;
import org.apache.olingo.odata2.api.edm.EdmNavigationProperty;

/**
 * Navigation segment, consisting of a navigation property, its target entity set,
 * and, optionally, a list of key predicates to determine a single entity out of
 * the target entity set.
 * @org.apache.olingo.odata2.DoNotImplement
 * 
 */
public interface NavigationSegment {

  /**
   * Gets the navigation property.
   * @return {@link EdmNavigationProperty} navigation property of this navigation segment
   */
  public EdmNavigationProperty getNavigationProperty();

  /**
   * Gets the target entity set.
   * @return {@link EdmEntitySet} entity set of this navigation segment
   */
  public EdmEntitySet getEntitySet();

  /**
   * Gets the key predicate for the target entity set.
   * @return List of {@link KeyPredicate}: key predicate of this navigation segment
   */
  public List<KeyPredicate> getKeyPredicates();

}