org.eclipse.ocl.expressions.Variable Maven / Gradle / Ivy

Go to download
/**
 * 
 * 
 * Copyright (c) 2006, 2008 IBM Corporation, Zeligsoft Inc., and others.
 * 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:
 *   IBM - Initial API and implementation
 *   Zeligsoft - Bug 207365
 * 
 * 
 *
 * $Id: Variable.java,v 1.8 2009/12/22 18:53:30 ewillink Exp $
 */
package org.eclipse.ocl.expressions;

import java.util.Map;
import org.eclipse.emf.common.util.DiagnosticChain;
import org.eclipse.ocl.utilities.TypedASTNode;
import org.eclipse.ocl.utilities.TypedElement;
import org.eclipse.ocl.utilities.Visitable;

/**
 * 
 * A representation of the model object 'Variable'.
 * 
 *
 * 
 * The following features are supported:
 * 

 *   {@link org.eclipse.ocl.expressions.Variable#getInitExpression Init Expression}
 *   {@link org.eclipse.ocl.expressions.Variable#getRepresentedParameter Represented Parameter}
 * 
 * 
 *
 * @see org.eclipse.ocl.expressions.ExpressionsPackage#getVariable()
 * @model
 * @generated
 */
public interface Variable
		extends TypedElement, Visitable, TypedASTNode {

	/**
	 * Returns the value of the 'Init Expression' containment reference.
	 * 
	 * 
	 * If the meaning of the 'Init Expression' containment reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Init Expression' containment reference.
	 * @see #setInitExpression(OCLExpression)
	 * @see org.eclipse.ocl.expressions.ExpressionsPackage#getVariable_InitExpression()
	 * @model containment="true"
	 * @generated
	 */
	OCLExpression getInitExpression();

	/**
	 * Sets the value of the '{@link org.eclipse.ocl.expressions.Variable#getInitExpression Init Expression}' containment reference.
	 * 
	 * 
	 * @param value the new value of the 'Init Expression' containment reference.
	 * @see #getInitExpression()
	 * @generated
	 */
	void setInitExpression(OCLExpression value);

	/**
	 * Returns the value of the 'Represented Parameter' reference.
	 * 
	 * 
	 * If the meaning of the 'Represented Parameter' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Represented Parameter' reference.
	 * @see #setRepresentedParameter(Object)
	 * @see org.eclipse.ocl.expressions.ExpressionsPackage#getVariable_RepresentedParameter()
	 * @model kind="reference"
	 * @generated
	 */
	PM getRepresentedParameter();

	/**
	 * Sets the value of the '{@link org.eclipse.ocl.expressions.Variable#getRepresentedParameter Represented Parameter}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Represented Parameter' reference.
	 * @see #getRepresentedParameter()
	 * @generated
	 */
	void setRepresentedParameter(PM value);

	/**
	 * 
	 * 
	 * 
	 * initExpression->notEmpty() implies initExpression.type.conformsTo (type)
	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
	 * @param context The cache of context-specific information.
	 * 
	 * @model
	 * @generated
	 */
	boolean checkInitType(DiagnosticChain diagnostics,
			Map context);

} // Variable