/*******************************************************************************
 * Copyright (c) 2011 Oracle. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0, which accompanies this distribution
 * and is available at http://www.eclipse.org/legal/epl-v10.html.
 * 
 * Contributors:
 *     Oracle - initial API and implementation
 ******************************************************************************/
package org.eclipse.jpt.jpa.eclipselink.core.v2_3.resource.java;

import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jpt.common.core.resource.java.Annotation;
import org.eclipse.jpt.common.core.utility.TextRange;

/**
 * Corresponds to the EclipseLink annotation
 * org.eclipse.persistence.annotations.Multitenant
 * 
 * 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.
 * 
 * @version 3.1
 * @since 3.1
 */
public interface EclipseLinkMultitenantAnnotation
	extends Annotation
{
	String ANNOTATION_NAME = EclipseLink2_3.MULTITENANT;

	/**
	 * Return whether the annotation exists in Java.
	 */
	boolean isSpecified();

	/**
	 * Corresponds to the 'value' element of the Multitenant annotation.
	 * Return null if the element does not exist in Java.
	 */
	MultitenantType getValue();
		String VALUE_PROPERTY = "value"; //$NON-NLS-1$

	/**
	 * Corresponds to the 'value' element of the Multitenant annotation.
	 * Set to null to remove the element.
	 */
	void setValue(MultitenantType value);

	/**
	 * Return the {@link TextRange} for the 'value' element. If the element 
	 * does not exist return the {@link TextRange} for the Multitenant annotation.
	 */
	TextRange getValueTextRange(CompilationUnit astRoot);


	//********* include criteria added in EclipseLink 2.4 **********
	/**
	 * Corresponds to the 'includeCriteria' element of the Multitenant annotation.
	 * Return null if the element does not exist in Java.
	 */
	Boolean getIncludeCriteria();
		String INCLUDE_CRITERIA_PROPERTY = "includeCriteria"; //$NON-NLS-1$

	/**
	 * Corresponds to the 'includeCriteria' element of the Multitenant annotation.
	 * Set to null to remove the element.
	 */
	void setIncludeCriteria(Boolean includeCriteria);

	/**
	 * Return the {@link TextRange} for the 'includeCriteria' element.
	 * If the element does not exist return the {@link TextRange}
	 * for the Multitenant annotation.
	 */
	TextRange getIncludeCriteriaTextRange(CompilationUnit astRoot);

}