(SPEC) Improve the view of the findings list inside the protocol window

1. REQUIREMENT & SPECIFICATION

Inside the 'findings' tab of the protocol window the last findings should be visible with their most important details (finding's number, severity and the beginning of the description). This is the findings' compact view. Only one finding should be displayed in edit view at the same time. It's also possible to display all findings in compact view by collapsing the finding which is currently displayed in edit view. When a new protocol is created, the first finding is created automatically and displayed in edit view.

Please find attached to this blueprint a prototype for the user interface.

----

2. USE CASES

- add findings (described in 2.1)
- delete finding if there is one inside the protocol only (described in 2.2)
- delete finding if there are more than one inside the protocol (described in 2.3)
- change order of existing findings (described in 2.4)

2.1. ADD FINDINGS

[ACTORS]
Scribe

[PRECONDITION]
The application is running and shows the findings tab inside the protocol window for a particular review meeting. The first finding is created automatically and displayed in edit view.

[NORMAL FLOW OF EVENTS]
(1) The actor adds some details like its description and a reference to the first finding.
(2) The actor clicks on "Add new finding" in order to add a new finding into the protocol.
(3) The actor collapses the second finding.
(4) The actor clicks on the compact view of the first finding.

[POSTCONDITION]
There are two findings displayed, the first in edit view, the second in compact view.

[ALTERNATIVE FLOWS OF EVENTS]
None.

--

2.2. DELETE FINDING IF THERE IS ONE INSIDE THE PROTOCOL ONLY

[ACTORS]
Scribe

[PRECONDITION]
The application is running and shows the findings tab inside the protocol window for a particular review meeting. There is one finding inside the protocol displayed in compact view.

[NORMAL FLOW OF EVENTS]
(1) The actor clicks on the compact view of the existing finding.
(2) The actor clicks on "Remove this finding".
(3) A dialog box is shown in order to confirm the removal of the finding.
(4) The actor confirms the removal.

[POSTCONDITION]
The finding is not part of the protocol anymore. A new finding is created automatically and displayed in edit view.

[ALTERNATIVE FLOWS OF EVENTS]
(4b) The actor cancels the removal; in this case nothing changes inside the protocol.

--

2.3. DELETE FINDING IF THERE ARE MORE THAN ONE INSIDE THE PROTOCOL

[ACTORS]
Scribe

[PRECONDITION]
The application is running and shows the findings tab inside the protocol window for a particular review meeting. There are at least two findings inside the protocol displayed in compact view.

[NORMAL FLOW OF EVENTS]
(1) The actor clicks on the compact view of one existing finding.
(2) The actor clicks on "Remove this finding".
(3) A dialog box is shown in order to confirm the removal of the finding.
(4) The actor confirms the removal.

[POSTCONDITION]
The selected finding is not part of the protocol anymore. All the other findings are shown in compact view.

[ALTERNATIVE FLOWS OF EVENTS]
(4b) The actor cancels the removal; in this case nothing changes inside the protocol.

--

2.4. CHANGE ORDER OF EXISTING FINDINGS

[ACTORS]
Scribe

[PRECONDITION]
The application is running and shows the findings tab inside the protocol window for a particular review meeting. There are exactly three findings (no. 1, no. 2 and no. 3) inside the protocol displayed in compact view.

[NORMAL FLOW OF EVENTS]
(1) The actor clicks on the compact view of finding no. 3.
(2) The actor clicks on "Move top".
(3) The actor clicks on "Move down".
(4) The actor clicks on the compact view of finding no. 1.
(5) The actor clicks on "Move bottom".
(6) The actor clicks on "Move up".

[POSTCONDITION]
The findings are displayed in the following order inside the protocol: no. 3, no. 1, no. 2. Finding no. 1 is displayed in edit view; the other findings are displayed in compact view.

[ALTERNATIVE FLOWS OF EVENTS]
None.

----

3. DESIGN & TECHNICAL SOLUTION

First of all, we are going to "extract" the whole Findings tab of the 'ProtocolFrame' class into a new class called 'FindingsTab'. Besides of that, the class 'FindingPanel' will be introduced. This class represents the view of one finding. It has two states in order to switch between "edit view" and "compact view".

Inside the 'FindingsTab' class we are going to implement a list of findings like you can see it from the attached prototype.

----

4. UNIT TESTING

For this feature there is no unit testing because it is part of the user interface only.

----

5. SYSTEM TEST

This feature is tested by running each of the Use Cases defined above. The results of the execution(s) of this test will be recorded here.

5.1. TEST PROTOCOL 2010-05-27

[USE CASE 2.1] Ok, usual procedure; no errors
[USE CASE 2.2] Ok, usual procedure; no errors
[USE CASE 2.3] Ok, usual procedure; no errors
[USE CASE 2.4] Ok, usual procedure; no errors