designspec_states

5 Project states and transitions

5.1 Introduction

This chapter describes which states a project can be in and which transitions between these states can be done. The semantics of each state and each transition are also described.

5.2 States

A project can have three states. Here the semantics of each state are described. See chapter 6, "Directory structure" for more information about directories.

5.2.1 Dynamic state

When a project is in dynamic state, it means that it is under development. The administrator can freely create, import and delete tests etc. in it.

A project in dynamic state is located in the "dynamic" directory of AudioJuryAdministrator.

5.2.2 Active state

When the administrator feels that the project is ready for the test participants, the project can be moved into active state. Active state means that results originating from clients that have completed the project in question, will be accepted by the administrator program.

A project in active state is located in the "active" directory of AudioJuryAdministrator. Also, if a writable shared folder is defined and exists, a copy of the project is located there.

5.2.3 Closed state

When the administrator feels that enough test results have been generated, the test can be moved into closed state. Incoming results for closed projects will be discarded by the administrator program.

A project in closed state is located in the "closed" directory of AudioJuryAdministrator.

5.3 Transitions

Just as the states themselves have a certain semantic, so do the transitions between them. When a project goes from one state to another, a number of things happen. This section describes that.

This diagram shows which transitions are possible for a project.

Figure 2: Project state transitions

5.3.1 Activate project

1. When a project is activated, the project directory is copied from the "dynamic" directory to the "active" directory. The name of the copy is extended with a tag. The tag consists of the date and an extra integer on the form " (N.yyyy-mm-DD)". Where n is a positive integer that starts at 1 and gets incremented if there already is an activated copy of this project with the same date.

2. If a writable shared folder is defined and exists, the project copy is also copied to the shared folder.

Activating a project could be regarded as making a "snapshot" or creating a "milestone".

Example: A project is called "Mayhem" and the current date is the 22:nd of February 2002. When the project gets activated the copy gets the name "Mayhem (1.2002-02-22)". Further assume that on the same day the dynamic project "Mayhem" gets edited further and is then activated again. A new copy with the name "Mayhem (2.2002-02-22)" will be created.

5.3.2 Close project

1. If a shared folder exists and a copy of the project is located there, all contents of the result directory of that project are copied into the results directory of the local active project directory.

2. The project directory is then moved from the "active" directory to the "closed" directory.

3. If a writable shared folder is defined and exists and a copy of the project is located there, that copy is removed.

5.3.3 Reactivate project

1. When a project is reactivated, the project directory is moved from the closed directory to the active directory.

2. If a writable shared folder is defined and exists, the project is copied there.