de.mid.innovator.srv2api.icw2class
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, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface CLUseCase
extends MEPackageAble, CLBehavioredClassifier

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:

CLUseCaseHelper

getAddition

List<CLInclude> getAddition(K_CONTROL_OPTION... behaviourFlags)
                            throws InoNetException,
                                   SrvErrorException

References the include relationship that includes this use case.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getExtend

List<CLExtend> getExtend(K_CONTROL_OPTION... behaviourFlags)
                         throws InoNetException,
                                SrvErrorException

References the extend relationships owned by this use case.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getExtendedCase

List<CLExtend> getExtendedCase(K_CONTROL_OPTION... behaviourFlags)
                               throws InoNetException,
                                      SrvErrorException

References the extend relationships that extends this use case.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

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:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getInclude

List<CLInclude> getInclude(K_CONTROL_OPTION... behaviourFlags)
                           throws InoNetException,
                                  SrvErrorException

References the include relationships owned by this use case.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getIncomingInteractionUseCaseRel

List<BPUseCaseInteractionRel> getIncomingInteractionUseCaseRel(K_CONTROL_OPTION... behaviourFlags)
                                                               throws InoNetException,
                                                                      SrvErrorException

The incoming relationships of the interaction specifications.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

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:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getOwningClassifier

CLClassifier getOwningClassifier()
                                 throws InoNetException,
                                        SrvErrorException

The classifier owning this use case.

Throws:

InoNetException

SrvErrorException

getSubject

<T extends CLClassifier> List<T> getSubject(Class<T> returnType)
                                        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.

Throws:

InoNetException

SrvErrorException

setSubject

void setSubject(List<? extends CLClassifier> values)
                throws InoNetException,
                       SrvErrorException

Set the value of Foreign Key Subject.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException