de.mid.innovator.srv2api.icw2class
Interface CLComponent

All Superinterfaces:
ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, CLBehavioredClassifier, CLClass, CLClassifier, CLDeclarationAble, CLDeclarationAbleClassifier, CLEncapsulatedClassifier, CLStructuredClassifier, CLTemplateAbleElement, CLTemplateParameterAbleElement, ELClassifier, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELPictureAble, ELRedefAble, ELType, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEHierarchyAble, MEModelElement, MENamedElement, MENamespaceAble, MENamespaceAsgnAble, MEPackageAble, MERefAbleAsResource, MEReferenceContainerAble, MEStereotypeAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface CLComponent
extends CLClass, MEHierarchyAble, MERefAbleAsResource

A component represents a modular part of a system that encapsulates its contents and whose manifestation is replaceable within its environment. A component is a subtype of class which provides for a component having attributes and operations, and being able to participate in associations and generalizations. A component may form the abstraction for a set of classifiers that realize its behavior. In addition, a component may optionally have an internal structure and own a set of ports that formalize its interaction points. A component has a number of provided and required interfaces that form the basis for wiring components together. A component is modeled throughout the development life cycle and successively refined into deployment and run-time. A component may be manifest by one or more artifacts.

See Also:
CLComponentHelper

Nested Class Summary
static class CLComponent.VAttr
           
 
Method Summary
 List<BPDia> getOwnedBPDia(K_CONTROL_OPTION... behaviourFlags)
          All bpmn diagrams owned by this component.
<T extends CLDia>
List<T>
getOwnedDiagram(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)
          All classifier diagrams owned by this component.
 List<BSDia> getOwnedStateDiagram(K_CONTROL_OPTION... behaviourFlags)
          All state diagrams owned by this component.
<T extends MEPackageAble>
List<T>
getPackagedElement(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)
          The set of packageable elements that a component owns.
 List<CLComponentRealization> getRealization(K_CONTROL_OPTION... behaviourFlags)
          The set of component realizations owned by this component.
<T extends CLClassifier>
List<T>
getRealizingClassifier(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)
          All classifiers which realize this component.
<T extends CLClassifier>
List<T>
getRealizingClassifier(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)
          The method calls getRealizingClassifier and filters its return values according to the given stereotype value.
 List<MECreateRedirect> getRedirectSource(K_CONTROL_OPTION... behaviourFlags)
          All create redirections owned by this component.
 List<MECreateRedirect> getRedirectTraget(K_CONTROL_OPTION... behaviourFlags)
          All create redirections with this component as target.
 boolean isIndirectlyInstantiated()
          The kind of instantiation that applies to a component.
 void setIndirectlyInstantiated(boolean value)
          Set the value of Attribut IsIndirectlyInstantiated.
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLClass
getNestedClassifier, getOwnedAttribute, getOwnedOperation, getOwnedReception, isActive, setActive
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLBehavioredClassifier
getClassifierBehavior, getInterfaceRealization, getOwnedBehavior, getOwnedProtocolStateMachine, getOwnedTrigger, getOwnedTrigger
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLEncapsulatedClassifier
getOwnedPort
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLStructuredClassifier
getCollaborationUse, getOwnedConnector, getOwnedProperty, getRepresentation
 
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.icw2model.MEConstraintAble
getAssignedConstraint, getAssignedConstraint, getConstraintAssign
 
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.icw2elem.ELRedefAble
getRedefined, getRedefining, isLeaf, isRedefined, isRedefining, setLeaf, setRedefined
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELType
getRaisingAsException, getTypedElement, getTypedElementNotAssocEnd, getTypedElementNotAssocEnd
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADVersionAble
getVersionFile, getVersionList, getVersionListWithoutOpenInfo
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADOptionAble
getOwnedOption, modifyOptionDlg
 
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.icw2meta.ADHistoryAble
getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELPackageAble
getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAsgnAble
getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility
 
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.icw2meta.ADAccessAble
getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRole
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAble
getMEOwnedMember, getMEPackageImport
 
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.MENamedElement
getMESupplierDependency, getMESupplierMappingDependency
 
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.ADClientAble
getAnnotation, getLogic, getLogic, getPresentationContext, getSection
 
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.icw2model.MEStereotypeAble
getClientMappingDependency, getOutgoingConceptRealization, getProxyAsgProperty, getRealizedConcept, getRealizedConcept, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, replaceRealizedConcepts, setMapped, setRealizedConcept, setRequirementOfStakeholder
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble
getOwnedComment
 
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
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble
getAssignedComment, getAssignedComment, getCommentAssign
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADReferenceAble
getReferenceContainer, setReferenceContainer
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLTemplateAbleElement
getActualTemplateParameter, getActualTemplateParameter, getOwnedTemplateParameter, getTemplateBindingSource, getTemplateBindingTarget, getTemplateParameter
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLTemplateParameterAbleElement
getActualParameterSubstitution, getOwningTemplateParameter, getTemplateParameter
 
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.icw2meta.MMAttachmentAble
getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEHierarchyAble
getOwnedDiaWhiteboard, getOwnedGCDia, getWorkingDirectory
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEPackageAble
getComponent, getManifest
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble
getMENamespace
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble
getUUID, setUUID
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEReferenceContainerAble
addReferences, getReferenceAble, moveReferences, setReferenceAble, subtractReferences
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MERefAbleAsResource
getActivityResource, getCostsPerTime, getGlobalTaskResource, getLaneR, getLaneWithResource, getLaneWithResource, getParticipantAsEntity, getParticipantAsEntity, getParticipantAsEntityR, getParticipantInRole, getParticipantInRole, getParticipantInRoleR, setCostsPerTime
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELPictureAble
getOwnedPicture, getPictureRawData, pictureSetRawData
 

