org.eclipse.uml2.uml
Interface Constraint

All Superinterfaces:
Element, EModelElement, EObject, NamedElement, Notifier, PackageableElement, ParameterableElement
All Known Subinterfaces:
DurationConstraint, InteractionConstraint, IntervalConstraint, TimeConstraint

public interface Constraint
extends PackageableElement

A representation of the model object 'Constraint'. A constraint is a condition or restriction expressed in natural language text or in a machine readable language for the purpose of declaring some of the semantics of an element.

The following features are supported:

See Also:
UMLPackage.getConstraint()

Field Summary
 
Fields inherited from interface org.eclipse.uml2.uml.NamedElement
SEPARATOR
 
Method Summary
 ValueSpecification createSpecification(String name, Type type, EClass eClass)
          Creates a new ValueSpecification, with the specified 'Name', and 'Type', and sets the 'Specification' containment reference
 EList getConstrainedElements()
          Returns the value of the 'Constrained Element' reference list.
 Namespace getContext()
          Returns the value of the 'Context' container reference.
 ValueSpecification getSpecification()
          Returns the value of the 'Specification' containment reference
 void setContext(Namespace value)
          Sets the value of the 'Context' container reference
 void setSpecification(ValueSpecification value)
          Sets the value of the 'Specification' containment reference
 boolean validateBooleanValue(DiagnosticChain diagnostics, Map context)
           The value specification for a constraint must evaluate to a Boolean value.
 boolean validateNoSideEffects(DiagnosticChain diagnostics, Map context)
           Evaluating the value specification for a constraint must not have side effects.
 boolean validateNotAppliedToSelf(DiagnosticChain diagnostics, Map context)
           A constraint cannot be applied to itself.
 boolean validateNotApplyToSelf(DiagnosticChain diagnostics, Map context)
           A constraint cannot be applied to itself.
 boolean validateValueSpecificationBoolean(DiagnosticChain diagnostics, Map context)
           The value specification for a constraint must evaluate to a Boolean value.
 
Methods inherited from interface org.eclipse.uml2.uml.NamedElement
allNamespaces, allOwningPackages, createDependency, createNameExpression, getClientDependencies, getClientDependency, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, isSetName, isSetVisibility, separator, setName, setNameExpression, setVisibility, unsetName, unsetVisibility, validateHasNoQualifiedName, validateHasQualifiedName, validateVisibilityNeedsOwnership
 
Methods inherited from interface org.eclipse.uml2.uml.Element
addKeyword, allOwnedElements, applyStereotype, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedSubstereotype, getAppliedSubstereotypes, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwnedElements, getOwner, getRelationships, getRelationships, getRequiredStereotype, getRequiredStereotypes, getSourceDirectedRelationships, getSourceDirectedRelationships, getStereotypeApplication, getStereotypeApplications, getTargetDirectedRelationships, getTargetDirectedRelationships, getValue, hasKeyword, hasValue, isStereotypeApplicable, isStereotypeApplied, isStereotypeRequired, mustBeOwned, removeKeyword, setValue, unapplyStereotype, validateHasOwner, validateNotOwnSelf
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotation, getEAnnotations
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface org.eclipse.uml2.uml.ParameterableElement
getOwningTemplateParameter, getTemplateParameter, isCompatibleWith, isTemplateParameter, setOwningTemplateParameter, setTemplateParameter
 

Method Detail

getConstrainedElements

public EList getConstrainedElements()
Returns the value of the 'Constrained Element' reference list. The list contents are of type Element. The ordered set of Elements referenced by this Constraint.

Returns:
the value of the 'Constrained Element' reference list.
See Also:
UMLPackage.getConstraint_ConstrainedElement()

getSpecification

public ValueSpecification getSpecification()
Returns the value of the 'Specification' containment reference. A condition that must be true when evaluated in order for the constraint to be satisfied.

Returns:
the value of the 'Specification' containment reference.
See Also:
Constraint.setSpecification(ValueSpecification), UMLPackage.getConstraint_Specification()

setSpecification

public void setSpecification(ValueSpecification value)
Sets the value of the 'Specification' containment reference.

Parameters:
value - the new value of the 'Specification' containment reference.
See Also:
Constraint.getSpecification()

createSpecification

public ValueSpecification createSpecification(String name,
                                              Type type,
                                              EClass eClass)
Creates a new ValueSpecification, with the specified 'Name', and 'Type', and sets the 'Specification' containment reference.

Parameters:
name - The 'Name' for the new ValueSpecification, or null.
type - The 'Type' for the new ValueSpecification, or null.
eClass - The Ecore class of the ValueSpecification to create.
Returns:
The new ValueSpecification.
See Also:
Constraint.getSpecification()

getContext

public Namespace getContext()
Returns the value of the 'Context' container reference. It is bidirectional and its opposite is 'Owned Rule'. Specifies the namespace that owns the NamedElement.

Returns:
the value of the 'Context' container reference.
See Also:
Constraint.setContext(Namespace), UMLPackage.getConstraint_Context(), Namespace.getOwnedRules()

setContext

public void setContext(Namespace value)
Sets the value of the 'Context' container reference.

Parameters:
value - the new value of the 'Context' container reference.
See Also:
Constraint.getContext()

validateNotApplyToSelf

public boolean validateNotApplyToSelf(DiagnosticChain diagnostics,
                                      Map context)
A constraint cannot be applied to itself. not constrainedElement->includes(self)


validateValueSpecificationBoolean

public boolean validateValueSpecificationBoolean(DiagnosticChain diagnostics,
                                                 Map context)
The value specification for a constraint must evaluate to a Boolean value. self.specification().booleanValue().isOclKindOf(Boolean)


validateBooleanValue

public boolean validateBooleanValue(DiagnosticChain diagnostics,
                                    Map context)
The value specification for a constraint must evaluate to a Boolean value. true


validateNoSideEffects

public boolean validateNoSideEffects(DiagnosticChain diagnostics,
                                     Map context)
Evaluating the value specification for a constraint must not have side effects. true


validateNotAppliedToSelf

public boolean validateNotAppliedToSelf(DiagnosticChain diagnostics,
                                        Map context)
A constraint cannot be applied to itself. not constrainedElement->includes(self)


Copyright 2003, 2006 IBM Corporation and others.
All Rights Reserved.