From PatioWiki

Revision as of 09:47, 11 October 2011

This section contains all the technical information relating to the part of the tool that is common to all the exercises editors that are part of Tareas.

Class diagrams

The following image shows the summarized class diagram of the general part of Tareas.

700px|Diagrama de clases general.

As shown in the diagram above, there is a main class called "MainPanel" which represents the main panel of the tool. This class contains both the main toolbar ("mainToolBar") as the bottom toolbar ("previewSaveToolBar"). Between them stands the "exercisePanel" panel, where all the exercise editors will be shown. The main class is also responsible for storing any general information of the tool.

The class "mainToolBar", which is the main toolbar, is responsible to perform operations like create, edit and delete exercises, and is also used for establishing the configuration of the tool. To perform these operations, some panels like "ExerciseTypeSelectPanel" (for selecting the exercise type) or "ButtonsConnectionPanel" (for the configuration of the tool) can be shown to the user.

Using the "previewSaveToolBar" toolbar, you can make operations of the last phase of creating an exercise like preview or save an exercise.

When loading an exercises editor at the "exercisePanel" panel, the top toolbar ("mainToolBar") does not change and, therefore, will be the same for all editors types. However, the bottom toolbar may vary depending on the exercise type and the editing mode you are using.

Use cases

The following image shows the use case diagram of the general part of Tareas.

600px|Diagrama general de casos de uso de Tareas.

Next there is a textual description of the general use cases of Tareas..

1. Use case: Change connection type.

     Main actor: User. 
     Preconditions: Tareas must be running and the connection configuration parameters must be properly configured.
     Main success scenario:  
             1. The user clicks on the select connection type panel located in the toolbar.
             2. Tareas shows all the available connection types. 
             3. The user selects the connection type.
             4. Tasks attempts a connection to the selected database. 
             5. The connection to the dabase is completed succesfully.
             6. Tareas updates all its components according to data obtained from the database.

450px|Diagrama de secuencias de Tareas: Cambiar tipo de conexión.

2. Use case: Refresh connection.

     Main actor: User. 
     Preconditions: Tareas must be running and the connection configuration parameters must be properly configured.
     Main success scenario:  
             1. The user clicks the "Refresh" button located in the toolbar.
             2. Tareas attempts to reconnect to the selected database. 
             3. The reconnection to the dabase is completed succesfully.
             4. Tareas updates all its components according to data obtained from the database.

3. Caso de uso: Configurar herramienta.

     Actor principal: Usuario. 
     Precondiciones: Tareas debe estar en ejecución.
     Escenario de éxito principal: 
             1. El usuario pulsa sobre el botón “Configurar” situado en la barra de herramientas.
             2. Tareas muestra la ventana para introducir los parámetros de configuración de la herramienta. 

4. Caso de uso: Crear ejercicio.

     Actor principal: Usuario. 
     Precondiciones: Tareas debe estar en ejecución. 
     Escenario de éxito principal: 
             1. El usuario pulsa sobre el botón “Nuevo” de la barra de herramientas.
             2. Tareas muestra la ventana de selección del tipo de ejercicio que se quiere crear. 
             3. El usuario selecciona el tipo de ejercicio a crear y pulsa sobre el botón “Aceptar”.
             4. Tareas muestra la ventana de selección del modo de edición.
             5. El usuario selecciona el modo de edición y pulsa sobre el botón “Aceptar”.
             6. Tareas crea un nuevo ejercicio del tipo seleccionado, lo carga en su editor manual y lo muestra al usuario.

5. Caso de uso: Editar ejercicio.

     Actor principal: Usuario. 
     Precondiciones: Tareas debe estar en ejecución y el ejercicio debe existir. 
     Escenario de éxito principal: 
             1. El usuario pulsa sobre el botón “Abrir” de la barra de herramientas.
             2. Tareas muestra la ventana de selección del tipo de ejercicio que se quiere abrir. 
             3. El usuario selecciona el tipo de ejercicio a abrir.
             4. Tareas muestra a su derecha la lista de ejercicios disponibles del tipo seleccionado.
             5. El usuario selecciona el ejercicio a editar y pulsa sobre el botón “Aceptar”.
             6. Tareas abre el ejercicio seleccionado con el editor de ejercicios de ese tipo listo para su edición.

6. Caso de uso: Borrar ejercicio.

     Actor principal: Usuario. 
     Precondiciones: Tareas debe estar en ejecución y el ejercicio debe existir. 
     Escenario de éxito principal: 
             1. El usuario pulsa sobre el botón “Borrar” de la barra de herramientas.
             2. Tareas muestra la ventana de selección del tipo de ejercicio que se quiere borrar 
             3. El usuario selecciona el tipo de ejercicio a borrar.
             4. Tareas muestra a su derecha la lista de ejercicios disponibles del tipo seleccionado.
             5. El usuario selecciona el ejercicio o ejercicios a borrar y pulsa sobre el botón “Aceptar”.
             6. Tareas borra de la base de datos los ejercicios seleccionados. 
             7. Tareas muestra un mensaje de éxito al usuario.

550px|Diagrama de secuencias de Tareas: Borrar ejercicios.

7. Caso de uso: Previsualizar ejercicio.

     Actor principal: Usuario. 
     Precondiciones: Tareas debe estar en ejecución y el ejercicio que se está editando debe tener toda la información necesaria. 
     Escenario de éxito principal: 
             1. El usuario pulsa sobre el botón “Previsualizar” de la barra de herramientas inferior.
             2. Tareas carga el ejercicio que se está editando con el panel del módulo Aprendo dedicado a la reproducción de ejercicios.
             3. Aprendo comienza la ejecución del ejercicio.
             4. Tareas muestra al usuario una nueva ventana con la ejecución del ejercicio que se está editando. 
             4. El usuario pulsa el botón "Aceptar" para terminar.
             5. Tareas finaliza la reproducción del ejercicio en Aprendo y vuelve a mostrar al usuario el editor de ejercicios en el estado previo a la previsualización.

500px|Diagrama de secuencias de Tareas: Previsualizar ejercicio.

8. Caso de uso: Guardar ejercicio.

     Actor principal: Usuario. 
     Precondiciones: Tareas debe estar en ejecución y el ejercicio que se está editando debe tener toda la información necesaria. 
     Escenario de éxito principal: 
             1. El usuario pulsa sobre el botón “Guardar” de la barra de herramientas inferior.
             2. Tareas almacena el ejercicio en la base de datos seleccionada 
             3. Tareas muestra un mensaje de éxito al usuario. 

500px|Diagrama de secuencias de Tareas: Guardar ejercicio.