Method Detail

getOwnedBPDia

List<BPDia> getOwnedBPDia(K_CONTROL_OPTION... behaviourFlags)
                          throws InoNetException,
                                 SrvErrorException
All bpmn diagrams owned by this component.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException
Sorted:
the result may be sorted.

getOwnedDiagram

<T extends CLDia> List<T> getOwnedDiagram(Class<T> returnType,
                                          K_CONTROL_OPTION... behaviourFlags)
                                      throws InoNetException,
                                             SrvErrorException
All classifier diagrams owned by this component.

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.

getOwnedStateDiagram

List<BSDia> getOwnedStateDiagram(K_CONTROL_OPTION... behaviourFlags)
                                 throws InoNetException,
                                        SrvErrorException
All state diagrams owned by this component.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException
Sorted:
the result may be sorted.

getPackagedElement

<T extends MEPackageAble> List<T> getPackagedElement(Class<T> returnType,
                                                     K_CONTROL_OPTION... behaviourFlags)
                                                 throws InoNetException,
                                                        SrvErrorException
The set of packageable elements that a component owns. In the namespace of a component, all model elements that are involved in or related to its definition may be owned or imported explicitly. These may include e.g., classes, interfaces, components, packages, use cases, dependencies (e.g., mappings) and artifacts.

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.

getRealization

List<CLComponentRealization> getRealization(K_CONTROL_OPTION... behaviourFlags)
                                            throws InoNetException,
                                                   SrvErrorException
The set of component realizations owned by this component. Realizations reference the classifiers which the component is an abstraction of; i.e., that realize its behavior.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException
Sorted:
the result may be sorted.

getRealizingClassifier

<T extends CLClassifier> List<T> getRealizingClassifier(Class<T> returnType,
                                                        K_CONTROL_OPTION... behaviourFlags)
                                                    throws InoNetException,
                                                           SrvErrorException
All classifiers which realize this component.

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

getRealizingClassifier

<T extends CLClassifier> List<T> getRealizingClassifier(Class<T> returnType,
                                                        MMStereotype stereotype,
                                                        K_CONTROL_OPTION... behaviourFlags)
                                                    throws InoNetException,
                                                           SrvErrorException
The method calls getRealizingClassifier 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 list
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getRedirectSource

List<MECreateRedirect> getRedirectSource(K_CONTROL_OPTION... behaviourFlags)
                                         throws InoNetException,
                                                SrvErrorException
All create redirections owned by this component.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getRedirectTraget

List<MECreateRedirect> getRedirectTraget(K_CONTROL_OPTION... behaviourFlags)
                                         throws InoNetException,
                                                SrvErrorException
All create redirections with this component as target.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

isIndirectlyInstantiated

boolean isIndirectlyInstantiated()
                                 throws InoNetException,
                                        SrvErrorException
The kind of instantiation that applies to a component. If false, the component is instantiated as an addressable object. If true, the component is defined at the time of design but an object specified by the component does not exist at runtime (or execution time); this means that the component is instantiated indirectly through the instantiation of its realizing classifiers or parts.

Throws:
InoNetException
SrvErrorException

setIndirectlyInstantiated

void setIndirectlyInstantiated(boolean value)
                               throws InoNetException,
                                      SrvErrorException
Set the value of Attribut IsIndirectlyInstantiated.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException