tools/org.eclipse.persistence.tools.mapping/src/org/eclipse/persistence/tools/mapping/orm/ExternalFetchableMapping.java

/*******************************************************************************
 * Copyright (c) 2006, 2013 Oracle and/or its affiliates. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *     Oracle - initial API and implementation
 *
 ******************************************************************************/
package org.eclipse.persistence.tools.mapping.orm;

import javax.persistence.FetchType;
import org.eclipse.persistence.tools.utility.TextRange;

/**
 * This interface defines all of the behavior associated with all mappings that are fetchable {@link
 * FetchType}.
 * <p>
 * Provisional API: This interface is part of an interim API that is still under development and
 * expected to change significantly before reaching stability. It is available at this early stage
 * to solicit feedback from pioneering adopters on the understanding that any code that uses this
 * API will almost certainly be broken (repeatedly) as the API evolves.<p>
 *
 * @see http://jcp.org/aboutJava/communityprocess/final/jsr220/index.html,persistence specificaton
 *
 * @version 2.6
 */
@SuppressWarnings("nls")
public interface ExternalFetchableMapping extends ExternalNonTransientMapping {

	/**
	 * The attribute name used to store and retrieve the fetch property.
	 */
	String FETCH = "fetch";

	/**
	 * Indicates the {@link FetchType} of this mapping.
	 */
	FetchType getFetchType();

	/**
	 * Indicates the {@link TextRange} for the {@link FetchType} value.
	 */
	TextRange getFetchTypeTextRange();

	/**
	 * Sets the {@link FetchType} of this mapping.
	 */
	void setFetchType(FetchType type);
}