Tareas: General part

From PatioWiki

(Difference between revisions)
Jump to: navigation, search
 
(13 intermediate revisions not shown)
Line 1: Line 1:
-
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]].
+
This section contains all the technical information relating to the part of the tool that is common to all the exercise editors that are part of [[Tareas]].
= Class diagrams =
= Class diagrams =
Line 6: Line 6:
   
   
-
[[Archivo:Tareas_diagrama_de_clases_general_es.png|700px|Diagrama de clases general.]]
+
[[File:Tareas_general_class_diagram_en.png|700px|Tareas general class diagram.]]
-
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.
+
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") and 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.
+
The class "mainToolBar", which is the main toolbar, is responsible to perform operations like creating, editing, deleting exercises or establishing the general tool configuration. To perform these operations, some panels like "ExerciseTypeSelectPanel" (to select the exercise type) or "ButtonsConnectionPanel" (to configure 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.
+
Using the "previewSaveToolBar" toolbar, you can make operations in 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.
+
The "mainToolBar" will be the same for all editors types. However, the bottom toolbar ("previewSaveToolBar") may vary depending on the exercise type and the editing mode you are using.
Line 23: Line 23:
-
[[Archivo:Tareas_diagrama_casos_de_uso_general_es.png|600px|Diagrama general de casos de uso de Tareas.]]
+
[[File:Tareas_general_use_cases_diagram_en.png‎ |600px|General use case diagram of Tareas.]]
-
Will be followed by a textual description of the general use cases of [[Tasks]].
+
Next, there is a textual description of the general use cases of [[Tareas]].
-
Next a textual description of the use cases will be shown.
+
-
'''1. Caso de uso: '''Cambiar tipo de conexión.  
+
'''1. Use case: '''Change connection type.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Tareas debe estar en ejecución y los parámetros de configuración de la conexión han de estar correctamente configurados.
+
       '''Preconditions: '''Tareas must be running and the connection configuration parameters must be properly configured.
-
       '''Escenario de éxito principal: '''  
+
       '''Main success scenario: '''  
-
               1. El usuario pulsa sobre el panel de selección del tipo de conexión situado en la barra de herramientas.
+
               1. The user clicks on the select connection type panel located in the main toolbar.
-
               2. Tareas muestra los tipos de conexión disponibles.  
+
               2. Tareas shows all the available connection types.  
-
               3. El usuario selecciona el tipo de conexión.
+
               3. The user selects the connection type.
-
               4. Tareas intenta realizar una conexión a la base de datos seleccionada
+
               4. Tareas attempts a connection to the selected database.
-
               5. Se realiza con éxito la conexión a la base de datos.
+
               5. The connection to the dabase is succesfully completed.
-
               6. Tareas actualiza todos sus componentes de acuerdo a los datos que se obtienen de la base de datos.
+
               6. Tareas updates all its components according to the data obtained from the database.
-
[[Archivo:Tareas_diagrama_secuencias_cambiar_tipo_conexion_es.png‎|450px|Diagrama de secuencias de Tareas: Cambiar tipo de conexión.]]
+
[[File:Tareas_general_sequence_diagram_change_connection_type_en.png‎|450px|Sequence diagram: Change connection type.]]
-
'''2. Caso de uso: '''Refrescar conexión.  
+
'''2. Use case: '''Refresh connection.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Tareas debe estar en ejecución y los parámetros de configuración de la conexión han de estar correctamente configurados.
+
       '''Preconditions: '''Tareas must be running and the connection configuration parameters must be properly configured.
-
       '''Escenario de éxito principal: '''  
+
       '''Main success scenario: '''  
-
               1. El usuario pulsa sobre el botón “Refrescar” situado en la barra de herramientas.
+
               1. The user clicks the "Refresh" button located in the main toolbar.
-
               2. Tareas intenta realizar una reconexión a la base de datos seleccionada.
+
               2. Tareas attempts to reconnect to the selected database.  
-
               3. Se realiza con éxito la reconexión a la base de datos.
+
               3. The reconnection to the dabase is succesfully completed.
-
               4. Tareas actualiza todos sus componentes de acuerdo a los datos que se obtienen de la base de datos.
+
               4. Tareas updates all its components according to the data obtained from the database.
-
'''3. Caso de uso: '''Configurar herramienta.  
+
'''3. Use case: '''Configure the tool.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Tareas debe estar en ejecución.
+
       '''Preconditions: '''Tareas must be running.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa sobre el botón “Configurar” situado en la barra de herramientas.
+
               1. The user clicks the "Configure" button located in the main toolbar.
-
               2. Tareas muestra la ventana para introducir los parámetros de configuración de la herramienta.  
+
               2. Tareas shows the window that allows to set the configuration parameters of the tool.  
-
'''4. Caso de uso: '''Crear ejercicio.  
+
'''4. Use case: '''Create new exercise.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Tareas debe estar en ejecución.  
+
       '''Preconditions: '''Tareas must be running.  
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa sobre el botón “Nuevo” de la barra de herramientas.
+
               1. The user clicks the "New" button located in the main toolbar.
-
               2. Tareas muestra la ventana de selección del tipo de ejercicio que se quiere crear.  
+
               2. Tareas shows the exercise type selection window.  
-
               3. El usuario selecciona el tipo de ejercicio a crear y pulsa sobre el botón “Aceptar”.
+
               3. The user selects the exercise type that he wants to create and presses the "Ok" button.
-
               4. Tareas muestra la ventana de selección del modo de edición.
+
               4. Tareas shows the window that allows to select the edition mode.
-
               5. El usuario selecciona el modo de edición y pulsa sobre el botón “Aceptar”.
+
               5. The user selects the edition mode and presses the "Ok" button.
-
               6. Tareas crea un nuevo ejercicio del tipo seleccionado, lo carga en su editor manual y lo muestra al usuario.
+
               6. Tareas creates a new exercise of the selected type, loads it into the appropiate manual editor and shows it to the user.
-
'''5. Caso de uso: '''Editar ejercicio.  
+
'''5. Use case: '''Edit exercise.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Tareas debe estar en ejecución y el ejercicio debe existir.  
+
       '''Preconditions: '''Tareas must be running and the exercise must exists.  
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa sobre el botón “Abrir” de la barra de herramientas.
+
               1. The user clicks the "Open" button located in the main toolbar.
-
               2. Tareas muestra la ventana de selección del tipo de ejercicio que se quiere abrir.  
+
               2. Tareas shows the exercise type selection window.  
-
               3. El usuario selecciona el tipo de ejercicio a abrir.
+
               3. The user selects the exercise type that he wants to edit and presses the "Ok" button.
-
               4. Tareas muestra a su derecha la lista de ejercicios disponibles del tipo seleccionado.
+
               4. Tareas shows the available exercises of the selected type.
-
               5. El usuario selecciona el ejercicio a editar y pulsa sobre el botón “Aceptar”.
+
               5. The user selects the exercise and presses the "Ok" button.
-
               6. Tareas abre el ejercicio seleccionado con el editor de ejercicios de ese tipo listo para su edición.
+
               6. Tareas opens the selected exercise using the manual exercise editor for the selected type, ready for its edition.
-
'''6. Caso de uso: '''Borrar ejercicio.  
+
'''6. Use case: '''Delete exercise.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Tareas debe estar en ejecución y el ejercicio debe existir.  
+
       '''Preconditions: '''Tareas must be running and the exercise must exists.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa sobre el botón “Borrar” de la barra de herramientas.
+
               1. The user clicks the "Delete" button located in the main toolbar.
-
               2. Tareas muestra la ventana de selección del tipo de ejercicio que se quiere borrar
+
               2. Tareas shows the exercise type selection window.
-
               3. El usuario selecciona el tipo de ejercicio a borrar.
+
               3. The user selects the exercise type that he wants to remove and presses the "Ok" button.
-
               4. Tareas muestra a su derecha la lista de ejercicios disponibles del tipo seleccionado.
+
               4. Tareas shows the available exercises of the selected type.
-
               5. El usuario selecciona el ejercicio o ejercicios a borrar y pulsa sobre el botón “Aceptar”.
+
               5. The user selects the exercise/s and presses the "Ok" button.
-
               6. Tareas borra de la base de datos los ejercicios seleccionados.  
+
               6. Tareas shows a confirm message before continuing the process.
-
               7. Tareas muestra un mensaje de éxito al usuario.
+
               7. The user presses the "Ok" button to confirm and the process continues.
 +
              8. Tareas removes the selected exercises from the database.
 +
              9. Tareas shows a success message to the user.
-
[[Archivo:Tareas_diagrama_secuencias_borrar_ejercicios_es.png‎|550px|Diagrama de secuencias de Tareas: Borrar ejercicios.]]
+
[[File:Tareas_general_sequence_diagram_delete_exercises_en.png‎‎|550px|Sequence diagram: Delete exercises.]]
-
'''7. Caso de uso: '''Previsualizar ejercicio.  
+
'''7. Use case: '''Preview exercise.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Tareas debe estar en ejecución y el ejercicio que se está editando debe tener toda la información necesaria.  
+
       '''Preconditions: '''Tareas must be running and the exercise that is being edited must has all the required information.  
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa sobre el botón “Previsualizar” de la barra de herramientas inferior.
+
               1. The user clicks the "Preview" button located in the lower toolbar.
-
               2. Tareas carga el ejercicio que se está editando con el panel del módulo [[Aprendo]] dedicado a la reproducción de ejercicios.
+
               2. Tareas loads the exercise that is being edited with the [[Aprendo]] module panel that allows the exercise reproduction.
-
               3. [[Aprendo]] comienza la ejecución del ejercicio.
+
               3. [[Aprendo]] starts the exercise reproduction.
-
               4. Tareas muestra al usuario una nueva ventana con la ejecución del ejercicio que se está editando.  
+
               4. Tareas displays a new window with the reproduction of the exercise that is being edited.
-
               4. El usuario pulsa el botón "Aceptar" para terminar.
+
               4. The user presses the "Ok" button to finish.
-
               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.
+
               5. Tareas ends the exercise reproduction at [[Aprendo]] and returns to the exercise editor in the state it had before the preview.
   
   
 +
[[File:Tareas_general_sequence_diagram_preview_exercise_en.png‎ ‎|500px|Sequence diagram: Preview exercise.]]
-
[[Archivo:Tareas_diagrama_secuencias_previsualizar_ejercicio_es.png‎|500px|Diagrama de secuencias de Tareas: Previsualizar ejercicio.]]
 
 +
'''8. Use case: '''Save exercise.
 +
      '''Main actor: '''User.
 +
      '''Preconditions: '''Tareas must be running and the exercise that is being edited must has all required information.
 +
      '''Main success scenario: '''
 +
              1. The user clicks the "Save" button located in the lower toolbar.
 +
              2. Tareas shows a confirm message before continuing the process.
 +
              3. The user presses the "Ok" button and the save process continues.
 +
              4. Tareas saves the exercise in the selected database.
 +
              5. Tareas shows a success message to the user.
-
'''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.
 
-
 
+
[[File:Tareas_general_sequence_diagram_save_exercise_en.png|500px|Sequence diagram: Save exercise.]]
-
[[Archivo:Tareas_diagrama_secuencias_guardar_ejercicio_es.png|500px|Diagrama de secuencias de Tareas: Guardar ejercicio.]]
+
[[Category: Tareas]]
[[Category: Tareas]]

Current revision as of 09:52, 10 November 2011

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

Class diagrams

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


Tareas general class diagram.


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") and 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 creating, editing, deleting exercises or establishing the general tool configuration. To perform these operations, some panels like "ExerciseTypeSelectPanel" (to select the exercise type) or "ButtonsConnectionPanel" (to configure the tool) can be shown to the user.

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

The "mainToolBar" will be the same for all editors types. However, the bottom toolbar ("previewSaveToolBar") 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.


General use case diagram of 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 main toolbar.
             2. Tareas shows all the available connection types. 
             3. The user selects the connection type.
             4. Tareas attempts a connection to the selected database. 
             5. The connection to the dabase is succesfully completed.
             6. Tareas updates all its components according to the data obtained from the database.


Sequence diagram: Change connection type.


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 main toolbar.
             2. Tareas attempts to reconnect to the selected database. 
             3. The reconnection to the dabase is succesfully completed.
             4. Tareas updates all its components according to the data obtained from the database.

3. Use case: Configure the tool.

     Main actor: User. 
     Preconditions: Tareas must be running.
     Main success scenario: 
             1. The user clicks the "Configure" button located in the main toolbar.
             2. Tareas shows the window that allows to set the configuration parameters of the tool. 

4. Use case: Create new exercise.

     Main actor: User. 
     Preconditions: Tareas must be running. 
     Main success scenario: 
             1. The user clicks the "New" button located in the main toolbar.
             2. Tareas shows the exercise type selection window. 
             3. The user selects the exercise type that he wants to create and presses the "Ok" button.
             4. Tareas shows the window that allows to select the edition mode.
             5. The user selects the edition mode and presses the "Ok" button.
             6. Tareas creates a new exercise of the selected type, loads it into the appropiate manual editor and shows it to the user.

5. Use case: Edit exercise.

     Main actor: User. 
     Preconditions: Tareas must be running and the exercise must exists. 
     Main success scenario: 
             1. The user clicks the "Open" button located in the main toolbar.
             2. Tareas shows the exercise type selection window. 
             3. The user selects the exercise type that he wants to edit and presses the "Ok" button.
             4. Tareas shows the available exercises of the selected type.
             5. The user selects the exercise and presses the "Ok" button.
             6. Tareas opens the selected exercise using the manual exercise editor for the selected type, ready for its edition.

6. Use case: Delete exercise.

     Main actor: User. 
     Preconditions: Tareas must be running and the exercise must exists.
     Main success scenario: 
             1. The user clicks the "Delete" button located in the main toolbar.
             2. Tareas shows the exercise type selection window. 
             3. The user selects the exercise type that he wants to remove and presses the "Ok" button.
             4. Tareas shows the available exercises of the selected type.
             5. The user selects the exercise/s and presses the "Ok" button.
             6. Tareas shows a confirm message before continuing the process.
             7. The user presses the "Ok" button to confirm and the process continues.
             8. Tareas removes the selected exercises from the database. 
             9. Tareas shows a success message to the user.


Sequence diagram: Delete exercises.


7. Use case: Preview exercise.

     Main actor: User. 
     Preconditions: Tareas must be running and the exercise that is being edited must has all the required information. 
     Main success scenario: 
             1. The user clicks the "Preview" button located in the lower toolbar.
             2. Tareas loads the exercise that is being edited with the Aprendo module panel that allows the exercise reproduction.
             3. Aprendo starts the exercise reproduction.
             4. Tareas displays a new window with the reproduction of the exercise that is being edited.
             4. The user presses the "Ok" button to finish.
             5. Tareas ends the exercise reproduction at Aprendo and returns to the exercise editor in the state it had before the preview.

Sequence diagram: Preview exercise.


8. Use case: Save exercise.

     Main actor: User. 
     Preconditions: Tareas must be running and the exercise that is being edited must has all required information. 
     Main success scenario: 
             1. The user clicks the "Save" button located in the lower toolbar.
             2. Tareas shows a confirm message before continuing the process.
             3. The user presses the "Ok" button and the save process continues.
             4. Tareas saves the exercise in the selected database. 
             5. Tareas shows a success message to the user.


Sequence diagram: Save exercise.

Personal tools