Module sintra_6_1_1_0-sintra.usuario

Módulo de definição do objeto usuario para obtenção de dados de usuários pelos webservices do SAU e do SGU.


O módulo oferece um pequeno conjunto de funções para criar objetos que representam usuários. Para criá-los é necessário saber o tipo do usuário, que pode ser aluno, professor ou funcionário, e sua matrícula. Esta função retorna um objeto que obtém dados do SAU e do SGU por demanda, através de WebServices diversos.

Os objetos possuem os métodos iter() e get_by_tag(tag), este último que serve para obter dados que talvez não estejam mapeados em campos.

Todos os objetos guardam o atributo _resultado_ com a estrutura LOM obtida na última requisição realizada pelo objeto.

Functions

user:iter (self) Itera sobre todos os campos mapeáveis do objeto (carregando seus valores, se necessário).
user:get_by_tag (self, tag) Obtém o valor associado a um dado tag do resultado da última requisição feita pelo objeto.
usuario (matricula, _, prof) Cria o objeto usuario.
aluno (matricula) Cria um objeto que representa um aluno.
professor (matricula) Cria um objeto que representa um professor.
funcionario (matricula) Cria um objeto que representa um funcionário.


Functions

user:iter (self)
Itera sobre todos os campos mapeáveis do objeto (carregando seus valores, se necessário).

Parameters:

  • self Objeto usuário.

Returns:

    Iterador que percorre todos os campos mapeáveis do objeto, forçando-os a serem carregados e retornando-os (campo, valor).
user:get_by_tag (self, tag)
Obtém o valor associado a um dado tag do resultado da última requisição feita pelo objeto.

Parameters:

  • self Objeto usuário.
  • tag String com o nome do tag do elemento XML.

Returns:

    String com o valor correspondente ao elemento XML de tag dado.

Usage:

    user:get_by_tag"codHabilitacao" == user.habilitacao
usuario (matricula, _, prof)
Cria o objeto usuario. Utiliza um cache para reaproveitar objetos já criados.

Parameters:

  • matricula String com a matrícula do usuário
  • _ String com a senha não encriptada !NAO USADO!!CODIGO LEGADO!!
  • prof Booleano indicando se o usuário é professor/funcionário

Returns:

    Objeto usuario, que ``contém'' os campos: nome cpf data_nasc email curso nivel (graduacao, mestrado, doutorado, aperfeicoamento) prog_ou_dpto
aluno (matricula)
Cria um objeto que representa um aluno.

Parameters:

  • matricula String com a matrícula.

Returns:

    Objeto usuário.
professor (matricula)
Cria um objeto que representa um professor.

Parameters:

  • matricula String com a matrícula.

Returns:

    Objeto usuário.
funcionario (matricula)
Cria um objeto que representa um funcionário.

Parameters:

  • matricula String com a matrícula.

Returns:

    Objeto usuário.
generated by LDoc 1.4.6 Last updated 2024-09-26 20:37:35