ReferenceMapping.java

/*
 * Copyright 2012 Jakob Külzer
 * 
 * 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 org.om.core.api.mapping.field;

import org.om.core.api.annotation.Entity;
import org.om.core.api.annotation.LookupMode;

/**
 * A ReferenceMapping is a mapping that describes a one-to-one relationship
 * between two {@link Entity}s.
 * 
 * @author Jakob Külzer
 * 
 */
public interface ReferenceMapping extends Mapping {

	LookupMode getLookupMode();

	/**
	 * Returns the path relative to the initial node that hosts the referenced
	 * entity.
	 * 
	 * @return
	 */
	String getPath();

}