O cabeçalho de documentação de um pacote deve ser adicionado à sua especificação, enquanto os cabeçalhos das funções e procedimentos individuais que ele agrupa devem ser adicionados às suas próprias definições no corpo do pacote.

Devem ser documentadas como alterações no cabeçalho do pacote somente aquelas que afetem sua especificação: inclusão de novos procedimentos e funções ou alterações em suas "assinaturas". As demais alterações devem ser documentadas nos cabeçalhos dos objetos individuais.

Nome: (Por extenso de forma a descrever cada sigla utilizada para formar o nome da package.)

Esquema: (Nome do esquema proprietário da package.)

Sistema proprietário: (Sistema que cria e mantém a package.)

Área gestora do sistema: (Área responsável pelo sistema.)

Área gestora da informação: (Área responsável pela informação.)

Funcionalidades agrupadas:

Sistemas usuários: (Sistemas que utilizam a package.)

Autor:                                                               Data de criação:

Autor da alteração:                                      Data de alteração:

Finalidade da alteração:

Descrição da alteração:

Exemplo: documentação sugerida para o pacote JUDICIARIO.PKG_CONSULTA_PROCESSUAL.

Nome: JUDICIARIO.PKG_CONSULTA_PROCESSUAL(package de consulta processual).

Esquema: JUDICIARIO

Sistema proprietário: Portal do Processo Eletrônico.

Área gestora do sistema: SSPJ

Área gestora da informação: Secretaria Judiciária.

Funcionalidades agrupadas: Este pacote agrupa as funções que recuperam informações processuais para o Portal do Processo Eletrônico. Segue a lista dessas funções:

  FNC_RECURSO_INCIDENTE - função que recupera os recursos de um incidente retornando um XML.

  FNC_ORIGEM_INCIDENTE - função que recupera a origem de um incidente retornando um XML.

  FNC_DESLOCAMENTO_INCIDENTE - função que recupera os deslocamentos de um incidente retornando um XML.

  FNC_ANDAMENTO_INCIDENTE - função que recupera os andamentos de um incidente retornando um XML.

  FNC_ASSUNTO_INCIDENTE - função que recupera o assunto de um incidente retornando um XML.

  FNC_TIPO_INCIDENTE - função que retorna o tipo de um objeto incidente.

  FNC_PETICAO_INCIDENTE - função que recupera as petições de um incidente retornando um XML.

  FNC_INCIDENTE_NUMERO - função que recupera os incidentes a partir de um número de petição, processo e protocolo retornando um XML.

  FNC_INCIDENTE_ORIGEM - função que recupera um incidente a partir de seu número de origem retornando um XML.

  FNC_CLASSE - função que recupera as classes processuais retornando um XML.

  FNC_PECA_INCIDENTE - função que recupera as peças públicas de um incidente retornando um XML.

  FNC_DESCRICAO_CADEIA - função que retorna a descrição da cadeia de um incidente.

  FNC_SIGLA_CADEIRA - função que retorna a sigla da cadeia de um incidente.

  FNC_LIMINAR_INCIDENTE - função que retorna 'S' se existir uma liminar para um incidente e 'N' caso não exista.

  FNC_OBTER_PECA - função que recupera a peça do processo eletrônico partir do campo SEQ_PECA_PROC_ELETRONICO retornando um binário.

  FNC_JURISDICIONADO_FONETICA - função que realiza a pesquisa fonética de jurisdicionado retornando um XML.

  FNC_JURISDICIONADO_INCIDENTE - função que recupera os jurisdicionados (partes) de um incidente, bem como seu papel (categoria) e o tipo de impressão retornando um XML.

  FNC_REDATOR_INCIDENTE - função que recupera o redator de um incidente retornando um XML.

  FNC_RELATOR_INCIDENTE - função que recupera o relator de um incidente retornando um XML.

  FNC_RETORNA_PECAS_ANDAMENTO - função que recupera as peças de um andamento do processo retornando um XML.

  FNC_RETORNA_DEPENDENCIA_ANDMTO - função que recupera a dependência de processos e protocolos retornando um XML.

  FNC_RETORNA_NUMERO_PETICAO - função que recupera uma petição a partir de um andamento do processo retornando um XML.

  FNC_PROTOCOLO - função que recupera as informações de um protocolo retornando um XML.

  FNC_PROCESSO - função que recupera as informações de um processo de acordo com os parâmetros retornando um XML.

  FNC_PROCESSO_DATA_ANDAMENTO - função que recupera os incidentes de determinada data de andamento retornando um cursor de incidentes.

  FNC_PROCESSO_DATA_AND_XML - função que recupera os incidentes de determinada data de andamento retornando um XML.

  FNC_RETORNA_JURISDICIONADO - função que recupera o jurisdicionado de uma lista retornando o código da parte.

  FNC_INCIDENTE_JURISDICIONADO - função que recupera os jurisdicionados de um incidente e retorna um XML.

  FNC_INCIDENTE_NUMERO_UNICO - função que recupera o incidente a partir do número único retornando um XML.

  FNC_INCIDENTE_PECAS - função que recupera todas as peças de todos os incidentes de um incidente principal, verificando se o jurisdicionado é parte e a confidencialidade do processo e retornando um XML.

Sistemas usuários: Portal do Processo Eletrônico.

Autor: Luiz Victor                Data de criação: 14/06/2010

Autor da alteração:             Data de alteração:

Finalidade da alteração:

Descrição da alteração: