Package org.palladiosimulator.pcm.repository

Interface Interface

All Superinterfaces:
org.eclipse.emf.cdo.CDOObject, org.eclipse.emf.cdo.common.id.CDOWithID, Entity, EObject, de.uka.ipd.sdq.identifier.Identifier, NamedElement, Notifier, PCMBaseClass, PCMClass
All Known Subinterfaces:
EventGroup, InfrastructureInterface, OperationInterface
All Known Implementing Classes:
EventGroupImpl, InfrastructureInterfaceImpl, InterfaceImpl, OperationInterfaceImpl
public interface Interface extends Entity
A representation of the model object 'Interface'. This entity models the interface as a set of signatures representing services provided or required by a component. An interface is an abstraction of piece of software (a software entity) which should contain a sufficient amount of information for a caller to understand and finally request the realised functionality from any entity claiming to offer the specified functionality. Note that this implies, that the specification of the interface also has to contain a sufficient amount of information for the implementer to actually implement the interface. Due to the inherent need of an interface to abstract the behaviour of the software entity not in all cases there is sufficient information provided to use or implement an interface in an unambiquious way. Interfaces can exist on their own, i.e., without any entity requesting or implementing the specified functionality. Two roles can be identified a software entity can take relative to an interface. Any entity can either claim to implement the functionality specified in an interface or to request that functionality. This is reflected in the Palladio Component Model by a set of abstract meta-classes giving a conceptual view on interfaces, entities, and their relationships.

The following features are supported:

See Also:
Generated class or method.
EMF model class or method.
abstract="true" annotation="http://www.eclipse.org/emf/2002/Ecore constraints='noProtocolTypeIDUsedTwice'" annotation="http://www.eclipse.org/emf/2002/Ecore/OCL/LPG noProtocolTypeIDUsedTwice='self.protocols__Interface->forAll(p1, p2 |\r\np1.protocolTypeID <> p2.protocolTypeID)\r\n'"

  • Field Details

  • Method Details

    • getParentInterfaces__Interface

      EList<Interface> getParentInterfaces__Interface()
      Returns the value of the 'Parent Interfaces Interface' reference list. The list contents are of type Interface. This property represents the interfaces from which this interface directly inherits.
      Returns:
      the value of the 'Parent Interfaces Interface' reference list.
      See Also:
      Generated class or method.
      EMF model class or method.
      ordered="false"

    • getProtocols__Interface

      EList<Protocol> getProtocols__Interface()
      Returns the value of the 'Protocols Interface' containment reference list. The list contents are of type Protocol. This property represents the protocol bound to this interfaces, i.e., the way, in the sense of the order, the services of this interfaces are allowed to be called.
      Returns:
      the value of the 'Protocols Interface' containment reference list.
      See Also:
      Generated class or method.
      EMF model class or method.
      containment="true" ordered="false"

    • getRequiredCharacterisations

      EList<RequiredCharacterisation> getRequiredCharacterisations()
      Returns the value of the 'Required Characterisations' containment reference list. The list contents are of type RequiredCharacterisation. It is bidirectional and its opposite is 'Interface Required Characterisation'. documentation of required variable characterisations
      Returns:
      the value of the 'Required Characterisations' containment reference list.
      See Also:
      Generated class or method.
      EMF model class or method.
      opposite="interface_RequiredCharacterisation" containment="true" ordered="false"

    • getRepository__Interface

      Repository getRepository__Interface()
      Returns the value of the 'Repository Interface' container reference. It is bidirectional and its opposite is 'Interfaces Repository'. This property represents the repository where this interface is stored.
      Returns:
      the value of the 'Repository Interface' container reference.
      See Also:
      Generated class or method.
      EMF model class or method.
      opposite="interfaces__Repository" required="true" transient="false" ordered="false"

    • setRepository__Interface

      void setRepository__Interface(Repository value)
      Sets the value of the 'Repository Interface' container reference.
      Parameters:
      value - the new value of the 'Repository Interface' container reference.
      See Also:
      Generated class or method.

    • isAssignableFrom

      boolean isAssignableFrom(Interface otherInterface)
      The method tests if the interface given as parameter is the same as the called interface or is a transitive parent of the called interface.
      Generated class or method.
      EMF model class or method.
      required="true" otherInterfaceRequired="true" annotation="http://www.eclipse.org/emf/2002/Ecore/OCL/LPG body='self->closure(i : Interface | i.parentInterfaces__Interface)->including(self)->includes(otherInterface)'"