Standards: Use-Case
Realizations
Use-Case Realization |
A use-case realization describes how a particular use case is realized within the
design model, in terms of collaborating objects. |
Related Information: |
|
Topics
Background
Each Use-Case to be analyzed will be complemented with a Use-Case realization. For each
use-case realization there is one or more class diagrams depicting its participating
classes and one or more interaction diagrams depicting its participating objects and their
interactions.
These diagrams can be presented, along with any textual elaboration of the Use-Case
(i.e. Use-Case Design documentation or textual scenarios), in a Use-Case Realization
document. There will be one Use-Case realization document per Use-Case.
Naming Standards
Use Case Realizations are named by appending Realization to the name of the Use Case
realized (i.e. the realization of the Receive Deposit Item use case will be named Receive
Deposit Item Realization).
Where a single realization per use case is insufficient then sequentially number the
realizations.
Note: the naming standards for the diagrams contained by the realization are detailed
in the documentation section where the required set of diagrams is defined.
General Documentation Standards
The realization will consist of adding the following diagrams to the Use-Case
Realization in the Rose Model:
Diagram |
Diagram
Type |
Optionality |
Naming
Standard |
Purpose
/ Comments |
Participating Classes |
Class
Diagram |
Mandatory |
Name the diagram Participating Classes.
If more than one diagram is required number the diagrams. |
This diagram shows the classes that
participate in the Use Case. This diagram could
be generated automatically using Rose Script. |
Overview |
Collaboration |
Optional |
Name the diagram Overview. If more than one diagram is required number the diagrams. |
This diagram shows all of the objects
involved in the use case and the links between them. It does not show the messages sent.
This diagram could be generated automatically using Rose
Script. |
Flow of Events |
Sequence |
Mandatory |
Name the Flow of Event diagrams after the
Flow being analyzed / designed. If more than one
diagram is required to explore a single flow then sequentially number the diagrams in the
order they should be read. |
Basic flow and all alternate flows must be
elaborated via sequence diagrams. Alternate Flows
should be described in terms of their variation from the Basic Flow. We do not want to
repeat the details of the Basic Flow over and over again on the individual Alternative
Flow diagrams. |
Sub-Flows |
Sequence |
Optional |
Name the Sub-Flow diagrams after the Sub-Flow
being analyzed / designed. |
Produce individual diagrams detailing the
sub-flows where their use simplifies, and reduces repetition, on the basic and alternate
flow diagrams. |
Local View |
Use Case |
Mandatory |
Name the diagram Local View. |
|
Note: The basic flow and all alternative flows must be documented.
See the individual diagram types for details of the standards applied to each diagram.
Stereotypes
No use case realization stereotypes have been identified. The realizations themselves
are represented as a stereotyped UML collaboration (or in Rose a stereotyped Use Case See:
Documentation in Rose below).
Documentation in Rose
Each Use Case Realization is given its own <<dynamic>> package in the
Logical View this is to enable the realization to be treated as a controlled unit
for change management purposes. This package is given a single Use Case to represent
the Use Case Realization. This Use Case is given the stereotype of <<use case
realization>> and the appropriate dashed ellipse icon can be used if the RUP Rose
Add-in is installed. The modeling standards for use case realizations are
then applied.
Examples
None |