blob: 8fb813993dee020327698aa663a4ee343a37a909 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2011, 2019 Willink Transformations and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v20.html
*
* Contributors:
* E.D.Willink - initial API and implementation
*******************************************************************************/
package org.eclipse.qvtd.pivot.qvtbase;
import java.util.Map;
import org.eclipse.emf.common.util.DiagnosticChain;
import org.eclipse.ocl.pivot.NamedElement;
import org.eclipse.ocl.pivot.ReferringElement;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Domain</b></em>'.
* <!-- end-user-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.qvtd.pivot.qvtbase.Domain#isIsCheckable <em>Is Checkable</em>}</li>
* <li>{@link org.eclipse.qvtd.pivot.qvtbase.Domain#isIsEnforceable <em>Is Enforceable</em>}</li>
* <li>{@link org.eclipse.qvtd.pivot.qvtbase.Domain#getRule <em>Rule</em>}</li>
* <li>{@link org.eclipse.qvtd.pivot.qvtbase.Domain#getTypedModel <em>Typed Model</em>}</li>
* </ul>
*
* @see org.eclipse.qvtd.pivot.qvtbase.QVTbasePackage#getDomain()
* @model abstract="true"
* @generated
*/
public interface Domain extends NamedElement, ReferringElement {
/**
* Returns the value of the '<em><b>Is Checkable</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Is Checkable</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A checkable domain may be selected as the target of a transformation in check mode. An enforceable domain is always checkable. A not-checkable domain cannot be selected as the target of a transformation. See Bug 549776.See Bug 549776.
* <!-- end-model-doc -->
* @return the value of the '<em>Is Checkable</em>' attribute.
* @see #isSetIsCheckable()
* @see #unsetIsCheckable()
* @see #setIsCheckable(boolean)
* @see org.eclipse.qvtd.pivot.qvtbase.QVTbasePackage#getDomain_IsCheckable()
* @model unsettable="true" required="true"
* @generated
*/
boolean isIsCheckable();
/**
* Sets the value of the '{@link org.eclipse.qvtd.pivot.qvtbase.Domain#isIsCheckable <em>Is Checkable</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Is Checkable</em>' attribute.
* @see #isSetIsCheckable()
* @see #unsetIsCheckable()
* @see #isIsCheckable()
* @generated
*/
void setIsCheckable(boolean value);
/**
* Unsets the value of the '{@link org.eclipse.qvtd.pivot.qvtbase.Domain#isIsCheckable <em>Is Checkable</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetIsCheckable()
* @see #isIsCheckable()
* @see #setIsCheckable(boolean)
* @generated
*/
void unsetIsCheckable();
/**
* Returns whether the value of the '{@link org.eclipse.qvtd.pivot.qvtbase.Domain#isIsCheckable <em>Is Checkable</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Is Checkable</em>' attribute is set.
* @see #unsetIsCheckable()
* @see #isIsCheckable()
* @see #setIsCheckable(boolean)
* @generated
*/
boolean isSetIsCheckable();
/**
* Returns the value of the '<em><b>Is Enforceable</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Is Enforceable</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* An enforceable domain may be selected as the target of a transformation in check or enforce mode. An enforceable domain is always checkable. A not-checkable domain cannot be selected as the target of a transformation. See Bug 549776.
* <!-- end-model-doc -->
* @return the value of the '<em>Is Enforceable</em>' attribute.
* @see #isSetIsEnforceable()
* @see #unsetIsEnforceable()
* @see #setIsEnforceable(boolean)
* @see org.eclipse.qvtd.pivot.qvtbase.QVTbasePackage#getDomain_IsEnforceable()
* @model unsettable="true" required="true"
* @generated
*/
boolean isIsEnforceable();
/**
* Sets the value of the '{@link org.eclipse.qvtd.pivot.qvtbase.Domain#isIsEnforceable <em>Is Enforceable</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Is Enforceable</em>' attribute.
* @see #isSetIsEnforceable()
* @see #unsetIsEnforceable()
* @see #isIsEnforceable()
* @generated
*/
void setIsEnforceable(boolean value);
/**
* Unsets the value of the '{@link org.eclipse.qvtd.pivot.qvtbase.Domain#isIsEnforceable <em>Is Enforceable</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetIsEnforceable()
* @see #isIsEnforceable()
* @see #setIsEnforceable(boolean)
* @generated
*/
void unsetIsEnforceable();
/**
* Returns whether the value of the '{@link org.eclipse.qvtd.pivot.qvtbase.Domain#isIsEnforceable <em>Is Enforceable</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Is Enforceable</em>' attribute is set.
* @see #unsetIsEnforceable()
* @see #isIsEnforceable()
* @see #setIsEnforceable(boolean)
* @generated
*/
boolean isSetIsEnforceable();
/**
* Returns the value of the '<em><b>Rule</b></em>' container reference.
* It is bidirectional and its opposite is '{@link org.eclipse.qvtd.pivot.qvtbase.Rule#getDomain <em>Domain</em>}'.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Rule</em>' container reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Rule</em>' container reference.
* @see #setRule(Rule)
* @see org.eclipse.qvtd.pivot.qvtbase.QVTbasePackage#getDomain_Rule()
* @see org.eclipse.qvtd.pivot.qvtbase.Rule#getDomain
* @model opposite="domain" required="true"
* @generated
*/
Rule getRule();
/**
* Sets the value of the '{@link org.eclipse.qvtd.pivot.qvtbase.Domain#getRule <em>Rule</em>}' container reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Rule</em>' container reference.
* @see #getRule()
* @generated
*/
void setRule(Rule value);
/**
* Returns the value of the '<em><b>Typed Model</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Typed Model</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Typed Model</em>' reference.
* @see #setTypedModel(TypedModel)
* @see org.eclipse.qvtd.pivot.qvtbase.QVTbasePackage#getDomain_TypedModel()
* @model
* @generated
*/
TypedModel getTypedModel();
/**
* Sets the value of the '{@link org.eclipse.qvtd.pivot.qvtbase.Domain#getTypedModel <em>Typed Model</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Typed Model</em>' reference.
* @see #getTypedModel()
* @generated
*/
void setTypedModel(TypedModel value);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @model annotation="http://www.eclipse.org/uml2/2.0.0/UML originalName='NameIsTypedModelName'"
* annotation="http://www.eclipse.org/emf/2002/Ecore/OCL/Pivot body='\n\ttypedModel &lt;&gt; null implies name = typedModel.name\n\n'"
* @generated
*/
boolean validateNameIsTypedModelName(DiagnosticChain diagnostics, Map<Object, Object> context);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @model annotation="http://www.eclipse.org/uml2/2.0.0/UML originalName='TypedModelIsTransformationModelParameter'"
* annotation="http://www.eclipse.org/emf/2002/Ecore/OCL/Pivot body='\n\toclContainer().oclIsKindOf(Transformation) and typedModel &lt;&gt; null implies\n\toclContainer().oclAsType(Transformation).modelParameter-&gt;includes(typedModel)\n\n'"
* @generated
*/
boolean validateTypedModelIsTransformationModelParameter(DiagnosticChain diagnostics, Map<Object, Object> context);
/**
* Return true if this domain cannot be an output. i.e. it is not checkable and is not enforceable.
*/
boolean isNotOutput();
} // Domain