Package de.mid.innovator.srv2api.icw2class

Interface CLClass

All Superinterfaces:

ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, CLBehavioredClassifier, CLClassifier, CLDeclarationAble, CLDeclarationAbleClassifier, CLEncapsulatedClassifier, CLStructuredClassifier, 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

All Known Subinterfaces:

ACActivity, BEBehavior, BEOpaque, CLAssocClass, CLComponent, CLDevice, CLExecEnv, CLNode, CLTemplateParameterAbleClass, IAInteraction, SMProtocolStateMachine, SMStateMachine

public interface CLClass
extends MEPackageAble, CLDeclarationAbleClassifier, CLBehavioredClassifier, CLEncapsulatedClassifier

The purpose of a class is to specify a classification of objects and to specify the features that characterize the structure and behavior of those objects. Class is a kind of classifier whose features are attributes and operations. Attributes of a class are represented by instances of property that are owned by the class. Some of these attributes may represent the navigable ends of binary associations. A class acts as the namespace for various kinds of classifiers defined within its scope, including classes. Nesting of classifiers limits the visibility of the classifier to within the scope of the namespace of the containing class and is used for hiding information. Nested classifiers are used like any other classifier in the containing class. A class may be designated as active, i.e., each of its instances has its own thread of control, or passive, i.e., each of its instances execute within the context of some other object. A class may also specify which signals the instances of this class handle.

See Also:

CLClassHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CLClass.VAttr

Method Summary

Modifier and Type	Method	Description
<T extends CLClassifier> java.util.List<T>	getNestedClassifier(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	References all the classifiers that are defined (nested) within the class.
<T extends CLProperty> java.util.List<T>	getOwnedAttribute(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	The attributes (i.e. the properties) owned by this class.
java.util.List<CLOperation>	getOwnedOperation(K_CONTROL_OPTION... behaviourFlags)	The operations owned by the class.
java.util.List<CLReception>	getOwnedReception(K_CONTROL_OPTION... behaviourFlags)	Receptions that objects of this class are willing to accept.
boolean	isActive()	Determines whether an object specified by this class is active or not.
void	setActive(boolean value)	Set the value of Attribut IsActive.

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADAccessAble

getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRole

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

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.icw2meta.ADLockAble

getLock, getLockableCache, getLockLogin, getLockName, hasClutch, hasLock, hasNoLock, hasOthLock, hasOwnLock, isLockable, lock, unlock

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.ADOptionAble

getOwnedOption, modifyOptionDlg

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADReferenceAble

getReferenceContainer, setReferenceContainer

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADVersionAble

getVersionFile, getVersionList, getVersionListWithoutOpenInfo

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.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, getTypedVariableDRGElement, getTypedVariableDRGElement, getUnmarshallAction, getUseCase

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.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.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.ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

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.ELDeleteAble

delete

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

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.icw2elem.ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELPackageAble

getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage

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.icw2elem.ELUUIDAble

getHyperlinkReferenceAble, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

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.icw2model.MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAble

getMEOwnedMember, getMEPackageImport

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble

getMENamespace, getSignatureMessage

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEPackageAble

getComponent, getManifest

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble

getApplicableAnalysisDia, getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

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.MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getOwnedFormat, getOwnedStereotypePropertyValSpec, getOwnedStereotypeTSOptionValSpec, getOwnedSyncedElement, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, getStereotypeTSOption, getStereotypeTSOptionBoolValue, getStereotypeTSOptionInfo, getStereotypeTSOptionLongValue, getStereotypeTSOptionNameValue, getStereotypeTSOptionStringValue, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueList, getSyncedElement, getSyncedStereotypeAble, getSyncedStereotypeAble, isCloneAbleElement, modifyStereotypePropertyValuesByName, modifyStereotypeTSOptionValuesByName, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Detail

isActive

boolean isActive()
          throws InoNetException,
                 SrvErrorException

Determines whether an object specified by this class is active or not. If true, the owning class is referred to as an active class. If false, such a class is referred to as a passive class.

Throws:

InoNetException

SrvErrorException

setActive

void setActive(boolean value)
        throws InoNetException,
               SrvErrorException

Set the value of Attribut IsActive.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getOwnedAttribute

<T extends CLProperty> java.util.List<T> getOwnedAttribute(java.lang.Class<T> returnType,
                                                           K_CONTROL_OPTION... behaviourFlags)
                                                    throws InoNetException,
                                                           SrvErrorException

The attributes (i.e. the properties) owned by this class.

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

java.util.List<CLOperation> getOwnedOperation(K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
                                              SrvErrorException

The operations owned by the class.

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

java.util.List<CLReception> getOwnedReception(K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
                                              SrvErrorException

Receptions that objects of this class 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.

getNestedClassifier

<T extends CLClassifier> java.util.List<T> getNestedClassifier(java.lang.Class<T> returnType,
                                                               K_CONTROL_OPTION... behaviourFlags)
                                                        throws InoNetException,
                                                               SrvErrorException

References all the classifiers that are defined (nested) within the class.

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.