Module botoes.default
"Classe" de botões de ação
Functions
| disponivel () | Método que indica se um botão está disponível no contexto. |
| anular_cobranca (conn, id_processo) | Anula a cobrança correspondente ao processo indicado (se esta tiver sido emitida). |
| gerar_nova_cobranca (conn, id_processo, valor) | Gera uma nova cobrança baseada no valor de um campo do processo |
| salvar (conn, dados, id_usuario) | Ação de gravação dos dados. |
| confirmar (conn, dados, id_usuario) | Ação de confirmação. |
| layout () | Produz o texto HTML que define o botão. |
| show_help (_, t) | Método usado para gerar explicações sobre os campos. |
| confirmar_e_gerar_pdf (conn, dados, id_usuario) | O id_lua do campo que guarda os arquivos deve ser 'docs_originais' ou 'docs_originais_recurso'. |
| botao_desabilitado (_, classe, titulo, dica) | Botão desabilitado |
| trata_erro_ws (tipo_pagina, params, url, err) | TODO Copiada do saida.lua. |
| converte_candidato (conn, dados, id_usuario) | Converte uma conta de Quasi-aluno em Aluno, corrigindo e atualizando o que for preciso, no banco de dados. |
Functions
- disponivel ()
- Método que indica se um botão está disponível no contexto. A existencia do id_botao_pressionado indica que é uma tela de confirmação; portanto, só o próprio botão pressionado pode aparecer.
- anular_cobranca (conn, id_processo)
-
Anula a cobrança correspondente ao processo indicado (se esta tiver sido emitida).
Parameters:
- conn Objeto de conexão com o banco
- id_processo Identificação do processo (string ou número).
- gerar_nova_cobranca (conn, id_processo, valor)
-
Gera uma nova cobrança baseada no valor de um campo do processo
Parameters:
- conn Objeto de conexão com o banco
- id_processo Identificação do processo (string ou número).
- valor String com o id_lua do campo que contém o valor.
Returns:
- String com o novo boleto, ou nil, em caso de erro.
- String com a data de vencimento ou mensagem de erro, se houver.
- salvar (conn, dados, id_usuario)
-
Ação de gravação dos dados.
Parameters:
- conn Objeto de conexão com o banco.
- dados Tabela com os dados do requerimento (id_processo é obrigatório).
- id_usuario Identificador do usuário.
Returns:
-
Identificador do requerimento.
- confirmar (conn, dados, id_usuario)
-
Ação de confirmação.
Parameters:
- conn Objeto de conexão com o banco.
- dados Tabela com dados do requerimento (id_processo é obrigatório).
- id_usuario Identificador do usuário.
Returns:
- Booleano indicando se a alteração foi efetuada (pode ser o número do boleto, caso este tenha sido gerado agora).
- String com uma mensagem de erro (se houver).
- layout ()
-
Produz o texto HTML que define o botão.
Quando o atributo id_botao_pressionado existir, é uma tela de confirmação,
então apenas o botão com esse id_campo será exibido.
Além disso, um botão "Editar" também é montado, para funcionar como um
"Cancelar", ou "Back". Ele pode ser definido através dos atributos:
- self.proc.script_origem (URL de destino do botão Editar)
- self.proc.params_editar (parâmetros repassados pelo botão)
Returns:
-
String com código HTML com a definição do botão (ou dois, caso
seja uma tela de confirmação).
- show_help (_, t)
-
Método usado para gerar explicações sobre os campos.
Parameters:
- _
- t
Returns:
-
String com código HTML representando uma linha com duas colunas.
- confirmar_e_gerar_pdf (conn, dados, id_usuario)
-
O id_lua do campo que guarda os arquivos deve ser 'docs_originais' ou
'docs_originais_recurso'. Os botões correspondentes devem ter id_luas
correspondentes (mas diferentes!), então podem ser 'DOCS_originais' ou
'DOCS2_originais' ou 'DOCS_originais_recurso'.
Parameters:
- conn
- dados
- id_usuario Roda o método default primeiro para forçar a gravar os dados do formulário, especialmente o(s) arquivo(s) enviado(s) local id_processo, err = default.salvar (self, conn, dados, id_usuario)
- botao_desabilitado (_, classe, titulo, dica)
-
Botão desabilitado
Parameters:
- _
- classe
- titulo
- dica
- trata_erro_ws (tipo_pagina, params, url, err)
-
TODO Copiada do saida.lua. Resolver aonde colocar essa função!!
Apresenta mensagem para o usuário e avisa à equipe sobre erro de timeout ou
connection refused em um dos webservices.
Parameters:
- tipo_pagina String com o tipo de informação que apareceria na página.
- params Tabela com nome(s) do(s) campo(s) e valor(es) passados para o webservice.
- url String com a URL obtida do webservice.
- err String com o erro retornado pelo webservice.
- converte_candidato (conn, dados, id_usuario)
-
Converte uma conta de Quasi-aluno em Aluno, corrigindo e atualizando
o que for preciso, no banco de dados.
Parameters:
- conn
- dados
- id_usuario