de.mid.innovator.srv2api.icw2class
Interface CLInterface
- All Superinterfaces:
- ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, CLClassifier, CLDeclarationAble, CLDeclarationAbleClassifier, CLTemplateAbleElement, CLTemplateParameterAbleElement, ELClassifier, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELRedefAble, ELType, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAble, MENamespaceAsgnAble, MEPackageAble, MEStereotypeAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble
public interface CLInterface
- extends MEPackageAble, CLDeclarationAbleClassifier
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 via the interface.
Interfaces are declarations, which means that they are not instantiable. Instead, an interface specification is implemented by an instance of an instantiable classifier; this means that the instantiable classifier presents a public facade that conforms to the interface specification. Note that a given classifier may implement more than one interface and that an interface may be implemented by a number of different classifiers.
- See Also:
CLInterfaceHelper
| Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLClassifier |
dialogFolderRedefine, getAggregatedClassifier, getAggregatedClassifier, getAggregatedOrComposedClassifier, getAggregatedOrComposedClassifier, getAggregatingClassifier, getAggregatingClassifier, getAggregatingOrComposingClassifier, getAggregatingOrComposingClassifier, getClassifierInstance, getClassifierTemplateParameter, getComposedClassifier, getComposedClassifier, getComposingClassifier, getComposingClassifier, getContract, getContract, getContractSubstitution, getCreateObjectAction, getExceptionHandler, getInstSpec, getInterface, getOwnClass, getOwnedRule, getOwnedTemplateParameter, getOwnedUseCase, getProvidedInterface, getProvidedInterface, getProvidedInterfaceDirect, getProvidedInterfaceDirect, getRealizingClassifierRealization, getRequiredInterface, getRequiredInterface, getRequiredInterfaceDirect, getRequiredInterfaceDirect, getSubstitution, getTypedBCProperty, getTypedObjectNode, getTypedParameter, getTypedProperty, getTypedVariable, getUnmarshallAction, getUseCase |
| Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELClassifier |
getAssociation, getAssociation, getAssociationEndFirstTypedBySelf, getAssociationEndFirstTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelf, getAssociationEndTypedBySelf, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationNavigableFrom, getAssociationNavigableFrom, getAssociationOfSelfOrGeneralTransitive, getAssociationOfSelfOrGeneralTransitive, getAssociationTypedBySelf, getAssociationTypedBySelf, getClassifierViewGroup, getEffectiveRedefinerOfAssocEnd, getEffectiveRedefinerOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getGeneralDirect, getGeneralDirect, getGeneralGeneralizationSet, getGeneralGeneralizationSet, getGeneralization, getGeneralTransitive, getGeneralTransitive, getItemDefinition, getOwnedAndInheritedMember, getOwnedAndInheritedMember, getPropertyNavigableFrom, getPropertyNavigableFrom, getPropertyNavigableFromSelfOrGeneralTransitive, getPropertyNavigableFromSelfOrGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitiveNotAbstract, getSelfAndSpecificTransitiveNotAbstract, getSpecialization, getSpecificDirect, getSpecificDirect, getSpecificGeneralization, getSpecificGeneralizationSet, getSpecificGeneralizationSet, getSpecificTransitive, getSpecificTransitive, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getTypedCLStructureEntry, getTypedMaskField, getTypesOfEffectiveSubsetterOfAssocEnd, getTypesOfEffectiveSubsetterOfAssocEnd, getViewTransitive, getViewTransitive, isAbstract, isRoot, isSpecificTransitive, setAbstract |
| Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADLockAble |
getLock, getLockableCache, getLockLogin, getLockName, hasClutch, hasLock, hasNoLock, hasOthLock, hasOwnLock, isLockable, lock, unlock |
| Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble |
getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner |
| Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement |
getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getResetDefaultName, getSupplierDependency, rename, setName, setNameKind, setResetDefaultName |
| Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAble |
getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport |
| Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEModelElement |
buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor |
| Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble |
getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRowList, getTabElementRowTypeList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify |
| Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble |
getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg |
| Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLabelAble |
getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo |
| Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble |
getClientMappingDependency, getOutgoingConceptRealization, getProxyAsgProperty, getRealizedConcept, getRealizedConcept, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, replaceRealizedConcepts, setMapped, setRealizedConcept, setRequirementOfStakeholder |
| Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble |
assignStereotypeDlg, cloneElement, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getOwnedFormat, getOwnedStereotypePropertyValSpec, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, isCloneAbleElement, modifyStereotypePropertyValuesByName, setStereotype, setStereotypePropertyInfo |
getContractInterfaceRealization
List<CLInterfaceRealization> getContractInterfaceRealization(K_CONTROL_OPTION... behaviourFlags)
throws InoNetException,
SrvErrorException
- All interface realizations of behaviored classifiers which realize this interface.
- Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
- Throws:
InoNetException
SrvErrorException
getImplementingClassifier
<T extends CLClassifier> List<T> getImplementingClassifier(Class<T> returnType,
K_CONTROL_OPTION... behaviourFlags)
throws InoNetException,
SrvErrorException
- All classifiers implementing this interface.
- Parameters:
returnType - Specifies the type of elements to be returned.behaviourFlags - An optional list of enum values to control the behaviour of the command.
- Throws:
InoNetException
SrvErrorException
getImplementingClassifier
<T extends CLClassifier> List<T> getImplementingClassifier(Class<T> returnType,
MMStereotype stereotype,
K_CONTROL_OPTION... behaviourFlags)
throws InoNetException,
SrvErrorException
- The method calls getImplementingClassifier and filters its return values according to the given stereotype value.
- Parameters:
returnType - Specifies the type of elements to be returned.stereotype - The stereotype used to filter the result listbehaviourFlags - An optional list of enum values to control the behaviour of the command.
- Throws:
InoNetException
SrvErrorException
getInterfaceRealizationOfInterface
List<CLInterfaceRealization> getInterfaceRealizationOfInterface(K_CONTROL_OPTION... behaviourFlags)
throws InoNetException,
SrvErrorException
- All realizations of this interface.
- Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
- Throws:
InoNetException
SrvErrorException
getInterfaceRealizationOfInterface
List<CLInterfaceRealization> getInterfaceRealizationOfInterface(MMStereotype stereotype,
K_CONTROL_OPTION... behaviourFlags)
throws InoNetException,
SrvErrorException
- The method calls getInterfaceRealizationOfInterface and filters its return values according to the given stereotype value.
- Parameters:
stereotype - The stereotype used to filter the result listbehaviourFlags - An optional list of enum values to control the behaviour of the command.
- Throws:
InoNetException
SrvErrorException
getInterfaceUsage
List<MEUsage> getInterfaceUsage(K_CONTROL_OPTION... behaviourFlags)
throws InoNetException,
SrvErrorException
- All usage dependencies using this interface.
- Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
- Throws:
InoNetException
SrvErrorException
getNestedClassifier
<T extends CLClassifier> List<T> getNestedClassifier(Class<T> returnType,
K_CONTROL_OPTION... behaviourFlags)
throws InoNetException,
SrvErrorException
- Parameters:
returnType - Specifies the type of elements to be returned.behaviourFlags - An optional list of enum values to control the behaviour of the command.
- Throws:
InoNetException
SrvErrorException- Sorted:
- the result may be sorted.
getOwnedAttribute
<T extends CLProperty> List<T> getOwnedAttribute(Class<T> returnType,
K_CONTROL_OPTION... behaviourFlags)
throws InoNetException,
SrvErrorException
- The attributes owned by this interface.
- Parameters:
returnType - Specifies the type of elements to be returned.behaviourFlags - An optional list of enum values to control the behaviour of the command.
- Throws:
InoNetException
SrvErrorException- Sorted:
- the result may sorted.
getOwnedOperation
List<CLOperation> getOwnedOperation(K_CONTROL_OPTION... behaviourFlags)
throws InoNetException,
SrvErrorException
- References all operations owned by the interface.
- Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
- Throws:
InoNetException
SrvErrorException- Sorted:
- the result may be sorted.
getOwnedReception
List<CLReception> getOwnedReception(K_CONTROL_OPTION... behaviourFlags)
throws InoNetException,
SrvErrorException
- Receptions that objects providing this interface are willing to accept.
- Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
- Throws:
InoNetException
SrvErrorException- Sorted:
- the result may be sorted.
getProtocol
List<SMProtocolStateMachine> getProtocol(K_CONTROL_OPTION... behaviourFlags)
throws InoNetException,
SrvErrorException
- Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
- Throws:
InoNetException
SrvErrorException- Sorted:
- the result may be sorted.