Interface CLUseCase
- All Superinterfaces:
ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, CLBehavioredClassifier, CLClassifier, CLTemplateAbleElement, CLTemplateParameterAbleElement, ELClassifier, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELRedefAble, ELType, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAble, MENamespaceAsgnAble, MEPackageAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble
A use case is the specification of a set of actions performed by a system. It yields an observable result that is, typically, of value for one or more actors or other stakeholders of the system.
A use case is a kind of behaviored classifier that represents a declaration of an offered behavior. Each use case specifies some behavior, possibly including variants, that the subject can perform in collaboration with one or more actors. Use cases define the offered behavior of the subject without reference to its internal structure. These behaviors, involving interactions between the actor and the subject, may result in changes to the state of the subject and communications with its environment.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptiongetExtensionPoint(K_CONTROL_OPTION... behaviourFlags) References the extension points owned by the use case.The incoming relationships of the interaction specifications.getOutgoingPathUseCaseRel(K_CONTROL_OPTION... behaviourFlags) The outgoing relationships of the use case.The classifier owning this use case.<T extends CLClassifier>
List<T> getSubject(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags) voidsetSubject(List<? extends CLClassifier> values) Set the value of Foreign Key Subject.Methods inherited from interface ADAccessAble
getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRoleMethods inherited from interface ADClientAble
getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDiaMethods inherited from interface ADHistoryAble
getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistoryMethods inherited from interface ADLockAble
getLock, getLockableCache, getLockLogin, getLockName, hasClutch, hasLock, hasNoLock, hasOthLock, hasOwnLock, isLockable, lock, unlockMethods inherited from interface ADM2AttrModifyAble
getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModifyMethods inherited from interface ADOptionAble
getOwnedOption, modifyOptionDlgMethods inherited from interface ADReferenceAble
getReferenceContainer, setReferenceContainerMethods inherited from interface ADVersionAble
getVersionFile, getVersionList, getVersionListWithoutOpenInfoMethods inherited from interface CLBehavioredClassifier
getClassifierBehavior, getInterfaceRealization, getOwnedBehavior, getOwnedProtocolStateMachine, getOwnedTrigger, getOwnedTriggerMethods inherited from interface CLClassifier
dialogFolderRedefine, getAggregatedClassifier, getAggregatedClassifier, getAggregatedOrComposedClassifier, getAggregatedOrComposedClassifier, getAggregatingClassifier, getAggregatingClassifier, getAggregatingOrComposingClassifier, getAggregatingOrComposingClassifier, getClassifierInstance, getClassifierTemplateParameter, getComposedClassifier, getComposedClassifier, getComposingClassifier, getComposingClassifier, getContract, getContract, getCreateObjectAction, getExceptionHandler, getInstSpec, getInterface, getOwnClass, getOwnedRule, getOwnedTemplateParameter, getOwnedUseCase, getProvidedInterface, getProvidedInterface, getProvidedInterfaceDirect, getProvidedInterfaceDirect, getRealizingClassifierRealization, getRequiredInterface, getRequiredInterface, getRequiredInterfaceDirect, getRequiredInterfaceDirect, getSubstitution, getTypedBCProperty, getTypedObjectNode, getTypedParameter, getTypedProperty, getTypedPropertyNotAssocEnd, getTypedVariable, getTypedVariableDRGElement, getTypedVariableDRGElement, getUnmarshallAction, getUseCaseMethods inherited from interface CLTemplateAbleElement
getActualTemplateParameter, getActualTemplateParameter, getOwnedTemplateParameter, getTemplateBindingSource, getTemplateBindingTarget, getTemplateParameterMethods inherited from interface CLTemplateParameterAbleElement
getActualParameterSubstitution, getTemplateParameterMethods inherited from interface 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, 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, setAbstractMethods inherited from interface ELContainerAble
getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContentsMethods inherited from interface ELContAsgnAble
getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwnerMethods inherited from interface ELDeleteAble
deleteMethods inherited from interface ELElement
duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnitMethods inherited from interface ELNamedElement
getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKindMethods inherited from interface ELNamespaceAble
getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getItemDefinition, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImportMethods inherited from interface ELNamespaceAsgnAble
getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibilityMethods inherited from interface ELObject
getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasReadMethods inherited from interface ELPackageAble
getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackageMethods inherited from interface ELRedefAble
getRedefined, getRedefining, isLeaf, isRedefined, isRedefining, setLeaf, setRedefinedMethods inherited from interface ELType
getRaisingAsException, getTypedElement, getTypedElementNotAssocEnd, getTypedElementNotAssocEnd, isTypeReuseableMethods inherited from interface ELUUIDAble
getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUIDMethods inherited from interface ELValueContainerAble
getValueReUseAble, setValueReUseAbleMethods inherited from interface MECommentAble
getAssignedComment, getAssignedComment, getCommentAssignMethods inherited from interface MEConstraintAble
getAssignedConstraint, getAssignedConstraint, getConstraintAssignMethods inherited from interface MEModelElement
buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColorMethods inherited from interface MENamedElement
getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependencyMethods inherited from interface MENamespaceAble
getMEOwnedMember, getMEPackageImportMethods inherited from interface MENamespaceAsgnAble
getSignatureMessageMethods inherited from interface MEPackageAble
getComponent, getManifestMethods inherited from interface MEStereotypeAble
getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getMEClientDependency, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholderMethods inherited from interface METermAble
getTerm, setTermMethods inherited from interface MMAttachmentAble
getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachmentMethods inherited from interface MMCommentContainerAble
getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConceptMethods inherited from interface MMLabelAble
getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfoMethods inherited from interface MMStereotypeAble
assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getExtendingStereotype, getExtendingStereotypeNames, 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, setExtendingStereotype, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble
-
Method Details
-
getSubject
<T extends CLClassifier> List<T> getSubject(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException References the subjects which this use case applies to. The subject or its parts realize all the use cases that apply to this subject. However, use cases need not be attached to any specific subject. The subject may, but need not, own the use cases that apply to it.- 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:
InoNetExceptionSrvErrorException- Sorted:
- the result may sorted.
-
setSubject
Set the value of Foreign Key Subject.- Parameters:
values- The value to be set.- Throws:
InoNetExceptionSrvErrorException
-
getExtend
- Throws:
InoNetExceptionSrvErrorException
-
getExtendedCase
- Throws:
InoNetExceptionSrvErrorException
-
getInclude
- Throws:
InoNetExceptionSrvErrorException
-
getAddition
- Throws:
InoNetExceptionSrvErrorException
-
getExtensionPoint
List<CLExtensionPoint> getExtensionPoint(K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException References the extension points owned by the use case.- Parameters:
behaviourFlags- An optional list of enum values to control the behaviour of the command.- Throws:
InoNetExceptionSrvErrorException- Sorted:
- the result may be sorted.
-
getIncomingInteractionUseCaseRel
List<BPUseCaseInteractionRel> getIncomingInteractionUseCaseRel() throws InoNetException, SrvErrorExceptionThe incoming relationships of the interaction specifications.- Throws:
InoNetExceptionSrvErrorException
-
getOutgoingPathUseCaseRel
List<BPUseCasePathRel> getOutgoingPathUseCaseRel(K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException The outgoing relationships of the use case.- Parameters:
behaviourFlags- An optional list of enum values to control the behaviour of the command.- Throws:
InoNetExceptionSrvErrorException- Sorted:
- the result may be sorted.
-
getOwningClassifier
The classifier owning this use case.- Throws:
InoNetExceptionSrvErrorException
-