Package com.sodius.mdw.metamodel.uml21
Interface Interface
-
- All Superinterfaces:
Classifier
,Comparable<Object>
,Element
,org.eclipse.emf.ecore.EModelElement
,org.eclipse.emf.ecore.EObject
,MDWEObject
,MDWObject
,NamedElement
,Namespace
,org.eclipse.emf.common.notify.Notifier
,PackageableElement
,ParameterableElement
,RedefinableElement
,TemplateableElement
,Type
public interface Interface extends Classifier
A representation of the model object 'Interface'. An interface is a kind of classifier that represents a declaration of a set of coherent public features and obligations. An interface specifies a contract; any instance of a classifier that realizes the interface must fulfill that contract. The obligations that may be associated with an interface are in the form of various kinds of constraints (such as pre- and post-conditions) or protocol specifications, which may impose ordering restrictions on interactions through the interface. Interfaces may include receptions (in addition to operations). Since an interface specifies conformance characteristics, it does not own detailed behavior specifications. Instead, interfaces may own a protocol state machine that specifies event sequences and pre/post conditions for the operations and receptions described by the interface.The following features are supported:
- See Also:
UMLPackage.getInterface()
-
-
Field Summary
-
Fields inherited from interface com.sodius.mdw.metamodel.uml21.NamedElement
SEPARATOR
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Classifier
createNestedClassifier(String name, org.eclipse.emf.ecore.EClass eClass)
Creates a newClassifier
, with the specified 'Name', and appends it to the ' Nested Classifier' containment reference list.Property
createOwnedAttribute(String name, Type type)
Creates a newProperty
, with the specified 'Name', and 'Type', and appends it to the 'Owned Attribute' containment reference list.Property
createOwnedAttribute(String name, Type type, int lower, int upper)
Creates a property with the specified name, type, lower bound, and upper bound as an owned attribute of this interface.Property
createOwnedAttribute(String name, Type type, org.eclipse.emf.ecore.EClass eClass)
Creates a newProperty
, with the specified 'Name', and 'Type', and appends it to the 'Owned Attribute' containment reference list.Operation
createOwnedOperation(String name, MDWEList<String> ownedParameterNames, MDWEList<? extends Type> ownedParameterTypes)
Creates a newOperation
, with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types', and appends it to the 'Owned Operation' containment reference list.Operation
createOwnedOperation(String name, MDWEList<String> parameterNames, MDWEList<? extends Type> parameterTypes, Type returnType)
Creates an operation with the specified name, parameter names, parameter types, and return type (or null) as an owned operation of this interface.Reception
createOwnedReception(String name, MDWEList<String> ownedParameterNames, MDWEList<? extends Type> ownedParameterTypes)
Creates a newReception
, with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types', and appends it to the 'Owned Reception' containment reference list.ProtocolStateMachine
createProtocol(String name)
Creates a newProtocolStateMachine
,with the specified 'Name', and sets the ' Protocol' containment reference.Classifier
getNestedClassifier(String name)
Retrieves the firstClassifier
with the specified 'Name' from the ' Nested Classifier' containment reference list.Classifier
getNestedClassifier(String name, boolean ignoreCase, org.eclipse.emf.ecore.EClass eClass, boolean createOnDemand)
Retrieves the firstClassifier
with the specified 'Name' from the ' Nested Classifier' containment reference list.MDWEList<Classifier>
getNestedClassifiers()
Returns the value of the 'Nested Classifier' containment reference list.Property
getOwnedAttribute(String name, Type type)
Retrieves the firstProperty
with the specified 'Name', and 'Type' from the 'Owned Attribute' containment reference list.Property
getOwnedAttribute(String name, Type type, boolean ignoreCase, org.eclipse.emf.ecore.EClass eClass, boolean createOnDemand)
Retrieves the firstProperty
with the specified 'Name', and 'Type' from the 'Owned Attribute' containment reference list.MDWEList<Property>
getOwnedAttributes()
Returns the value of the 'Owned Attribute' containment reference list.Operation
getOwnedOperation(String name, MDWEList<String> ownedParameterNames, MDWEList<? extends Type> ownedParameterTypes)
Retrieves the firstOperation
with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types' from the 'Owned Operation' containment reference list.Operation
getOwnedOperation(String name, MDWEList<String> ownedParameterNames, MDWEList<? extends Type> ownedParameterTypes, boolean ignoreCase, boolean createOnDemand)
Retrieves the firstOperation
with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types' from the 'Owned Operation' containment reference list.MDWEList<Operation>
getOwnedOperations()
Returns the value of the 'Owned Operation' containment reference list.Reception
getOwnedReception(String name, MDWEList<String> ownedParameterNames, MDWEList<? extends Type> ownedParameterTypes)
Retrieves the firstReception
with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types' from the 'Owned Reception' containment reference list.Reception
getOwnedReception(String name, MDWEList<String> ownedParameterNames, MDWEList<? extends Type> ownedParameterTypes, boolean ignoreCase, boolean createOnDemand)
Retrieves the firstReception
with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types' from the 'Owned Reception' containment reference list.MDWEList<Reception>
getOwnedReceptions()
Returns the value of the 'Owned Reception' containment reference list.ProtocolStateMachine
getProtocol()
Returns the value of the 'Protocol' containment reference.Interface
getRedefinedInterface(String name)
Retrieves the firstInterface
with the specified 'Name' from the ' Redefined Interface' reference list.Interface
getRedefinedInterface(String name, boolean ignoreCase)
Retrieves the firstInterface
with the specified 'Name' from the ' Redefined Interface' reference list.MDWEList<Interface>
getRedefinedInterfaces()
Returns the value of the 'Redefined Interface' reference list.void
setProtocol(ProtocolStateMachine value)
Sets the value of the 'Protocol
' containment reference.boolean
validateVisibility(org.eclipse.emf.common.util.DiagnosticChain diagnostics, Map context)
The visibility of all features owned by an interface must be public.-
Methods inherited from interface com.sodius.mdw.metamodel.uml21.Classifier
allFeatures, allParents, conformsTo, createCollaborationUse, createGeneralization, createOwnedUseCase, createRepresentation, createSubstitution, getAllAttributes, getAllOperations, getAllUsedInterfaces, getAttribute, getAttribute, getAttributes, getCollaborationUse, getCollaborationUse, getCollaborationUses, getFeature, getFeature, getFeatures, getGeneral, getGeneral, getGeneralization, getGeneralization, getGeneralizations, getGenerals, getInheritedMember, getInheritedMember, getInheritedMembers, getOperation, getOperation, getOperations, getOwnedUseCase, getOwnedUseCase, getOwnedUseCases, getPowertypeExtent, getPowertypeExtent, getPowertypeExtents, getRedefinedClassifier, getRedefinedClassifier, getRedefinedClassifiers, getRepresentation, getSubstitution, getSubstitution, getSubstitutions, getUseCase, getUseCase, getUseCases, getUsedInterfaces, hasVisibilityOf, inherit, inheritableMembers, isAbstract, isFinalSpecialization, maySpecializeType, parents, setIsAbstract, setIsFinalSpecialization, setRepresentation, validateGeneralizationHierarchies, validateMapsToGeneralizationSet, validateNoCyclesInGeneralization, validateSpecializeType
-
Methods inherited from interface com.sodius.mdw.metamodel.uml21.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, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
-
Methods inherited from interface com.sodius.mdw.core.model.MDWObject
compareTo, eExtendedClass, eIsInstanceOf, eIsInstanceOf, eIsProfiled, eIsRemoved, eMetamodel, eMetaTypeName, eModel, eRemove, eSetUniqueID, eUniqueID, superScript, superScript, toBoolean, toBoolean, toByte, toByte, toChar, toChar, toDouble, toDouble, toFloat, toFloat, toInt, toInt, toList, toList, toList, toList, toList, toLong, toLong, toObject, toObject, toSet, toSet, toShort, toShort, toString, toString
-
Methods inherited from interface com.sodius.mdw.metamodel.uml21.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 com.sodius.mdw.metamodel.uml21.Namespace
createElementImport, createElementImport, createOwnedDiagram, createOwnedRule, createOwnedRule, createPackageImport, createPackageImport, excludeCollisions, getElementImport, getElementImport, getElementImports, getImportedElements, getImportedMember, getImportedMember, getImportedMembers, getImportedPackages, getMember, getMember, getMembers, getNamesOfMember, getOwnedDiagrams, getOwnedDiagrams, getOwnedMember, getOwnedMember, getOwnedMembers, getOwnedRule, getOwnedRule, getOwnedRules, getPackageImport, getPackageImport, getPackageImports, importMembers, membersAreDistinguishable, validateMembersDistinguishable
-
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
-
Methods inherited from interface com.sodius.mdw.metamodel.uml21.ParameterableElement
getOwningTemplateParameter, getTemplateParameter, isCompatibleWith, isTemplateParameter, setOwningTemplateParameter, setTemplateParameter
-
Methods inherited from interface com.sodius.mdw.metamodel.uml21.RedefinableElement
getRedefinedElement, getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid
-
Methods inherited from interface com.sodius.mdw.metamodel.uml21.TemplateableElement
createOwnedTemplateSignature, createOwnedTemplateSignature, createTemplateBinding, getOwnedTemplateSignature, getTemplateBinding, getTemplateBinding, getTemplateBindings, isTemplate, parameterableElements, setOwnedTemplateSignature
-
Methods inherited from interface com.sodius.mdw.metamodel.uml21.Type
conformsTo, createAssociation, getAssociations, getPackage, setPackage
-
-
-
-
Method Detail
-
getOwnedAttributes
MDWEList<Property> getOwnedAttributes()
Returns the value of the 'Owned Attribute' containment reference list. The list contents are of typeProperty
. The attributes (i.e. the properties) owned by the class.- Returns:
- the value of the 'Owned Attribute' containment reference list.
- See Also:
UMLPackage.getInterface_OwnedAttribute()
-
createOwnedAttribute
Property createOwnedAttribute(String name, Type type, org.eclipse.emf.ecore.EClass eClass)
Creates a newProperty
, with the specified 'Name', and 'Type', and appends it to the 'Owned Attribute' containment reference list.- Parameters:
name
- The 'Name' for the newProperty
, ornull
.type
- The 'Type' for the newProperty
, ornull
.eClass
- The Ecore class of theProperty
to create.- Returns:
- The new
Property
. - See Also:
getOwnedAttributes()
-
createOwnedAttribute
Property createOwnedAttribute(String name, Type type)
Creates a newProperty
, with the specified 'Name', and 'Type', and appends it to the 'Owned Attribute' containment reference list.- Parameters:
name
- The 'Name' for the newProperty
, ornull
.type
- The 'Type' for the newProperty
, ornull
.- Returns:
- The new
Property
. - See Also:
getOwnedAttributes()
-
getOwnedAttribute
Property getOwnedAttribute(String name, Type type)
Retrieves the firstProperty
with the specified 'Name', and 'Type' from the 'Owned Attribute' containment reference list.- Parameters:
name
- The 'Name' of theProperty
to retrieve, ornull
.type
- The 'Type' of theProperty
to retrieve, ornull
.- Returns:
- The first
Property
with the specified 'Name', and 'Type', ornull
. - See Also:
getOwnedAttributes()
-
getOwnedAttribute
Property getOwnedAttribute(String name, Type type, boolean ignoreCase, org.eclipse.emf.ecore.EClass eClass, boolean createOnDemand)
Retrieves the firstProperty
with the specified 'Name', and 'Type' from the 'Owned Attribute' containment reference list.- Parameters:
name
- The 'Name' of theProperty
to retrieve, ornull
.type
- The 'Type' of theProperty
to retrieve, ornull
.ignoreCase
- Whether to ignore case inString
comparisons.eClass
- The Ecore class of theProperty
to retrieve, ornull
.createOnDemand
- Whether to create aProperty
on demand if not found.- Returns:
- The first
Property
with the specified 'Name', and 'Type', ornull
. - See Also:
getOwnedAttributes()
-
getNestedClassifiers
MDWEList<Classifier> getNestedClassifiers()
Returns the value of the 'Nested Classifier' containment reference list. The list contents are of typeClassifier
. References all the Classifiers that are defined (nested) within the Class.- Returns:
- the value of the 'Nested Classifier' containment reference list.
- See Also:
UMLPackage.getInterface_NestedClassifier()
-
createNestedClassifier
Classifier createNestedClassifier(String name, org.eclipse.emf.ecore.EClass eClass)
Creates a newClassifier
, with the specified 'Name', and appends it to the ' Nested Classifier' containment reference list.- Parameters:
name
- The 'Name' for the newClassifier
, ornull
.eClass
- The Ecore class of theClassifier
to create.- Returns:
- The new
Classifier
. - See Also:
getNestedClassifiers()
-
getNestedClassifier
Classifier getNestedClassifier(String name)
Retrieves the firstClassifier
with the specified 'Name' from the ' Nested Classifier' containment reference list.- Parameters:
name
- The 'Name' of theClassifier
to retrieve, ornull
.- Returns:
- The first
Classifier
with the specified 'Name', ornull
. - See Also:
getNestedClassifiers()
-
getNestedClassifier
Classifier getNestedClassifier(String name, boolean ignoreCase, org.eclipse.emf.ecore.EClass eClass, boolean createOnDemand)
Retrieves the firstClassifier
with the specified 'Name' from the ' Nested Classifier' containment reference list.- Parameters:
name
- The 'Name' of theClassifier
to retrieve, ornull
.ignoreCase
- Whether to ignore case inString
comparisons.eClass
- The Ecore class of theClassifier
to retrieve, ornull
.createOnDemand
- Whether to create aClassifier
on demand if not found.- Returns:
- The first
Classifier
with the specified 'Name', ornull
. - See Also:
getNestedClassifiers()
-
getRedefinedInterfaces
MDWEList<Interface> getRedefinedInterfaces()
Returns the value of the 'Redefined Interface' reference list. The list contents are of typeInterface
. References all the Interfaces redefined by this Interface.- Returns:
- the value of the 'Redefined Interface' reference list.
- See Also:
UMLPackage.getInterface_RedefinedInterface()
-
getRedefinedInterface
Interface getRedefinedInterface(String name)
Retrieves the firstInterface
with the specified 'Name' from the ' Redefined Interface' reference list.- Parameters:
name
- The 'Name' of theInterface
to retrieve, ornull
.- Returns:
- The first
Interface
with the specified 'Name', ornull
. - See Also:
getRedefinedInterfaces()
-
getRedefinedInterface
Interface getRedefinedInterface(String name, boolean ignoreCase)
Retrieves the firstInterface
with the specified 'Name' from the ' Redefined Interface' reference list.- Parameters:
name
- The 'Name' of theInterface
to retrieve, ornull
.ignoreCase
- Whether to ignore case inString
comparisons.- Returns:
- The first
Interface
with the specified 'Name', ornull
. - See Also:
getRedefinedInterfaces()
-
getOwnedReceptions
MDWEList<Reception> getOwnedReceptions()
Returns the value of the 'Owned Reception' containment reference list. The list contents are of typeReception
. Receptions that objects providing this interface are willing to accept.- Returns:
- the value of the 'Owned Reception' containment reference list.
- See Also:
UMLPackage.getInterface_OwnedReception()
-
createOwnedReception
Reception createOwnedReception(String name, MDWEList<String> ownedParameterNames, MDWEList<? extends Type> ownedParameterTypes)
Creates a newReception
, with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types', and appends it to the 'Owned Reception' containment reference list.- Parameters:
name
- The 'Name' for the newReception
, ornull
.ownedParameterNames
- The 'Owned Parameter Names' for the newReception
, ornull
.ownedParameterTypes
- The 'Owned Parameter Types' for the newReception
, ornull
.- Returns:
- The new
Reception
. - See Also:
getOwnedReceptions()
-
getOwnedReception
Reception getOwnedReception(String name, MDWEList<String> ownedParameterNames, MDWEList<? extends Type> ownedParameterTypes)
Retrieves the firstReception
with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types' from the 'Owned Reception' containment reference list.- Parameters:
name
- The 'Name' of theReception
to retrieve, ornull
.ownedParameterNames
- The 'Owned Parameter Names' of theReception
to retrieve, ornull
.ownedParameterTypes
- The 'Owned Parameter Types' of theReception
to retrieve, ornull
.- Returns:
- The first
Reception
with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types', ornull
. - See Also:
getOwnedReceptions()
-
getOwnedReception
Reception getOwnedReception(String name, MDWEList<String> ownedParameterNames, MDWEList<? extends Type> ownedParameterTypes, boolean ignoreCase, boolean createOnDemand)
Retrieves the firstReception
with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types' from the 'Owned Reception' containment reference list.- Parameters:
name
- The 'Name' of theReception
to retrieve, ornull
.ownedParameterNames
- The 'Owned Parameter Names' of theReception
to retrieve, ornull
.ownedParameterTypes
- The 'Owned Parameter Types' of theReception
to retrieve, ornull
.ignoreCase
- Whether to ignore case inString
comparisons.createOnDemand
- Whether to create aReception
on demand if not found.- Returns:
- The first
Reception
with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types', ornull
. - See Also:
getOwnedReceptions()
-
getProtocol
ProtocolStateMachine getProtocol()
Returns the value of the 'Protocol' containment reference. References a protocol state machine specifying the legal sequences of the invocation of the behavioral features described in the interface.- Returns:
- the value of the 'Protocol' containment reference.
- See Also:
setProtocol(ProtocolStateMachine)
,UMLPackage.getInterface_Protocol()
-
setProtocol
void setProtocol(ProtocolStateMachine value)
Sets the value of the 'Protocol
' containment reference.- Parameters:
value
- the new value of the 'Protocol' containment reference.- See Also:
getProtocol()
-
createProtocol
ProtocolStateMachine createProtocol(String name)
Creates a newProtocolStateMachine
,with the specified 'Name', and sets the ' Protocol' containment reference.- Parameters:
name
- The 'Name' for the newProtocolStateMachine
, ornull
.- Returns:
- The new
ProtocolStateMachine
. - See Also:
getProtocol()
-
getOwnedOperations
MDWEList<Operation> getOwnedOperations()
Returns the value of the 'Owned Operation' containment reference list. The list contents are of typeOperation
. It is bidirectional and its opposite is 'Interface
'. The operations owned by the class.- Returns:
- the value of the 'Owned Operation' containment reference list.
- See Also:
UMLPackage.getInterface_OwnedOperation()
,Operation.getInterface()
-
createOwnedOperation
Operation createOwnedOperation(String name, MDWEList<String> ownedParameterNames, MDWEList<? extends Type> ownedParameterTypes)
Creates a newOperation
, with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types', and appends it to the 'Owned Operation' containment reference list.- Parameters:
name
- The 'Name' for the newOperation
, ornull
.ownedParameterNames
- The 'Owned Parameter Names' for the newOperation
, ornull
.ownedParameterTypes
- The 'Owned Parameter Types' for the newOperation
, ornull
.- Returns:
- The new
Operation
. - See Also:
getOwnedOperations()
-
getOwnedOperation
Operation getOwnedOperation(String name, MDWEList<String> ownedParameterNames, MDWEList<? extends Type> ownedParameterTypes)
Retrieves the firstOperation
with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types' from the 'Owned Operation' containment reference list.- Parameters:
name
- The 'Name' of theOperation
to retrieve, ornull
.ownedParameterNames
- The 'Owned Parameter Names' of theOperation
to retrieve, ornull
.ownedParameterTypes
- The 'Owned Parameter Types' of theOperation
to retrieve, ornull
.- Returns:
- The first
Operation
with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types', ornull
. - See Also:
getOwnedOperations()
-
getOwnedOperation
Operation getOwnedOperation(String name, MDWEList<String> ownedParameterNames, MDWEList<? extends Type> ownedParameterTypes, boolean ignoreCase, boolean createOnDemand)
Retrieves the firstOperation
with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types' from the 'Owned Operation' containment reference list.- Parameters:
name
- The 'Name' of theOperation
to retrieve, ornull
.ownedParameterNames
- The 'Owned Parameter Names' of theOperation
to retrieve, ornull
.ownedParameterTypes
- The 'Owned Parameter Types' of theOperation
to retrieve, ornull
.ignoreCase
- Whether to ignore case inString
comparisons.createOnDemand
- Whether to create aOperation
on demand if not found.- Returns:
- The first
Operation
with the specified 'Name', ' Owned Parameter Names', and 'Owned Parameter Types', ornull
. - See Also:
getOwnedOperations()
-
validateVisibility
boolean validateVisibility(org.eclipse.emf.common.util.DiagnosticChain diagnostics, Map context)
The visibility of all features owned by an interface must be public. self.feature->forAll(f | f.visibility = #public)
-
createOwnedOperation
Operation createOwnedOperation(String name, MDWEList<String> parameterNames, MDWEList<? extends Type> parameterTypes, Type returnType)
Creates an operation with the specified name, parameter names, parameter types, and return type (or null) as an owned operation of this interface.
-
-