~~ODT~~

<PHP>
echo "<div style='display:block;float:right;'>"; 
echo "Última atualização: ";
ver('', false);
echo "</div>";
</PHP>

====== Referências ======

Este caso de uso permite ao docente disponibilizar referências para os alunos nos tópicos de aulas de suas [[desenvolvimento:especificacoes:sigaa:turma_virtual|Turmas Virtuais]].

Referência bibliográfica ou citação bibliográfica é um conjunto de elementos de uma obra escrita (como título, autor, editora, local de publicação e outras) que permite a sua identificação.

A um conjunto de referências bibliográficas, normalmente apresentadas no final de uma obra, dá-se o nome de "referências bibliográficas" ou apenas "referências".
===== Descrição do Caso de Uso =====

O caso de uso inicia quando o usuário acessa a opção //SIGAA -> Portal do Docente -> Turma Virtual -> Material -> Referências//.

Inicialmente é exibido uma listagem com os seguintes campos:
  * **__Nome__** - Nome da referência cadastrada;
  * **__Tipo__** - Tipo de referência cadastrada (Livro, Artigo, Revista, Site;
  * **__URL__** - Caso a referência possua URL, será exibido ao usuário essa referência;

Na listagem ainda é permitido que o docente //visualize//, //altere// ou //remova// as referências já existentes. Em relação a primeira opção são mostrados os campos:

Caso visualize a referência são mostrados os campos:

  * **__Descrição__***: Tipo - TEXTO. Descrição da referência cadastrada;
  * **__Tipo__**: Tipo - TEXTO. Tipo de referência cadastrada (Livro, Artigo, Revista, Site;
  * **__URL__**: Tipo - TEXTO. Caso a referência possua URL, será exibido ao usuário essa referência;
  * **__Detalhes__**: Tipo - TEXTO. Detalhes sobre a referência;
  * **__Livro__**
    * **__Autor__**: Tipo - TEXTO. 
    * **__Título__**: Tipo - TEXTO. 
    * **__Edição__**: Tipo - TEXTO. 
    * **__Ano__**: Tipo - NUMÉRICO. 
    * **__Quantidade__**: Tipo - NUMÉRICO. 
  * **__Materiais__**
    * **__Biblioteca__**: Tipo - TEXTO. 
    * **__Código de Barras__**: Tipo - TEXTO. 
    * **__Tipo de Material__**: Tipo - TEXTO. 
    * **__Coleção__**: Tipo - TEXTO. 
    * **__Status__**: Tipo - TEXTO. 
    * **__Situação__**: Tipo - TEXTO. 

Existe a opção de  //Cadastrar Referência//, que direciona o usuário a um formulário (o mesmo usado para a opção de //alterar//) de cadastro de uma nova referência, onde são apresentados os seguintes campos:

  * **Nome ou Título***: Tipo - TEXTO - Campo obrigatório que armazena a informação referente ao nome ou título da referência;
  * **Tipo***: Tipo - TEXTO - Campo obrigatório que armazena o tipo de referência cadastrada (Livro, Artigo, Revista);
  * **Endereço (URL)**: Tipo - TEXTO - Caso a referência possua algum link ou site a url pode ser informada; ([[desenvolvimento:especificacoes:sigaa:turma_virtual:casos_de_uso:menu_turma_virtual:material:referencias#Principais Regras de Negócio|RN02]])
  * **Tópico de Aula**: Tipo - TEXTO - Campo no qual deve se informar o tópico de aula que se deseja cadastrar a referência;
  * **Detalhes**: Tipo - TEXTO - Campo que fica a critério do docente cadastrar ou não mais detalhe sobre a referência;
  * **Criar em** - Tipo - TEXTO. Serve para que o docente possa informar em quais turmas ele deseja cadastrar a referência;
  * **Notificação** - Tipo - LÓGICO. Serve para caso o autor deseje enviar uma notificação para todos os alunos informado o cadastro da referência;

Caso o campo **TIPO** seja preenchido com a opção "Livro", será exibido um botão **(Pesquisar no Acervo)** para que o usuário possa pesquisar um livro no acervo da biblioteca. Ao selecionar um livro
os campos "Título" e "Detalhes" serão preenchidos automaticamente pelo sistema, e apresentarão o valor do título e detalhes do livro da biblioteca. É possível adicionar uma referência em mais de um  tópico de aula clicando no ícone "Adicionar em mais de um Tópico de Aula" ao lado.

** Modelo do e-mail enviado ao notificar os alunos sobre o cadastro de uma referência **

<code>
Assunto : Novo Material adicionado: <DESCRIÇÃO DO MATERIAL> - <CODIGO DA TURMA> - <NOME DA DISCIPLINA> - <NÚMERO DA TURMA> (<ANO/PERÍODO>)

Conteúdo:

Um novo material foi disponibilizado na(s) turma(s): <CODIGO DA TURMA> - <NOME DA DISCIPLINA> - <NÚMERO DA TURMA> (<ANO/PERÍODO>) do SIGAA

</code>

===== Principais Regras de Negócio =====

  * **RN01**: A replicação das referências pode ser realizada em qualquer disciplina sob a responsabilidade do professor.
  * **RN02**: Caso seja escolhido o tipo site, o campo Endereço (URL) se torna obrigatório.

==== Resoluções/Legislações Associadas ====

Não se Aplica.

===== Classes Persistentes e Tabelas Envolvidas =====

^ Classe ^ Tabela |
| br.ufrn.sigaa.ava.dominio.IndicacaoReferencia | sigaa.ava.indicacao_referencia |

====== Plano de Testes ======

Sistema: Sigaa

Módulo: Portal do Docente

Link: Sigaa -> Portal do Docente -> Turma Virtual (qualquer turma) -> Materiais -> Referências

Usuário: Qualquer docente, ex.: selan, paulo.pires, thais, anatalia, dgkcs (docente com título catalográfico associado a referência).

Papel que usuário deve ter: SigaaPapeis.DOCENTE 

===== Cenários de Teste =====
Selecionar mais de uma turma e verificar se a referência está sendo cadastrada nas turmas selecionadas;

Testar se uma referência estiver associada com um título catalográfico (entidade que representa um livro existente na biblioteca), as informações sobre o título catalográfico estarão aparecendo na tela de Mostrar da referência. É possível adicionar a referência a um título no seguinte caso de uso: Portal do Docente -> Ambientes Virtuais -> Turmas Virtuais -> Turmas Virtuais Abertas -> Gerenciar Plano de Curso -> Adicionar Referência

Testar se é possível cadastrar uma referência associada a um livro.

===== Dados para o Teste =====

Não se aplica.