/*******************************************************************************
 * Copyright 2013 SAP AG
 * 
 * Licensed 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 com.sap.core.odata.api.edm;

/**
 * @com.sap.core.odata.DoNotImplement
 * A CSDL NavigationProperty element
 * 
 * <p>EdmNavigationProperty allows navigation from one entity type to another via a relationship.
 * @author SAP AG
 */
public interface EdmNavigationProperty extends EdmTyped, EdmMappable {

  /**
   * Get the relationship of the navigation property
   * 
   * @return {@link EdmAssociation}
   * @throws EdmException
   */
  EdmAssociation getRelationship() throws EdmException;

  /**
   * Get the from role of the navigation property
   * 
   * @return from role as String
   * @throws EdmException
   */
  String getFromRole() throws EdmException;

  /**
   * Get the to role of the navigation property
   * 
   * @return to role as String
   * @throws EdmException
   */
  String getToRole() throws EdmException;
}