Wiki**3 - User contributions [en]

File:Po-uilib-202608310000.tar.bz2

2026-08-26T15:03:04Z

Root:

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T14:04:02Z

Root: /* Menu Principal */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

'''EM PREPARAÇÃO'''

'''ÉPOCA NORMAL'''

O objectivo do projecto é desenvolver um sistema de gestão de entregas rápidas de produtos (ERP — Express Retail Platform). O sistema deverá permitir, entre outras operações, (i) registar dados de empresas; (ii) registar dados de clientes; (iii) registar, gerir e pesquisar produtos; (iv) efectuar e gerir características de compras; (v) gerir as entregas correspondentes; e (vi) notificar os clientes sobre a situação das suas encomendas.

Neste texto, o tipo '''negrito''' indica um literal (i.e., é exactamente como apresentado); o símbolo ␣ indica um espaço; e o tipo ''itálico'' indica uma parte variável (i.e., uma descrição).

= Conceitos e Relações do Modelo =

Existem vários conceitos importantes neste contexto: [[#Empresas|empresas]], [[#Produtos|produtos]], [[#Clientes|clientes]], [[#Transportadoras|transportadoras]], [[#Cabaz de Compras|cabazes]], [[#Compras|compras]], [[#Divisão das Compras em Encomendas|encomendas]] e [[#Entregas|entregas]].

Os conceitos listados não são os únicos possíveis no modelo e as suas relações (assim como relações com outros conceitos não mencionados) podem depender das escolhas do projecto.

Os clientes e os produtos são independentes das empresas: existem por si e podem relacionar-se com várias empresas. Cada empresa, no entanto, mantém registo dos clientes com quem interage, dos produtos que disponibiliza, das compras feitas e das encomendas que expede.

Uma compra representa a aquisição de produtos por um cliente a uma empresa, e resulta de finalizar um [[#Cabaz de Compras|cabaz]]. Uma compra pode dar origem a uma ou mais encomendas, de acordo com a estratégia de divisão de encomendas utilizada.

Cada encomenda pode ser enviada através de uma determinada transportadora e pode incluir serviços adicionais que alteram o seu custo e/ou prazo de entrega.

== Produtos ==

O sistema mantém um registo global de produtos. Cada produto é identificado por um número de produto. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Todos os produtos têm: um nome/descrição (cadeia de caracteres não vazia); um preço base (número inteiro positivo); uma categoria; e um prazo de entrega base (número inteiro de dias).

O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O sistema utiliza o preço base para calcular o preço recomendado do produto. O preço recomendado representa o valor de referência do produto no sistema. O seu cálculo pode depender do tipo de produto e de outras informações disponíveis no sistema.

Cada produto tem uma categoria, de acordo com a sua natureza. Inicialmente, consideram-se as seguintes categorias: (i) alimentar; (ii) electrónica; e (iii) vestuário. Deve ser possível adicionar novas categorias com impacto mínimo na aplicação já desenvolvida.

O produto existe independentemente das empresas que o disponibilizam. Assim, o mesmo produto pode ser disponibilizado por várias empresas, sendo possível que cada uma pratique um preço de venda diferente.

A informação relativa à disponibilização de um produto por uma empresa não deve ser considerada parte das características intrínsecas do produto.

== Tipos de Produto ==

Todos os produtos considerados no sistema são fabricados, mas podem ter diferentes origens.

Inicialmente, consideram-se os seguintes tipos de produto:
* produto nacional;
* produto importado.

Um produto nacional possui apenas as propriedades gerais dos produtos.

Um produto importado possui, para além das propriedades gerais dos produtos:
* um país de origem (cadeia de caracteres não vazia);
* uma taxa alfandegária (número inteiro expressando uma percentagem);
* um prazo de transporte internacional (número inteiro de dias).

O preço recomendado é calculado de forma diferente consoante o tipo de produto.

Deve ser possível introduzir novos tipos de produto com impacto mínimo na implementação desenvolvida.

=== Produtos Nacionais ===

Para um produto nacional, o preço recomendado depende do preço base e do número total de unidades actualmente disponíveis desse produto nas empresas que o disponibilizam.

Se o número total de unidades disponíveis for:
* superior a 10000, o preço recomendado corresponde a 90% do preço base;
* inferior a 100, o preço recomendado corresponde a 130% do preço base;
* nos restantes casos, o preço recomendado corresponde ao preço base.

Por exemplo, considerando um produto nacional com preço base de 100 euros:
* Unidades disponíveis = 50 => Preço recomendado = 130 euros;
* Unidades disponíveis = 5000 => Preço recomendado = 100 euros;
* Unidades disponíveis = 12000 => Preço recomendado = 90 euros.

=== Produtos Importados ===

Para um produto importado, o preço recomendado corresponde ao preço base acrescido da taxa alfandegária.

Se a taxa alfandegária for '''t%''', o preço recomendado é calculado de acordo com:

'''preço base × (100 + t) / 100'''

Por exemplo, considerando um produto importado com preço base de 100 euros e uma taxa alfandegária de 20%, o preço recomendado será:

'''100 × (100 + 20) / 100 = 120 euros'''

O cálculo do preço recomendado deve ser realizado de forma polimórfica, de modo a que o código que utiliza produtos não tenha de conhecer explicitamente o tipo concreto de cada produto.

== Empresas ==

O sistema mantém um registo das empresas que operam na plataforma. Cada empresa é identificada por um número de empresa. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada empresa tem ainda um nome (cadeia de caracteres não vazia).

Uma empresa pode disponibilizar vários produtos e cada produto pode ser disponibilizado por várias empresas.

Para cada produto que disponibiliza, a empresa deve manter informação sobre:
* número de unidades disponíveis (valor inteiro);
* factor multiplicativo do preço recomendado (número positivo).

O número de unidades disponíveis e o factor multiplicativo podem ser diferentes para cada empresa que disponibiliza o mesmo produto.

O factor multiplicativo permite que uma empresa pratique um preço de venda diferente do preço recomendado pelo sistema. O preço de venda de um produto pela empresa é calculado multiplicando o preço recomendado do produto pelo factor multiplicativo definido pela empresa. Assim, duas empresas podem disponibilizar o mesmo produto a preços diferentes e com quantidades diferentes em stock.

Por exemplo, o produto P1, com um preço recomendado de 100 euros, pode ser disponibilizado pela empresa A com um preço de 90 euros, através de um factor multiplicativo de 0,9. A empresa B pode disponibilizar o mesmo produto com um preço de 120 euros, através de um factor multiplicativo de 1,2.

Deve ser possível adicionar outras propriedades às empresas sem impacto significativo no código já desenvolvido.

== Clientes ==

O sistema mantém um registo de clientes. Cada cliente é identificado por um número de cliente. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada cliente tem ainda informação sobre o seu nome e endereço de correio electrónico. Estes campos não podem ser vazios.

Assume-se que os clientes têm sempre dinheiro, i.e., uma compra nunca é recusada por falta de fundos.

== Compras ==

O sistema regista as compras efectuadas pelos clientes. Cada compra é identificada por um número de compra, atribuído automaticamente e incrementalmente. Uma compra é sempre feita por um único cliente a uma única empresa numa determinada data.

Uma compra é constituída por um conjunto de linhas (um "cabaz"). Cada linha corresponde a:
* um produto;
* uma quantidade (número de exemplares adquiridos desse produto);
* um preço unitário (o preço de venda do produto pela empresa no momento da compra);
* um preço total da linha (quantidade × preço unitário).

O preço unitário utilizado numa compra deve ser guardado na própria linha da compra. Alterações posteriores ao preço base, ao preço recomendado, ao factor multiplicativo da empresa, ou a qualquer outra propriedade utilizada no cálculo do preço, não devem alterar o valor de compras já efectuadas.

O preço total dos itens de uma compra é a soma dos preços totais das suas linhas. Uma compra pode dar origem a uma ou mais encomendas, de acordo com uma estratégia de divisão de encomendas.

A divisão de uma compra em várias encomendas pode ter impacto no custo total da compra.

== Cabaz de Compras ==

Antes de dar origem a uma compra, os produtos que um cliente pretende adquirir a uma empresa são acumulados num '''cabaz'''.

Cada cliente tem um cabaz por cada empresa em que compra. O cabaz é constituído por um conjunto de linhas; cada linha corresponde a um produto disponibilizado por essa empresa e a uma quantidade. Acrescentar ao cabaz um produto que já lá esteja acumula as quantidades.

O cabaz regista ainda as opções que serão aplicadas à compra:
* a [[#Divisão das Compras em Encomendas|estratégia de divisão em encomendas]]; * a [[#Transportadoras|transportadora]] e a [[#Transportadoras|modalidade de transporte]]; e
* o conjunto de [[#Serviços Adicionais|serviços adicionais]].

A transportadora, a modalidade e os serviços adicionais escolhidos aplicam-se a '''todas''' as encomendas resultantes da compra.

Enquanto não for finalizado, o cabaz não tem qualquer efeito no resto do sistema: em particular, não reserva nem consome inventário, e os preços apresentados são sempre os preços de venda praticados pela empresa '''nesse momento'''. Um cabaz faz parte do estado persistente da aplicação: pode ser abandonado e retomado mais tarde.

Ao '''finalizar''' o cabaz, e apenas nesse momento:
* os preços de venda são fixados nas linhas da compra;
* a compra é dividida em encomendas de acordo com a estratégia registada no cabaz;
* todas as encomendas recebem a modalidade de transporte e os serviços adicionais registados no cabaz;
* o inventário dos produtos na empresa é decrementado e o cliente é debitado;
* o cabaz fica vazio.

Um cabaz vazio não pode ser finalizado, nem o pode ser um cabaz em que ainda não tenham sido escolhidas transportadora e modalidade. Se, no momento de finalizar, a empresa já não tiver exemplares suficientes de algum dos produtos do cabaz (por exemplo, porque o inventário foi entretanto alterado), a operação falha sem qualquer efeito e o cabaz mantém-se intacto.

== Divisão das Compras em Encomendas ==

Cada encomenda tem um custo base de processamento e expedição, de '''5 euros'''. Assim, uma compra dividida em várias encomendas pode ter um custo superior ao de uma compra enviada numa única encomenda.

O custo base associado às encomendas corresponde ao número de encomendas multiplicado pelo custo base de uma encomenda.

A este custo podem acrescer os custos associados ao método de transporte seleccionado e aos serviços adicionais.

O custo total de uma compra corresponde, assim, ao custo dos produtos acrescido:
* do custo base das encomendas;
* dos custos adicionais das tarifas de transporte;
* dos custos dos serviços adicionais seleccionados.

A forma como uma compra é dividida em encomendas é determinada por uma estratégia de divisão de encomendas. Inicialmente, devem ser suportadas, pelo menos, as seguintes estratégias: encomenda única ('''UNICA''') e agrupamento por prazo de entrega ('''PRAZO''').

=== Encomenda única ===

Todos os produtos da compra são colocados numa única encomenda.

Neste caso, a compra origina uma única encomenda, independentemente dos prazos de entrega dos produtos.

=== Agrupamento por prazo de entrega ===

Os produtos são agrupados de acordo com os seus prazos de entrega.

Calcula-se a média dos prazos de entrega dos produtos das linhas da compra:
* todas as linhas cujo produto tem prazo menor ou igual à média são agrupadas numa única encomenda;
* cada linha cujo produto tem prazo estritamente maior do que a média é enviada separadamente, numa encomenda própria.

Por exemplo, considere-se uma compra com três linhas cujos produtos têm os prazos de entrega 3 (P1), 8 (P2) e 2 (P3). A média dos prazos é (3 + 8 + 2) / 3 ≈ 4,33. Logo, P1 e P3 (prazos ≤ 4,33) seguem juntos numa entrega e P2 (prazo > 4,33) segue numa outra encomenda:
* Encomenda A: {P1, P3} (prazo = 3)
* Encomenda B: {P2} (prazo = 8)

Uma estratégia de divisão que origina várias encomendas pode permitir que alguns produtos sejam entregues mais cedo, mas pode também resultar num custo superior devido ao custo associado a cada encomenda.

Deve ser possível introduzir novas estratégias de divisão de compras em encomendas com impacto mínimo na implementação desenvolvida.

== Transportadoras ==

O sistema mantém um registo das '''transportadoras''' que operam na plataforma. Cada transportadora é identificada por um número de transportadora. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada transportadora tem ainda um nome (cadeia de caracteres não vazia).

Cada encomenda é enviada através de uma transportadora, segundo uma '''modalidade de transporte'''. Inicialmente, devem ser suportadas, pelo menos, as seguintes modalidades: normal ('''NORMAL''') e expresso ('''EXPRESSO''').

Uma modalidade '''não''' define, por si só, qualquer custo ou prazo: é apenas o nome de um nível de serviço. Para cada modalidade que oferece, uma transportadora define uma '''tarifa''', constituída por:
* um custo adicional (número inteiro); e
* um tempo de transporte (número inteiro de dias).

Assim, a mesma modalidade pode custar e demorar valores diferentes consoante a transportadora.

Uma transportadora '''não tem de oferecer todas as modalidades''': oferece exactamente aquelas para as quais tenha uma tarifa definida. Pedir a uma transportadora uma modalidade que ela não oferece é um erro, e não uma escolha silenciosamente ignorada — ver [[#Definir modalidade de transporte|Definir modalidade de transporte]].

Entre os dois, '''a transportadora tem precedência sobre a modalidade''': como as modalidades disponíveis são as da transportadora, só se pode escolher uma modalidade depois de escolhida a transportadora, e mudar de transportadora anula a modalidade anteriormente escolhida (que passa a ser escolhida de novo, de entre as que a nova transportadora oferece).

Por exemplo:
{|
! style="background: #ebebeb;" | '''Transportadora'''
! style="background: #ebebeb;" | '''Modalidade'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo de transporte'''
|-
| CTT || '''NORMAL''' || 3 euros || 3 dias
|-
| CTT || '''EXPRESSO''' || 8 euros || 1 dia
|-
| DHL || '''NORMAL''' || 5 euros || 2 dias
|-
| DHL || '''EXPRESSO''' || 12 euros || 1 dia
|-
| SEUR || '''EXPRESSO''' || 10 euros || 1 dia
|}

No exemplo acima, a transportadora SEUR só oferece a modalidade expresso: não é possível enviar por SEUR em modalidade normal.

A transportadora e a modalidade são escolhidas no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda seja enviada por uma transportadora ou modalidade diferente.

A escolha da transportadora e da modalidade afecta tanto o custo como a data prevista de entrega da encomenda. Uma compra só pode ser finalizada depois de escolhidas ambas, e o par transportadora/modalidade de um cabaz é sempre um par que a transportadora oferece.

Deve ser possível introduzir novas modalidades de transporte com impacto mínimo na implementação desenvolvida. As transportadoras e as suas tarifas, por seu lado, fazem parte do estado da aplicação: são registadas pelo utilizador e não implicam qualquer alteração ao código.

== Serviços Adicionais ==

O cliente pode seleccionar serviços adicionais, podendo aumentar o custo de cada encomenda, assim como o tempo necessário para a sua preparação e entrega. Os serviços são escolhidos no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda tenha os seus próprios serviços.

Os serviços iniciais são os seguintes:
{|
! style="background: #ebebeb;" | '''Serviço'''
! style="background: #ebebeb;" | '''Chave'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo adicional'''
|-
| Embrulho || '''EMBRULHO''' || 2 euros || 1 dia
|-
| Cartão de oferta || '''CARTAO_OFERTA''' || 1 euro || 0 dias
|}

Os serviços adicionais podem ser combinados: uma encomenda pode incluir simultaneamente embrulho, cartão de oferta ou outro serviço adicional. O custo e o tempo adicionais de uma encomenda correspondem à soma dos contributos da modalidade de transporte e de todos os serviços seleccionados.

Deve ser possível introduzir novos serviços adicionais sem alterar o código das encomendas ou dos serviços já existentes.

== Entregas ==

Cada encomenda tem uma data prevista de entrega.
A data prevista de entrega é determinada considerando:
* a data da compra;
* os prazos de entrega dos produtos que constituem a encomenda;
* o tempo de transporte da tarifa da transportadora seleccionada;
* o tempo adicional introduzido pelos serviços seleccionados.

Para uma encomenda com vários produtos, o prazo dos produtos considerados para determinar a data prevista de entrega corresponde ao maior prazo de entrega dos seus produtos.

Não é necessário manter explicitamente um estado para representar se uma encomenda está ou não entregue. A situação da encomenda pode ser determinada a partir da data actual e da sua data prevista de entrega. Assim, uma encomenda é considerada entregue quando a data actual atinge ou ultrapassa a sua data prevista de entrega.

== Gestão de Tempo ==

A unidade de tempo do sistema é o dia. A data do sistema começa no dia 1 (um) e faz parte do estado persistente.

A data do sistema pode ser avançada. Sempre que a data é alterada, devem ser verificadas as encomendas existentes para determinar:
* quais as encomendas que serão entregues no dia seguinte;
* quais as encomendas cuja data prevista de entrega foi atingida ou ultrapassada.

Quando a data actual atinge ou ultrapassa a data prevista de entrega de uma encomenda, esta considera-se entregue.

A gestão do tempo deve ainda desencadear [[#Notificações|notificações]].

== Pesquisas ==

Para permitir que os clientes determinem a existência de um produto, deverá ser possível efectuar pesquisas.

As pesquisas consideram os campos relevantes dos vários produtos, por exemplo, nome, categoria, tipo de produto ou país de origem.

O termo de pesquisa deve ser comparado sem distinção entre letras maiúsculas e minúsculas.

O sistema deve suportar diferentes critérios de pesquisa. Por exemplo, uma pesquisa pode procurar produtos cujo nome contenha determinado termo ou produtos pertencentes a determinada categoria.

Deve ser possível introduzir novos métodos de pesquisa de produtos com impacto mínimo na implementação desenvolvida.

== Alterações de Inventário ==

O inventário de um produto numa empresa pode ser alterado através da especificação de um valor a somar ou subtrair ao número de exemplares disponíveis. Se a quantidade indicada for um valor positivo, aumenta-se o número de exemplares disponíveis.
Se a quantidade indicada for um valor negativo, decrementa-se o número de exemplares disponíveis, desde que o número de exemplares disponíveis não fique negativo.

Um produto não é removido do sistema quando o seu inventário numa empresa chega a zero.
Quando o inventário de um produto numa empresa chega a zero, o produto deixa de estar disponível nessa empresa, mas continua a existir no sistema e pode continuar a ser disponibilizado por outras empresas.
Se o inventário de um produto numa empresa passar de zero para um valor positivo, o produto volta a estar disponível nessa empresa.

O número total de unidades disponíveis de um produto corresponde à soma dos inventários desse produto em todas as empresas que o disponibilizam.

Esta informação é utilizada, nomeadamente, no cálculo do preço recomendado dos produtos nacionais.

== Notificações ==

O sistema deve notificar os clientes relativamente às suas encomendas.

Devem ser enviadas notificações em duas situações:
* um dia antes da data prevista de entrega, informando o cliente de que a encomenda será entregue no dia seguinte;
* no dia da entrega, informando o cliente de que a encomenda foi entregue.

Cada notificação deve ser enviada através do mecanismo de notificação seleccionado pelo cliente.
Inicialmente, devem ser suportados, pelo menos, os seguintes mecanismos:
* correio electrónico ('''EMAIL''');
* WhatsApp ('''WHATSAPP''').

Cada cliente pode escolher o mecanismo através do qual pretende receber notificações do sistema. O mecanismo de notificação pode variar de cliente para cliente. Por exemplo, um cliente pode receber notificações por correio electrónico, enquanto outro pode recebê-las através de WhatsApp.
Deve ser possível introduzir novos mecanismos de notificação sem necessidade de alterar o código dos clientes ou do sistema responsável por gerar as notificações.

Deve ser possível introduzir novos mecanismos de notificação com impacto mínimo na implementação desenvolvida.

As notificações devem ser enviadas pela ordem em que os acontecimentos ocorrem no sistema.

= Requisitos de Desenho =

A aplicação a desenvolver deve seguir o princípio de desenho aberto-fechado, por forma a aumentar a extensibilidade do seu código. Por exemplo, deve ser possível adicionar novos tipos de produto com um impacto mínimo no código já existente da aplicação.

Devem ser possíveis extensões ou alterações de funcionalidade com impacto mínimo no código já produzido para a aplicação. O objectivo é aumentar a flexibilidade da aplicação relativamente ao suporte de novas funções. Assim, deve ser possível:
* Adicionar novos tipos de produto (e.g., produtos digitais ou perecíveis), incluindo a respectiva regra de cálculo do preço recomendado; * Adicionar novas categorias de produto;
* Introduzir novas estratégias de divisão de compras em encomendas;
* Introduzir novas modalidades de transporte (os custos e prazos de cada uma são dados de cada transportadora, não código; nem todas as transportadoras têm de oferecer todas as modalidades);
* Introduzir novos serviços adicionais, sem alterar o código das encomendas nem o dos serviços já existentes;
* Introduzir novos mecanismos de notificação, sem alterar o código dos clientes nem o do sistema que gera as notificações;
* Introduzir novos critérios de discriminação/classificação dos clientes;
* Introduzir novos critérios de pesquisa de produtos.

= Funcionalidade da aplicação =

A aplicação permite manter informação sobre as entidades do modelo, permitindo, em particular, gerir empresas, produtos, clientes e compras. Possui ainda a capacidade de preservar o seu estado (não é possível manter várias versões do estado da aplicação em simultâneo).

Nenhuma entidade é removida pelas operações descritas neste enunciado (em particular, um produto cujo inventário numa empresa chegue a zero continua a existir no sistema). Ainda assim, a aplicação deve estar preparada para que a remoção de qualquer entidade possa vir a ser suportada.

No [[#Leitura de Dados a Partir de Ficheiros Textuais|início]], a aplicação está vazia, mas pode ser carregada uma base de dados textual com conceitos pré-definidos. Neste caso, a aplicação começará com um estado referente às entidades que foram carregadas no arranque da aplicação.

{{Suggestion|Note-se que não é necessário implementar de raiz a aplicação: já existem classes que representam e definem a interface geral da funcionalidade do ''core'' da aplicação, tal como é visível pelos comandos da aplicação.}}
{{CVSCode|A interface geral do ''core'' já está parcialmente implementada na classe '''erp.ErpManager''' e outras fornecidas (cujos nomes devem ser mantidos), devendo ser adaptadas onde necessário. É ainda necessário criar e implementar as restantes classes que suportam a operação da aplicação.}}

== Serialização ==

É possível guardar e recuperar o estado actual da aplicação, preservando toda a informação relacionada com o ERP e que foi descrita [[#Conceitos e Relações do Modelo|acima]].

Após a recuperação do estado, os identificadores atribuídos a novas entidades devem continuar a ser atribuídos incrementalmente a partir do último valor utilizado em cada caso.

= Interacção com o utilizador =

Descreve-se nesta secção a '''funcionalidade máxima''' da interface com o utilizador. Em geral, os comandos pedem toda a informação antes de procederem à sua validação (excepto onde indicado). Todos os menus têm automaticamente a opção '''Sair''' (fecha o menu).

As operações de pedido e apresentação de informação ao utilizador '''devem''' realizar-se através dos objectos ''form'' e ''display'', respectivamente, presentes em cada comando. As mensagens são produzidas pelos métodos das [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|bibliotecas de suporte]] ('''po-uilib''' e '''erp-app'''). As mensagens não podem ser usadas no núcleo da aplicação ('''erp-core'''). Além disso, não podem ser definidas novas. Potenciais omissões devem ser esclarecidas antes de qualquer implementação.

De um modo geral, sempre que no contexto de uma operação com o utilizador aconteça alguma excepção, então a operação não deve ter qualquer efeito no estado da aplicação, excepto em caso de indicação contrária na operação em causa. As excepções estão na package '''erp.app.exceptions''', excepto em caso de indicação contrária.

As excepções usadas na interacção (subclasses de '''pt.tecnico.uilib.menus.CommandException'''), excepto em caso de indicação contrária, são lançadas pelos comandos (subclasses de '''pt.tecnico.uilib.menus.Command''') e tratadas pelos menus (instâncias de subclasses de '''pt.tecnico.uilib.menus.Menu'''). Outras excepções não devem substituir as fornecidas nos casos descritos.

Nos pedidos e usos dos vários identificadores, podem ocorrer as seguintes excepções, caso o identificador indicado não corresponda a um objecto conhecido (excepto no processo de registo ou em caso de indicação contrária). Note-se que estas excepções não são utilizáveis no núcleo da aplicação.

{|
! style="background: #ebebeb;" | '''Tipo de dados'''
! style="background: #ebebeb;" | '''Classe'''
! style="background: #ebebeb;" | '''Pedido a apresentar'''
! style="background: #ebebeb;" | '''Excepção a lançar se desconhecido'''
|-
| Empresa
| '''Company'''
| '''erp.app.company.Prompt.companyId()'''
| '''erp.app.exceptions.UnknownCompanyKeyException'''
|-
| Produto
| '''Product'''
| '''erp.app.product.Prompt.productId()'''
| '''erp.app.exceptions.UnknownProductKeyException'''
|-
| Cliente
| '''Client'''
| '''erp.app.client.Prompt.clientId()'''
| '''erp.app.exceptions.UnknownClientKeyException'''
|-
| Transportadora
| '''Carrier'''
| '''erp.app.carrier.Prompt.carrierId()'''
| '''erp.app.exceptions.UnknownCarrierKeyException'''
|-
| Compra
| '''Purchase'''
| '''erp.app.purchase.Prompt.purchaseId()'''
| '''erp.app.exceptions.UnknownPurchaseKeyException'''
|}

Existe ainda um caso particular: sempre que uma operação se refira a um produto '''no contexto de uma empresa''' e essa empresa não disponibilize esse produto, deve ser lançada a excepção '''erp.app.exceptions.ProductNotSuppliedException''' (a empresa e o produto existem, mas não estão relacionados).

Alguns casos particulares podem usar pedidos específicos não apresentados nesta tabela.

Vários comandos pedem ao utilizador que escolha um valor de um conjunto fechado (tipo de produto, categoria, estratégia de divisão, modalidade de transporte, serviço adicional, mecanismo de notificação e critério de pesquisa). Estas escolhas '''devem''' ser pedidas através de campos de opção ('''Form.addOptionField()''' ou '''Form.requestOption()'''), sendo o conjunto de opções obtido do núcleo através da fachada. Desta forma, a introdução de uma nova estratégia, modalidade, serviço, mecanismo ou critério não implica qualquer alteração aos comandos.

{{CVSCode|Note-se que o programa principal e os comandos e menus, a seguir descritos, já estão parcial ou completamente implementados nas ''packages'' '''erp.app''', '''erp.app.main''', '''erp.app.company''', '''erp.app.product''', '''erp.app.client''', '''erp.app.purchase'''. Estas classes são de uso obrigatório e estão disponíveis no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|GIT]] (módulo '''erp-app''').}}

== Formatos de Apresentação ==

Os formatos usados pelos vários comandos são os seguintes. Todos os campos são separados por '''␣-␣'''.

{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma transportadora|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma tarifa|
''idTransportadora'' - ''modalidade'' - ''custo adicional'' - ''tempo de transporte''
}}

{{CollapsedCode|Formato de apresentação de um produto|
''id'' - ''tipo'' - ''nome'' - ''categoria'' - ''preço base'' - ''preço recomendado'' - ''prazo base'' - ''unidades totais'' - ''informação adicional''
}}

O ''tipo'' é '''NACIONAL''' ou '''IMPORTADO'''. As ''unidades totais'' correspondem à soma dos inventários do produto em todas as empresas que o disponibilizam. Para produtos nacionais não existe informação adicional; para produtos importados, a informação adicional corresponde ao país de origem, à taxa alfandegária e ao prazo de transporte internacional.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 173
2 - IMPORTADO - Telemovel - ELECTRONICA - 200 - 260 - 3 - 2 - China - 30 - 5
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 0
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação da disponibilização de um produto por uma empresa|
''idEmpresa'' - ''idProduto'' - ''unidades'' - ''factor'' - ''preço de venda''
}}

{{CollapsedCode|Exemplos de apresentação de disponibilizações|
<syntaxhighlight lang="text">
2 - 1 - 150 - 0.9 - 14
2 - 2 - 2 - 1.2 - 312
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''mecanismo de notificação'' - ''gasto total''
}}

O valor apresentado no fim corresponde ao total gasto pelo cliente em compras (um valor inteiro).

{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Ahsoka Tano - ahsoka@jedi.org - WHATSAPP - 0
1 - Obi-Wan Kenobi - obiwan@jedi.org - EMAIL - 124
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de uma compra|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
}}

{{CollapsedCode|Formato de apresentação (resumida) de uma encomenda|
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo'' - ''lista de identificadores de produtos''
}}

A ''descrição do transporte'' é o nome da transportadora e a modalidade seleccionadas, separados por '''/''', seguidos das chaves dos serviços adicionais seleccionados, separadas por '''+''' (por exemplo, '''DHL/ EXPRESSO+EMBRULHO+CARTAO_OFERTA'''). O ''custo'' de uma encomenda é o custo base de processamento acrescido do custo da modalidade e dos serviços.

{{CollapsedCode|Exemplos de apresentação de encomendas|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

== Menu Principal ==

As acções deste menu permitem gerir a salvaguarda do estado da aplicação e abrir submenus. A lista completa é a seguinte: [[#Salvaguarda do estado actual da aplicação|Abrir]], [[#Salvaguarda do estado actual da aplicação|Guardar]], [[#Mostrar data actual|Mostrar data actual]], [[#Avançar data actual|Avançar data actual]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Empresas]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Produtos]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Clientes]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Transportadoras]] e [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Compras]]. Inicialmente, a aplicação apenas tem informação sobre as entidades que foram carregadas no arranque.

{{CVSCode|As etiquetas das opções deste menu estão definidas na classe '''erp.app.main.Label'''. Todos os métodos correspondentes às mensagens de diálogo para este menu estão definidos na classe '''erp.app.main. Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.main''', respectivamente: '''DoOpenFile''', '''DoSaveFile''', '''DoDisplayDate''', '''DoAdvanceDate''', '''DoOpenMenuCompanies''', '''DoOpenMenuProducts''', '''DoOpenMenuClients''', '''DoOpenMenuCarriers''', '''DoOpenMenuPurchases'''.}}

=== Salvaguarda do estado actual da aplicação ===

O conteúdo da aplicação (toda a informação detida pelo ERP actualmente em memória) pode ser guardado para posterior recuperação (via serialização Java: '''java.io.Serializable'''). Na leitura e escrita do estado da aplicação, devem ser tratadas as excepções associadas. A funcionalidade é a seguinte:

* '''Abrir''' -- Carrega os dados de uma sessão anterior a partir de um ficheiro previamente guardado (ficando este ficheiro associado à aplicação, para futuras operações de salvaguarda). Pede-se o nome do ficheiro a abrir ('''Prompt.openFile()'''). Caso ocorra um problema na abertura ou processamento do ficheiro, deve ser lançada a excepção '''FileOpenFailedException'''. A execução bem-sucedida desta opção substitui toda a informação da aplicação. Quando se abandona uma aplicação com modificações não guardadas (porque se abre outra e existem alterações não guardadas), deve perguntar-se ao utilizador se quer guardar a informação actual antes de a abandonar, através de '''Prompt.saveBeforeExit()''' (a resposta é obtida via '''Form.confirm()''').

* '''Guardar''' -- Guarda o estado actual da aplicação no ficheiro associado. Se não existir associação, pede-se o nome do ficheiro a utilizar, ficando a ele associado (para operações de salvaguarda subsequentes). Esta interacção realiza-se através do método '''Prompt. newSaveAs()'''. Não é executada nenhuma acção se não existirem alterações desde a última salvaguarda.

{{Suggestion|Note-se que a opção '''Abrir''' não permite a leitura de ficheiros de texto (estes apenas podem ser utilizados no início da aplicação).}} {{Suggestion|A opção '''Sair''' nunca implica a salvaguarda do estado da aplicação, mesmo que existam alterações.}}

=== Mostrar data actual ===

A data actual do sistema é apresentada através da mensagem '''Message.currentDate()'''.

=== Avançar data actual ===

O número de dias a avançar é pedido através de '''Prompt.daysToAdvance()'''. O valor indicado deve ser positivo. Caso contrário, a operação não tem efeito.

Além da data, o sistema deve desencadear as [[#Notificações|notificações]] relativas às encomendas cujas datas previstas de entrega sejam atingidas ou fiquem à distância de um dia. Note-se que a situação de uma encomenda (entregue ou não) '''não''' é guardada: deriva da data actual.

=== Gestão e consulta de dados da aplicação ===

* '''Menu de Gestão de Empresas''' -- Abre o menu de gestão de empresas e operações associadas.
* '''Menu de Gestão de Produtos''' -- Abre o menu de gestão de produtos e operações associadas.
* '''Menu de Gestão de Clientes''' -- Abre o menu de gestão de clientes e operações associadas.
* '''Menu de Gestão de Transportadoras''' -- Abre o menu de gestão de transportadoras e operações associadas.
* '''Menu de Gestão de Compras''' -- Abre o menu de gestão de compras e operações associadas.

== Menu de Gestão de Empresas ==

Este menu permite efectuar operações sobre a base de dados de empresas. A lista completa é a seguinte: [[#Registar empresa|Registar empresa]], [[#Mostrar empresa|Mostrar empresa]], [[#Mostrar empresas|Mostrar empresas]], [[#Disponibilizar produto|Disponibilizar produto]], [[#Mostrar produtos de uma empresa|Mostrar produtos de uma empresa]], [[#Mostrar clientes de uma empresa|Mostrar clientes de uma empresa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.company.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.company.Prompt''' e '''erp.app.company.Message'''.}} {{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.company''', respectivamente: '''DoRegisterCompany''', '''DoShowCompany''', '''DoShowCompanies''', '''DoSupplyProduct''', '''DoShowCompanyProducts''', '''DoShowCompanyClients'''.}}

=== Registar empresa ===

Pede o nome ('''Prompt.companyName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CompanyRegistrationFailedException'''.

Note-se que a atribuição do identificador da empresa é automática.

=== Mostrar empresa ===

É pedido o identificador da empresa, sendo apresentadas as informações sobre essa empresa, no [[#Formatos de Apresentação|formato de apresentação de uma empresa]].

=== Mostrar empresas ===

Apresenta informações sobre todas as empresas, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar empresa|Mostrar empresa]].

=== Disponibilizar produto ===

Faz com que uma empresa passe a disponibilizar um produto já registado no sistema. São pedidos o identificador da empresa, o identificador do produto, o número de unidades disponíveis ('''Prompt.unitsToSupply()''') e o factor multiplicativo do preço recomendado ('''Prompt.priceFactor()''', um valor real positivo). O sucesso é assinalado através da mensagem '''Message.supplySuccessful()'''.

Se a empresa já disponibilizava o produto, as unidades e o factor indicados substituem os anteriores.

=== Mostrar produtos de uma empresa ===

É pedido o identificador da empresa e apresentam-se os produtos que essa empresa disponibiliza, ordenados pelos identificadores dos produtos, no [[#Formatos de Apresentação|formato de apresentação da disponibilização de um produto por uma empresa]].

=== Mostrar clientes de uma empresa ===

É pedido o identificador da empresa e apresentam-se os clientes que já interagiram com essa empresa, ordenados pelos seus identificadores, no [[#Formatos de Apresentação|formato de apresentação de um cliente]].

== Menu de Gestão de Produtos ==

Este menu apresenta as operações disponíveis sobre produtos. A lista completa é a seguinte: [[#Registar produto|Registar produto]], [[#Mostrar produto|Mostrar produto]], [[#Mostrar produtos|Mostrar produtos]], [[#Alterar inventário de um produto|Alterar inventário de um produto]] e [[#Efectuar pesquisa|Efectuar pesquisa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.product.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.product.Prompt''' e '''erp.app.product.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.product''' (disponível no GIT), respectivamente: '''DoRegisterProduct''', '''DoShowProduct''', '''DoShowProducts''', '''DoChangeProductInventory''', '''DoPerformSearch'''.}}

=== Registar produto ===

Regista um produto no registo global de produtos. São pedidos, por esta ordem: o tipo de produto ('''Prompt.productType()'''), o nome ('''Prompt.productName()'''), o preço base ('''Prompt.basePrice()'''), a categoria ('''Prompt.productCategory()''') e o prazo de entrega base ('''Prompt.baseDelay()''').

Se o tipo indicado for '''IMPORTADO''', são ainda pedidos o país de origem ('''Prompt.originCountry()'''), a taxa alfandegária ('''Prompt.customsTax()''') e o prazo de transporte internacional ('''Prompt.internationalDelay()''').

O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''ProductRegistrationFailedException'''.

Note-se que a atribuição do identificador do produto é automática e que um produto registado não é, por si só, disponibilizado por qualquer empresa (ver [[#Disponibilizar produto|Disponibilizar produto]]).

=== Mostrar produto ===

É pedido o identificador do produto. Se o produto existir, é apresentado no [[#Formatos de Apresentação|formato de apresentação de um produto]].

=== Mostrar produtos ===

Apresenta informações sobre todos os produtos, ordenando-os pelos seus identificadores. O formato de apresentação é como descrito em [[#Mostrar produto|Mostrar produto]].

=== Alterar inventário de um produto ===

O inventário é uma propriedade da disponibilização de um produto por uma empresa. São pedidos o identificador da empresa, o identificador do produto e uma quantidade ('''Prompt.amountToUpdate()'''), sendo a quantidade indicada somada ao número de exemplares que essa empresa tem disponíveis.

No caso de não ser possível actualizar o número de exemplares devido ao facto de a quantidade indicada ser inválida (tornaria o inventário negativo), então a operação não deve ter qualquer efeito e deve ser apresentada a mensagem '''Message.notEnoughInventory()'''.

Note-se que o produto '''não''' é removido do sistema quando o seu inventário numa empresa chega a zero.

=== Efectuar pesquisa ===

Esta opção realiza uma procura sobre o registo de produtos. São pedidos o critério de pesquisa ('''Prompt.searchCriterion()''') e um termo ('''Prompt.searchTerm()''').

Os critérios iniciais são: '''NOME''', '''CATEGORIA''', '''TIPO''' e '''ORIGEM''' (país de origem, que apenas os produtos importados possuem).

Como resultado, deve ser apresentada uma lista dos produtos encontrados pela pesquisa, ordenados por ordem crescente do seu identificador, utilizando o formato descrito para [[#Mostrar produto|Mostrar produto]]. O termo de pesquisa é comparado sem distinção entre letras maiúsculas e minúsculas. Caso não sejam encontrados produtos, não deve ser produzido qualquer resultado.

== Menu de Gestão de Clientes ==

Este menu permite efectuar operações sobre a base de dados de clientes. A lista completa é a seguinte: [[#Registar cliente|Registar cliente]], [[#Mostrar cliente|Mostrar cliente]], [[#Mostrar clientes|Mostrar clientes]], [[#Alterar mecanismo de notificação|Alterar mecanismo de notificação]], [[#Mostrar notificações do cliente|Mostrar notificações do cliente]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.client.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.client.Prompt''' e '''erp. app.client.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.client''', respectivamente: '''DoRegisterClient''', '''DoShowClient''', '''DoShowClients''', '''DoSetNotificationMedium''', '''DoShowClientNotifications'''.}}

=== Registar cliente ===

Pede o nome ('''Prompt.clientName()'''), o endereço de correio electrónico ('''Prompt.clientEMail()''') e o mecanismo de notificação pretendido ('''Prompt.notificationMedium()'''). O registo bem sucedido é assinalado através da mensagem '''Message. registrationSuccessful()'''; caso contrário, é lançada a excepção '''ClientRegistrationFailedException'''.

Note-se que a atribuição do identificador do cliente é automática e que clientes diferentes são registados em cada operação de registo.

=== Mostrar cliente ===

É pedido o identificador do cliente, sendo apresentadas as informações sobre esse cliente, no [[#Formatos de Apresentação|formato de apresentação de um cliente]].

=== Mostrar clientes ===

Apresenta informações sobre todos os clientes, ordenando-os lexicograficamente pelo nome. Caso existam clientes com o mesmo nome, devem ser ordenados por ordem crescente dos seus identificadores. O formato é o descrito em [[#Mostrar cliente|Mostrar cliente]].

=== Alterar mecanismo de notificação ===

São pedidos o identificador do cliente e o novo mecanismo de notificação ('''Prompt.notificationMedium()'''). As notificações seguintes desse cliente passam a ser produzidas através do mecanismo indicado.

=== Mostrar notificações do cliente ===

É pedido o identificador do cliente, sendo apresentadas as notificações para esse cliente, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação das notificações de um cliente|
''assunto'': ''descrição da encomenda''
}}

O ''assunto'' é '''ENTREGA_AMANHA''' (a encomenda será entregue no dia seguinte) ou '''ENTREGUE''' (a encomenda foi entregue). A descrição da encomenda é a descrição resumida definida em [[#Formatos de Apresentação|Formatos de Apresentação]].

{{CollapsedCode|Exemplos de notificações|
<syntaxhighlight lang="text">
ENTREGA_AMANHA: 1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
ENTREGUE: 1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

As notificações de um cliente apenas devem ser apresentadas uma única vez. Após esta visualização, considera-se que o cliente fica sem notificações. As notificações devem ser apresentadas pela mesma ordem em que foram enviadas pelo sistema.

Note-se que o mecanismo através do qual a notificação foi produzida (correio electrónico, WhatsApp, ...) não altera este formato. No entanto, a solução deve ser suficientemente flexível para permitir outros formatos de apresentação das notificações (sem impacto no código do domínio da aplicação).

== Menu de Gestão de Transportadoras ==

Este menu permite efectuar operações sobre a base de dados de transportadoras. A lista completa é a seguinte: [[#Registar transportadora|Registar transportadora]], [[#Mostrar transportadora|Mostrar transportadora]], [[#Mostrar transportadoras|Mostrar transportadoras]], [[#Definir tarifa|Definir tarifa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.carrier.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.carrier.Prompt''' e '''erp.app.carrier.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.carrier''', respectivamente: '''DoRegisterCarrier''', '''DoShowCarrier''', '''DoShowCarriers''' e '''DoSetRate'''.}}

=== Registar transportadora ===

Pede o nome ('''Prompt.carrierName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CarrierRegistrationFailedException'''.

Note-se que a atribuição do identificador da transportadora é automática e que uma transportadora recém-registada ainda não oferece qualquer modalidade (ver [[#Definir tarifa|Definir tarifa]]).

=== Mostrar transportadora ===

É pedido o identificador da transportadora ('''Prompt.carrierId()'''). Na primeira linha apresenta-se a transportadora; de seguida, as suas tarifas, ordenadas pelo nome da modalidade e indentadas com dois espaços.

{{CollapsedCode|Formato de apresentação de uma transportadora (com tarifas)|
''id'' - ''nome''
␣␣''idTransportadora'' - ''modalidade'' - ''custo adicional'' - ''tempo de transporte''
␣␣...
}}

{{CollapsedCode|Exemplo de apresentação de uma transportadora|
<syntaxhighlight lang="text">
1 - CTT
1 - EXPRESSO - 8 - 1
1 - NORMAL - 3 - 3
</syntaxhighlight>
}}

=== Mostrar transportadoras ===

Apresenta informações sobre todas as transportadoras, ordenando-as pelos seus identificadores, apenas com a linha de resumo (''id'' - ''nome''), sem as tarifas.

=== Definir tarifa ===

São pedidos o identificador da transportadora ('''Prompt.carrierId()'''), a modalidade ('''Prompt.modality()'''), o custo adicional ('''Prompt.rateCost()''') e o tempo de transporte ('''Prompt. rateTransportDays()''').

A transportadora passa a oferecer a modalidade indicada com esses valores, o que é assinalado através da mensagem '''Message.rateSuccessful()'''. Se já oferecia essa modalidade, os valores anteriores são substituídos.

== Menu de Gestão de Compras ==

Este menu apresenta as operações relacionadas com compras e encomendas. A lista completa é a seguinte: [[#Efectuar compra|Efectuar compra]], [[#Mostrar compra|Mostrar compra]], [[#Mostrar compras|Mostrar compras]], [[#Mostrar encomendas de uma compra|Mostrar encomendas de uma compra]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.purchase.Label'''. Os métodos correspondentes aos pedidos deste menu estão definidos em '''erp.app.purchase.Prompt'''. As mensagens do processo de compra pertencem ao [[#Menu de Cabaz|menu de cabaz]] ('''erp.app.basket.Message''').}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.purchase''' (disponível no GIT), respectivamente: '''DoDoPurchase''', '''DoShowPurchase''', '''DoShowPurchases''', '''DoShowPurchaseOrders'''.}}

=== Efectuar compra ===

Esta opção não efectua, por si só, qualquer compra: abre o [[#Menu de Cabaz|menu de cabaz]] sobre o cabaz de um cliente numa empresa.

São pedidos o identificador do cliente e o identificador da empresa. Se ambos existirem, é aberto o [[#Menu de Cabaz|Menu de Cabaz]] sobre o cabaz desse cliente nessa empresa (criado vazio, se ainda não existir).

Como o cabaz pertence ao cliente, sair do menu sem finalizar a compra preserva o seu conteúdo e as suas opções para uma visita posterior.

=== Mostrar compra ===

É pedido o identificador da compra. Na primeira linha apresenta-se a informação da compra; de seguida, apresentam-se as suas encomendas '''em detalhe''' — o cabeçalho de cada encomenda (sem a lista de identificadores de produtos) seguido da descrição completa de cada um dos seus produtos, indentada com dois espaços. As encomendas são apresentadas por ordem crescente da data prevista de entrega e, em caso de empate, pelos identificadores dos produtos.

{{CollapsedCode|Formato de apresentação de uma compra (com encomendas em detalhe)| ''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo''
␣␣''descrição de produto'' ␣␣... }}

{{CollapsedCode|Exemplo de apresentação de uma compra|
<syntaxhighlight lang="text">
1 - 1 - 1 - 1 - 94 - 30 - 124
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 171
</syntaxhighlight>
}}

=== Mostrar compras ===

Apresenta informações sobre todas as compras, ordenando-as pelos seus identificadores, no [[#Formatos de Apresentação|formato de apresentação de uma compra]] (apenas a linha da compra, sem as encomendas).

=== Mostrar encomendas de uma compra ===

É pedido o identificador da compra e são apresentadas as encomendas correspondentes, ordenadas pela data prevista de entrega e, em caso de empate, pelos identificadores dos produtos. Ao contrário de [[#Mostrar compra|Mostrar compra]] (que apresenta as encomendas em detalhe), aqui cada encomenda é apresentada '''de forma resumida''' (uma linha, terminada pela lista de identificadores dos seus produtos), no [[#Formatos de Apresentação|formato de apresentação resumida de uma encomenda]].

{{CollapsedCode|Exemplo de apresentação de encomendas (compra do exemplo anterior)|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

= Leitura de Dados a Partir de Ficheiros Textuais =

Além das opções de manipulação de ficheiros descritas no [[#Menu Principal|menu principal]], é possível iniciar a aplicação com um ficheiro de texto especificado pela propriedade Java '''[[#Execução do Programa e Testes Automáticos|import]]'''.

Cada linha tem uma descrição distinta mas que segue o seguinte formato geral. É possível registar transportadoras, empresas, clientes e produtos, e definir as tarifas das transportadoras e as disponibilizações de produtos por parte das empresas. Assume-se que os campos de texto não podem conter o carácter ''':''' e que os preços são números inteiros. Não existem entradas mal-formadas.

O registo de transportadoras, e das tarifas que cada uma pratica, segue os formatos:
CARRIER:''nome''
RATE:''idTransportadora'':''modalidade'':''custo'':''dias''

As entradas '''RATE''' referem transportadoras já registadas em linhas anteriores. O registo de empresas e de clientes segue os formatos:
COMPANY:''nome''
CLIENT:''nome'':''email''
CLIENT:''nome'':''email'':''mecanismo''

O ''mecanismo'' é '''EMAIL''' ou '''WHATSAPP'''; se for omitido, assume-se '''EMAIL'''. Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:

Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:
NATIONAL:''nome'':''preçoBase'':''categoria'':''prazo''
IMPORTED:''nome'':''preçoBase'':''categoria'':''prazo'':''paisOrigem'':''taxa'':''prazoInternacional''

Note-se que o registo de um produto não indica qualquer empresa nem qualquer inventário: essas são propriedades da disponibilização, descrita por entradas próprias, em que ''unidades'' é o número de exemplares que a empresa tem disponíveis e ''factor'' o multiplicador (real) que aplica ao preço recomendado:
SUPPLY:''idEmpresa'':''idProduto'':''unidades'':''factor''

As entradas '''SUPPLY''' referem empresas e produtos já registados em linhas anteriores.

Um exemplo de conteúdo do ficheiro inicial é como se segue:
{{CollapsedCode|Exemplo de ficheiro de entrada textual|
<syntaxhighlight lang="text">
CARRIER:CTT
RATE:1:NORMAL:3:3
RATE:1:EXPRESSO:8:1
CARRIER:DHL
RATE:2:NORMAL:5:2
RATE:2:EXPRESSO:12:1
CARRIER:SEUR
RATE:3:EXPRESSO:10:1
COMPANY:Moageira Nacional
COMPANY:Importadora Atlantico
CLIENT:Obi-Wan Kenobi:obiwan@jedi.org
CLIENT:Ahsoka Tano:ahsoka@jedi.org:WHATSAPP
NATIONAL:Farinha:15:ALIMENTAR:3
IMPORTED:Telemovel:200:ELECTRONICA:3:China:30:5
NATIONAL:Camisa:45:VESTUARIO:2
SUPPLY:1:1:23:1.0
SUPPLY:2:1:150:0.9
SUPPLY:2:2:2:1.2
SUPPLY:1:3:4:1.1
</syntaxhighlight>
}}

A codificação dos ficheiros a ler é garantidamente [[wp:UTF-8|UTF-8]].

{{Suggestion|Os métodos '''String.split()''', para partir cadeias de caracteres, e '''String.trim()''', para remover espaços no início e no final, podem ser usados no processamento de cada linha.}}
{{Suggestion|Note-se que o programa nunca produz ficheiros com este formato (é apenas um formato para ficheiros de entrada).}}

= Execução do Programa e Testes Automáticos =

Usando os ficheiros '''test.import''', '''test.in''' e '''test.out''', é possível verificar automaticamente o resultado correcto do programa. Note-se que é necessária a definição apropriada da variável '''CLASSPATH''' (ou da opção equivalente '''-cp''' do comando '''java'''), para localizar as classes do programa, incluindo a que contém o método correspondente ao ponto de entrada da aplicação ('''erp.app.App.main'''). As propriedades são tratadas automaticamente pelo código de apoio.

java -Dimport=test.import -Din=test.in -Dout=test.outhyp erp.app.App

Assumindo que aqueles ficheiros estão no directório onde é dado o comando de execução, o programa produz o ficheiro de saída '''test.outhyp'''. Em caso de sucesso, os ficheiros das saídas esperada ('''test.out''') e obtida ('''test.outhyp''') devem ser iguais. A comparação pode ser feita com o comando:
diff -b test.out test.outhyp

Este comando não deve produzir qualquer resultado quando os ficheiros são iguais. Note-se, contudo, que este teste não garante o correcto funcionamento do código desenvolvido, apenas verificando alguns aspectos da sua funcionalidade.

= Notas de Implementação =

Tal como indicado acima, algumas classes fornecidas como [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|material de apoio]], são de uso obrigatório e não podem ser alteradas. Outras dessas classes são de uso obrigatório e têm de ser alteradas.

A serialização Java usa as classes da ''package'' [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/package-summary.html java.io], em particular, a interface [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/Serializable.html java.io. Serializable] e as classes de leitura [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/ObjectInputStream.html java.io.ObjectInputStream] e escrita [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/ObjectOutputStream.html java.io.ObjectOutputStream] (entre outras).

[[category: Ensino]]
[[category:PO]]
[[category: Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T13:59:56Z

Root: /* Menu de Gestão de Empresas */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

'''EM PREPARAÇÃO'''

'''ÉPOCA NORMAL'''

O objectivo do projecto é desenvolver um sistema de gestão de entregas rápidas de produtos (ERP — Express Retail Platform). O sistema deverá permitir, entre outras operações, (i) registar dados de empresas; (ii) registar dados de clientes; (iii) registar, gerir e pesquisar produtos; (iv) efectuar e gerir características de compras; (v) gerir as entregas correspondentes; e (vi) notificar os clientes sobre a situação das suas encomendas.

Neste texto, o tipo '''negrito''' indica um literal (i.e., é exactamente como apresentado); o símbolo ␣ indica um espaço; e o tipo ''itálico'' indica uma parte variável (i.e., uma descrição).

= Conceitos e Relações do Modelo =

Existem vários conceitos importantes neste contexto: [[#Empresas|empresas]], [[#Produtos|produtos]], [[#Clientes|clientes]], [[#Transportadoras|transportadoras]], [[#Cabaz de Compras|cabazes]], [[#Compras|compras]], [[#Divisão das Compras em Encomendas|encomendas]] e [[#Entregas|entregas]].

Os conceitos listados não são os únicos possíveis no modelo e as suas relações (assim como relações com outros conceitos não mencionados) podem depender das escolhas do projecto.

Os clientes e os produtos são independentes das empresas: existem por si e podem relacionar-se com várias empresas. Cada empresa, no entanto, mantém registo dos clientes com quem interage, dos produtos que disponibiliza, das compras feitas e das encomendas que expede.

Uma compra representa a aquisição de produtos por um cliente a uma empresa, e resulta de finalizar um [[#Cabaz de Compras|cabaz]]. Uma compra pode dar origem a uma ou mais encomendas, de acordo com a estratégia de divisão de encomendas utilizada.

Cada encomenda pode ser enviada através de uma determinada transportadora e pode incluir serviços adicionais que alteram o seu custo e/ou prazo de entrega.

== Produtos ==

O sistema mantém um registo global de produtos. Cada produto é identificado por um número de produto. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Todos os produtos têm: um nome/descrição (cadeia de caracteres não vazia); um preço base (número inteiro positivo); uma categoria; e um prazo de entrega base (número inteiro de dias).

O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O sistema utiliza o preço base para calcular o preço recomendado do produto. O preço recomendado representa o valor de referência do produto no sistema. O seu cálculo pode depender do tipo de produto e de outras informações disponíveis no sistema.

Cada produto tem uma categoria, de acordo com a sua natureza. Inicialmente, consideram-se as seguintes categorias: (i) alimentar; (ii) electrónica; e (iii) vestuário. Deve ser possível adicionar novas categorias com impacto mínimo na aplicação já desenvolvida.

O produto existe independentemente das empresas que o disponibilizam. Assim, o mesmo produto pode ser disponibilizado por várias empresas, sendo possível que cada uma pratique um preço de venda diferente.

A informação relativa à disponibilização de um produto por uma empresa não deve ser considerada parte das características intrínsecas do produto.

== Tipos de Produto ==

Todos os produtos considerados no sistema são fabricados, mas podem ter diferentes origens.

Inicialmente, consideram-se os seguintes tipos de produto:
* produto nacional;
* produto importado.

Um produto nacional possui apenas as propriedades gerais dos produtos.

Um produto importado possui, para além das propriedades gerais dos produtos:
* um país de origem (cadeia de caracteres não vazia);
* uma taxa alfandegária (número inteiro expressando uma percentagem);
* um prazo de transporte internacional (número inteiro de dias).

O preço recomendado é calculado de forma diferente consoante o tipo de produto.

Deve ser possível introduzir novos tipos de produto com impacto mínimo na implementação desenvolvida.

=== Produtos Nacionais ===

Para um produto nacional, o preço recomendado depende do preço base e do número total de unidades actualmente disponíveis desse produto nas empresas que o disponibilizam.

Se o número total de unidades disponíveis for:
* superior a 10000, o preço recomendado corresponde a 90% do preço base;
* inferior a 100, o preço recomendado corresponde a 130% do preço base;
* nos restantes casos, o preço recomendado corresponde ao preço base.

Por exemplo, considerando um produto nacional com preço base de 100 euros:
* Unidades disponíveis = 50 => Preço recomendado = 130 euros;
* Unidades disponíveis = 5000 => Preço recomendado = 100 euros;
* Unidades disponíveis = 12000 => Preço recomendado = 90 euros.

=== Produtos Importados ===

Para um produto importado, o preço recomendado corresponde ao preço base acrescido da taxa alfandegária.

Se a taxa alfandegária for '''t%''', o preço recomendado é calculado de acordo com:

'''preço base × (100 + t) / 100'''

Por exemplo, considerando um produto importado com preço base de 100 euros e uma taxa alfandegária de 20%, o preço recomendado será:

'''100 × (100 + 20) / 100 = 120 euros'''

O cálculo do preço recomendado deve ser realizado de forma polimórfica, de modo a que o código que utiliza produtos não tenha de conhecer explicitamente o tipo concreto de cada produto.

== Empresas ==

O sistema mantém um registo das empresas que operam na plataforma. Cada empresa é identificada por um número de empresa. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada empresa tem ainda um nome (cadeia de caracteres não vazia).

Uma empresa pode disponibilizar vários produtos e cada produto pode ser disponibilizado por várias empresas.

Para cada produto que disponibiliza, a empresa deve manter informação sobre:
* número de unidades disponíveis (valor inteiro);
* factor multiplicativo do preço recomendado (número positivo).

O número de unidades disponíveis e o factor multiplicativo podem ser diferentes para cada empresa que disponibiliza o mesmo produto.

O factor multiplicativo permite que uma empresa pratique um preço de venda diferente do preço recomendado pelo sistema. O preço de venda de um produto pela empresa é calculado multiplicando o preço recomendado do produto pelo factor multiplicativo definido pela empresa. Assim, duas empresas podem disponibilizar o mesmo produto a preços diferentes e com quantidades diferentes em stock.

Por exemplo, o produto P1, com um preço recomendado de 100 euros, pode ser disponibilizado pela empresa A com um preço de 90 euros, através de um factor multiplicativo de 0,9. A empresa B pode disponibilizar o mesmo produto com um preço de 120 euros, através de um factor multiplicativo de 1,2.

Deve ser possível adicionar outras propriedades às empresas sem impacto significativo no código já desenvolvido.

== Clientes ==

O sistema mantém um registo de clientes. Cada cliente é identificado por um número de cliente. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada cliente tem ainda informação sobre o seu nome e endereço de correio electrónico. Estes campos não podem ser vazios.

Assume-se que os clientes têm sempre dinheiro, i.e., uma compra nunca é recusada por falta de fundos.

== Compras ==

O sistema regista as compras efectuadas pelos clientes. Cada compra é identificada por um número de compra, atribuído automaticamente e incrementalmente. Uma compra é sempre feita por um único cliente a uma única empresa numa determinada data.

Uma compra é constituída por um conjunto de linhas (um "cabaz"). Cada linha corresponde a:
* um produto;
* uma quantidade (número de exemplares adquiridos desse produto);
* um preço unitário (o preço de venda do produto pela empresa no momento da compra);
* um preço total da linha (quantidade × preço unitário).

O preço unitário utilizado numa compra deve ser guardado na própria linha da compra. Alterações posteriores ao preço base, ao preço recomendado, ao factor multiplicativo da empresa, ou a qualquer outra propriedade utilizada no cálculo do preço, não devem alterar o valor de compras já efectuadas.

O preço total dos itens de uma compra é a soma dos preços totais das suas linhas. Uma compra pode dar origem a uma ou mais encomendas, de acordo com uma estratégia de divisão de encomendas.

A divisão de uma compra em várias encomendas pode ter impacto no custo total da compra.

== Cabaz de Compras ==

Antes de dar origem a uma compra, os produtos que um cliente pretende adquirir a uma empresa são acumulados num '''cabaz'''.

Cada cliente tem um cabaz por cada empresa em que compra. O cabaz é constituído por um conjunto de linhas; cada linha corresponde a um produto disponibilizado por essa empresa e a uma quantidade. Acrescentar ao cabaz um produto que já lá esteja acumula as quantidades.

O cabaz regista ainda as opções que serão aplicadas à compra:
* a [[#Divisão das Compras em Encomendas|estratégia de divisão em encomendas]]; * a [[#Transportadoras|transportadora]] e a [[#Transportadoras|modalidade de transporte]]; e
* o conjunto de [[#Serviços Adicionais|serviços adicionais]].

A transportadora, a modalidade e os serviços adicionais escolhidos aplicam-se a '''todas''' as encomendas resultantes da compra.

Enquanto não for finalizado, o cabaz não tem qualquer efeito no resto do sistema: em particular, não reserva nem consome inventário, e os preços apresentados são sempre os preços de venda praticados pela empresa '''nesse momento'''. Um cabaz faz parte do estado persistente da aplicação: pode ser abandonado e retomado mais tarde.

Ao '''finalizar''' o cabaz, e apenas nesse momento:
* os preços de venda são fixados nas linhas da compra;
* a compra é dividida em encomendas de acordo com a estratégia registada no cabaz;
* todas as encomendas recebem a modalidade de transporte e os serviços adicionais registados no cabaz;
* o inventário dos produtos na empresa é decrementado e o cliente é debitado;
* o cabaz fica vazio.

Um cabaz vazio não pode ser finalizado, nem o pode ser um cabaz em que ainda não tenham sido escolhidas transportadora e modalidade. Se, no momento de finalizar, a empresa já não tiver exemplares suficientes de algum dos produtos do cabaz (por exemplo, porque o inventário foi entretanto alterado), a operação falha sem qualquer efeito e o cabaz mantém-se intacto.

== Divisão das Compras em Encomendas ==

Cada encomenda tem um custo base de processamento e expedição, de '''5 euros'''. Assim, uma compra dividida em várias encomendas pode ter um custo superior ao de uma compra enviada numa única encomenda.

O custo base associado às encomendas corresponde ao número de encomendas multiplicado pelo custo base de uma encomenda.

A este custo podem acrescer os custos associados ao método de transporte seleccionado e aos serviços adicionais.

O custo total de uma compra corresponde, assim, ao custo dos produtos acrescido:
* do custo base das encomendas;
* dos custos adicionais das tarifas de transporte;
* dos custos dos serviços adicionais seleccionados.

A forma como uma compra é dividida em encomendas é determinada por uma estratégia de divisão de encomendas. Inicialmente, devem ser suportadas, pelo menos, as seguintes estratégias: encomenda única ('''UNICA''') e agrupamento por prazo de entrega ('''PRAZO''').

=== Encomenda única ===

Todos os produtos da compra são colocados numa única encomenda.

Neste caso, a compra origina uma única encomenda, independentemente dos prazos de entrega dos produtos.

=== Agrupamento por prazo de entrega ===

Os produtos são agrupados de acordo com os seus prazos de entrega.

Calcula-se a média dos prazos de entrega dos produtos das linhas da compra:
* todas as linhas cujo produto tem prazo menor ou igual à média são agrupadas numa única encomenda;
* cada linha cujo produto tem prazo estritamente maior do que a média é enviada separadamente, numa encomenda própria.

Por exemplo, considere-se uma compra com três linhas cujos produtos têm os prazos de entrega 3 (P1), 8 (P2) e 2 (P3). A média dos prazos é (3 + 8 + 2) / 3 ≈ 4,33. Logo, P1 e P3 (prazos ≤ 4,33) seguem juntos numa entrega e P2 (prazo > 4,33) segue numa outra encomenda:
* Encomenda A: {P1, P3} (prazo = 3)
* Encomenda B: {P2} (prazo = 8)

Uma estratégia de divisão que origina várias encomendas pode permitir que alguns produtos sejam entregues mais cedo, mas pode também resultar num custo superior devido ao custo associado a cada encomenda.

Deve ser possível introduzir novas estratégias de divisão de compras em encomendas com impacto mínimo na implementação desenvolvida.

== Transportadoras ==

O sistema mantém um registo das '''transportadoras''' que operam na plataforma. Cada transportadora é identificada por um número de transportadora. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada transportadora tem ainda um nome (cadeia de caracteres não vazia).

Cada encomenda é enviada através de uma transportadora, segundo uma '''modalidade de transporte'''. Inicialmente, devem ser suportadas, pelo menos, as seguintes modalidades: normal ('''NORMAL''') e expresso ('''EXPRESSO''').

Uma modalidade '''não''' define, por si só, qualquer custo ou prazo: é apenas o nome de um nível de serviço. Para cada modalidade que oferece, uma transportadora define uma '''tarifa''', constituída por:
* um custo adicional (número inteiro); e
* um tempo de transporte (número inteiro de dias).

Assim, a mesma modalidade pode custar e demorar valores diferentes consoante a transportadora.

Uma transportadora '''não tem de oferecer todas as modalidades''': oferece exactamente aquelas para as quais tenha uma tarifa definida. Pedir a uma transportadora uma modalidade que ela não oferece é um erro, e não uma escolha silenciosamente ignorada — ver [[#Definir modalidade de transporte|Definir modalidade de transporte]].

Entre os dois, '''a transportadora tem precedência sobre a modalidade''': como as modalidades disponíveis são as da transportadora, só se pode escolher uma modalidade depois de escolhida a transportadora, e mudar de transportadora anula a modalidade anteriormente escolhida (que passa a ser escolhida de novo, de entre as que a nova transportadora oferece).

Por exemplo:
{|
! style="background: #ebebeb;" | '''Transportadora'''
! style="background: #ebebeb;" | '''Modalidade'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo de transporte'''
|-
| CTT || '''NORMAL''' || 3 euros || 3 dias
|-
| CTT || '''EXPRESSO''' || 8 euros || 1 dia
|-
| DHL || '''NORMAL''' || 5 euros || 2 dias
|-
| DHL || '''EXPRESSO''' || 12 euros || 1 dia
|-
| SEUR || '''EXPRESSO''' || 10 euros || 1 dia
|}

No exemplo acima, a transportadora SEUR só oferece a modalidade expresso: não é possível enviar por SEUR em modalidade normal.

A transportadora e a modalidade são escolhidas no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda seja enviada por uma transportadora ou modalidade diferente.

A escolha da transportadora e da modalidade afecta tanto o custo como a data prevista de entrega da encomenda. Uma compra só pode ser finalizada depois de escolhidas ambas, e o par transportadora/modalidade de um cabaz é sempre um par que a transportadora oferece.

Deve ser possível introduzir novas modalidades de transporte com impacto mínimo na implementação desenvolvida. As transportadoras e as suas tarifas, por seu lado, fazem parte do estado da aplicação: são registadas pelo utilizador e não implicam qualquer alteração ao código.

== Serviços Adicionais ==

O cliente pode seleccionar serviços adicionais, podendo aumentar o custo de cada encomenda, assim como o tempo necessário para a sua preparação e entrega. Os serviços são escolhidos no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda tenha os seus próprios serviços.

Os serviços iniciais são os seguintes:
{|
! style="background: #ebebeb;" | '''Serviço'''
! style="background: #ebebeb;" | '''Chave'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo adicional'''
|-
| Embrulho || '''EMBRULHO''' || 2 euros || 1 dia
|-
| Cartão de oferta || '''CARTAO_OFERTA''' || 1 euro || 0 dias
|}

Os serviços adicionais podem ser combinados: uma encomenda pode incluir simultaneamente embrulho, cartão de oferta ou outro serviço adicional. O custo e o tempo adicionais de uma encomenda correspondem à soma dos contributos da modalidade de transporte e de todos os serviços seleccionados.

Deve ser possível introduzir novos serviços adicionais sem alterar o código das encomendas ou dos serviços já existentes.

== Entregas ==

Cada encomenda tem uma data prevista de entrega.
A data prevista de entrega é determinada considerando:
* a data da compra;
* os prazos de entrega dos produtos que constituem a encomenda;
* o tempo de transporte da tarifa da transportadora seleccionada;
* o tempo adicional introduzido pelos serviços seleccionados.

Para uma encomenda com vários produtos, o prazo dos produtos considerados para determinar a data prevista de entrega corresponde ao maior prazo de entrega dos seus produtos.

Não é necessário manter explicitamente um estado para representar se uma encomenda está ou não entregue. A situação da encomenda pode ser determinada a partir da data actual e da sua data prevista de entrega. Assim, uma encomenda é considerada entregue quando a data actual atinge ou ultrapassa a sua data prevista de entrega.

== Gestão de Tempo ==

A unidade de tempo do sistema é o dia. A data do sistema começa no dia 1 (um) e faz parte do estado persistente.

A data do sistema pode ser avançada. Sempre que a data é alterada, devem ser verificadas as encomendas existentes para determinar:
* quais as encomendas que serão entregues no dia seguinte;
* quais as encomendas cuja data prevista de entrega foi atingida ou ultrapassada.

Quando a data actual atinge ou ultrapassa a data prevista de entrega de uma encomenda, esta considera-se entregue.

A gestão do tempo deve ainda desencadear [[#Notificações|notificações]].

== Pesquisas ==

Para permitir que os clientes determinem a existência de um produto, deverá ser possível efectuar pesquisas.

As pesquisas consideram os campos relevantes dos vários produtos, por exemplo, nome, categoria, tipo de produto ou país de origem.

O termo de pesquisa deve ser comparado sem distinção entre letras maiúsculas e minúsculas.

O sistema deve suportar diferentes critérios de pesquisa. Por exemplo, uma pesquisa pode procurar produtos cujo nome contenha determinado termo ou produtos pertencentes a determinada categoria.

Deve ser possível introduzir novos métodos de pesquisa de produtos com impacto mínimo na implementação desenvolvida.

== Alterações de Inventário ==

O inventário de um produto numa empresa pode ser alterado através da especificação de um valor a somar ou subtrair ao número de exemplares disponíveis. Se a quantidade indicada for um valor positivo, aumenta-se o número de exemplares disponíveis.
Se a quantidade indicada for um valor negativo, decrementa-se o número de exemplares disponíveis, desde que o número de exemplares disponíveis não fique negativo.

Um produto não é removido do sistema quando o seu inventário numa empresa chega a zero.
Quando o inventário de um produto numa empresa chega a zero, o produto deixa de estar disponível nessa empresa, mas continua a existir no sistema e pode continuar a ser disponibilizado por outras empresas.
Se o inventário de um produto numa empresa passar de zero para um valor positivo, o produto volta a estar disponível nessa empresa.

O número total de unidades disponíveis de um produto corresponde à soma dos inventários desse produto em todas as empresas que o disponibilizam.

Esta informação é utilizada, nomeadamente, no cálculo do preço recomendado dos produtos nacionais.

== Notificações ==

O sistema deve notificar os clientes relativamente às suas encomendas.

Devem ser enviadas notificações em duas situações:
* um dia antes da data prevista de entrega, informando o cliente de que a encomenda será entregue no dia seguinte;
* no dia da entrega, informando o cliente de que a encomenda foi entregue.

Cada notificação deve ser enviada através do mecanismo de notificação seleccionado pelo cliente.
Inicialmente, devem ser suportados, pelo menos, os seguintes mecanismos:
* correio electrónico ('''EMAIL''');
* WhatsApp ('''WHATSAPP''').

Cada cliente pode escolher o mecanismo através do qual pretende receber notificações do sistema. O mecanismo de notificação pode variar de cliente para cliente. Por exemplo, um cliente pode receber notificações por correio electrónico, enquanto outro pode recebê-las através de WhatsApp.
Deve ser possível introduzir novos mecanismos de notificação sem necessidade de alterar o código dos clientes ou do sistema responsável por gerar as notificações.

Deve ser possível introduzir novos mecanismos de notificação com impacto mínimo na implementação desenvolvida.

As notificações devem ser enviadas pela ordem em que os acontecimentos ocorrem no sistema.

= Requisitos de Desenho =

A aplicação a desenvolver deve seguir o princípio de desenho aberto-fechado, por forma a aumentar a extensibilidade do seu código. Por exemplo, deve ser possível adicionar novos tipos de produto com um impacto mínimo no código já existente da aplicação.

Devem ser possíveis extensões ou alterações de funcionalidade com impacto mínimo no código já produzido para a aplicação. O objectivo é aumentar a flexibilidade da aplicação relativamente ao suporte de novas funções. Assim, deve ser possível:
* Adicionar novos tipos de produto (e.g., produtos digitais ou perecíveis), incluindo a respectiva regra de cálculo do preço recomendado; * Adicionar novas categorias de produto;
* Introduzir novas estratégias de divisão de compras em encomendas;
* Introduzir novas modalidades de transporte (os custos e prazos de cada uma são dados de cada transportadora, não código; nem todas as transportadoras têm de oferecer todas as modalidades);
* Introduzir novos serviços adicionais, sem alterar o código das encomendas nem o dos serviços já existentes;
* Introduzir novos mecanismos de notificação, sem alterar o código dos clientes nem o do sistema que gera as notificações;
* Introduzir novos critérios de discriminação/classificação dos clientes;
* Introduzir novos critérios de pesquisa de produtos.

= Funcionalidade da aplicação =

A aplicação permite manter informação sobre as entidades do modelo, permitindo, em particular, gerir empresas, produtos, clientes e compras. Possui ainda a capacidade de preservar o seu estado (não é possível manter várias versões do estado da aplicação em simultâneo).

Nenhuma entidade é removida pelas operações descritas neste enunciado (em particular, um produto cujo inventário numa empresa chegue a zero continua a existir no sistema). Ainda assim, a aplicação deve estar preparada para que a remoção de qualquer entidade possa vir a ser suportada.

No [[#Leitura de Dados a Partir de Ficheiros Textuais|início]], a aplicação está vazia, mas pode ser carregada uma base de dados textual com conceitos pré-definidos. Neste caso, a aplicação começará com um estado referente às entidades que foram carregadas no arranque da aplicação.

{{Suggestion|Note-se que não é necessário implementar de raiz a aplicação: já existem classes que representam e definem a interface geral da funcionalidade do ''core'' da aplicação, tal como é visível pelos comandos da aplicação.}}
{{CVSCode|A interface geral do ''core'' já está parcialmente implementada na classe '''erp.ErpManager''' e outras fornecidas (cujos nomes devem ser mantidos), devendo ser adaptadas onde necessário. É ainda necessário criar e implementar as restantes classes que suportam a operação da aplicação.}}

== Serialização ==

É possível guardar e recuperar o estado actual da aplicação, preservando toda a informação relacionada com o ERP e que foi descrita [[#Conceitos e Relações do Modelo|acima]].

Após a recuperação do estado, os identificadores atribuídos a novas entidades devem continuar a ser atribuídos incrementalmente a partir do último valor utilizado em cada caso.

= Interacção com o utilizador =

Descreve-se nesta secção a '''funcionalidade máxima''' da interface com o utilizador. Em geral, os comandos pedem toda a informação antes de procederem à sua validação (excepto onde indicado). Todos os menus têm automaticamente a opção '''Sair''' (fecha o menu).

As operações de pedido e apresentação de informação ao utilizador '''devem''' realizar-se através dos objectos ''form'' e ''display'', respectivamente, presentes em cada comando. As mensagens são produzidas pelos métodos das [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|bibliotecas de suporte]] ('''po-uilib''' e '''erp-app'''). As mensagens não podem ser usadas no núcleo da aplicação ('''erp-core'''). Além disso, não podem ser definidas novas. Potenciais omissões devem ser esclarecidas antes de qualquer implementação.

De um modo geral, sempre que no contexto de uma operação com o utilizador aconteça alguma excepção, então a operação não deve ter qualquer efeito no estado da aplicação, excepto em caso de indicação contrária na operação em causa. As excepções estão na package '''erp.app.exceptions''', excepto em caso de indicação contrária.

As excepções usadas na interacção (subclasses de '''pt.tecnico.uilib.menus.CommandException'''), excepto em caso de indicação contrária, são lançadas pelos comandos (subclasses de '''pt.tecnico.uilib.menus.Command''') e tratadas pelos menus (instâncias de subclasses de '''pt.tecnico.uilib.menus.Menu'''). Outras excepções não devem substituir as fornecidas nos casos descritos.

Nos pedidos e usos dos vários identificadores, podem ocorrer as seguintes excepções, caso o identificador indicado não corresponda a um objecto conhecido (excepto no processo de registo ou em caso de indicação contrária). Note-se que estas excepções não são utilizáveis no núcleo da aplicação.

{|
! style="background: #ebebeb;" | '''Tipo de dados'''
! style="background: #ebebeb;" | '''Classe'''
! style="background: #ebebeb;" | '''Pedido a apresentar'''
! style="background: #ebebeb;" | '''Excepção a lançar se desconhecido'''
|-
| Empresa
| '''Company'''
| '''erp.app.company.Prompt.companyId()'''
| '''erp.app.exceptions.UnknownCompanyKeyException'''
|-
| Produto
| '''Product'''
| '''erp.app.product.Prompt.productId()'''
| '''erp.app.exceptions.UnknownProductKeyException'''
|-
| Cliente
| '''Client'''
| '''erp.app.client.Prompt.clientId()'''
| '''erp.app.exceptions.UnknownClientKeyException'''
|-
| Transportadora
| '''Carrier'''
| '''erp.app.carrier.Prompt.carrierId()'''
| '''erp.app.exceptions.UnknownCarrierKeyException'''
|-
| Compra
| '''Purchase'''
| '''erp.app.purchase.Prompt.purchaseId()'''
| '''erp.app.exceptions.UnknownPurchaseKeyException'''
|}

Existe ainda um caso particular: sempre que uma operação se refira a um produto '''no contexto de uma empresa''' e essa empresa não disponibilize esse produto, deve ser lançada a excepção '''erp.app.exceptions.ProductNotSuppliedException''' (a empresa e o produto existem, mas não estão relacionados).

Alguns casos particulares podem usar pedidos específicos não apresentados nesta tabela.

Vários comandos pedem ao utilizador que escolha um valor de um conjunto fechado (tipo de produto, categoria, estratégia de divisão, modalidade de transporte, serviço adicional, mecanismo de notificação e critério de pesquisa). Estas escolhas '''devem''' ser pedidas através de campos de opção ('''Form.addOptionField()''' ou '''Form.requestOption()'''), sendo o conjunto de opções obtido do núcleo através da fachada. Desta forma, a introdução de uma nova estratégia, modalidade, serviço, mecanismo ou critério não implica qualquer alteração aos comandos.

{{CVSCode|Note-se que o programa principal e os comandos e menus, a seguir descritos, já estão parcial ou completamente implementados nas ''packages'' '''erp.app''', '''erp.app.main''', '''erp.app.company''', '''erp.app.product''', '''erp.app.client''', '''erp.app.purchase'''. Estas classes são de uso obrigatório e estão disponíveis no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|GIT]] (módulo '''erp-app''').}}

== Formatos de Apresentação ==

Os formatos usados pelos vários comandos são os seguintes. Todos os campos são separados por '''␣-␣'''.

{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma transportadora|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma tarifa|
''idTransportadora'' - ''modalidade'' - ''custo adicional'' - ''tempo de transporte''
}}

{{CollapsedCode|Formato de apresentação de um produto|
''id'' - ''tipo'' - ''nome'' - ''categoria'' - ''preço base'' - ''preço recomendado'' - ''prazo base'' - ''unidades totais'' - ''informação adicional''
}}

O ''tipo'' é '''NACIONAL''' ou '''IMPORTADO'''. As ''unidades totais'' correspondem à soma dos inventários do produto em todas as empresas que o disponibilizam. Para produtos nacionais não existe informação adicional; para produtos importados, a informação adicional corresponde ao país de origem, à taxa alfandegária e ao prazo de transporte internacional.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 173
2 - IMPORTADO - Telemovel - ELECTRONICA - 200 - 260 - 3 - 2 - China - 30 - 5
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 0
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação da disponibilização de um produto por uma empresa|
''idEmpresa'' - ''idProduto'' - ''unidades'' - ''factor'' - ''preço de venda''
}}

{{CollapsedCode|Exemplos de apresentação de disponibilizações|
<syntaxhighlight lang="text">
2 - 1 - 150 - 0.9 - 14
2 - 2 - 2 - 1.2 - 312
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''mecanismo de notificação'' - ''gasto total''
}}

O valor apresentado no fim corresponde ao total gasto pelo cliente em compras (um valor inteiro).

{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Ahsoka Tano - ahsoka@jedi.org - WHATSAPP - 0
1 - Obi-Wan Kenobi - obiwan@jedi.org - EMAIL - 124
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de uma compra|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
}}

{{CollapsedCode|Formato de apresentação (resumida) de uma encomenda|
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo'' - ''lista de identificadores de produtos''
}}

A ''descrição do transporte'' é o nome da transportadora e a modalidade seleccionadas, separados por '''/''', seguidos das chaves dos serviços adicionais seleccionados, separadas por '''+''' (por exemplo, '''DHL/ EXPRESSO+EMBRULHO+CARTAO_OFERTA'''). O ''custo'' de uma encomenda é o custo base de processamento acrescido do custo da modalidade e dos serviços.

{{CollapsedCode|Exemplos de apresentação de encomendas|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

== Menu Principal ==

As acções deste menu permitem gerir a salvaguarda do estado da aplicação e abrir submenus. A lista completa é a seguinte: [[#Salvaguarda do estado actual da aplicação|Abrir]], [[#Salvaguarda do estado actual da aplicação|Guardar]], [[#Mostrar data actual|Mostrar data actual]], [[#Avançar data actual|Avançar data actual]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Empresas]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Produtos]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Clientes]] e [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Compras]]. Inicialmente, a aplicação apenas tem informação sobre as entidades que foram carregadas no arranque.

{{CVSCode|As etiquetas das opções deste menu estão definidas na classe '''erp.app.main.Label'''. Todos os métodos correspondentes às mensagens de diálogo para este menu estão definidos na classe '''erp.app.main.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.main''', respectivamente: '''DoOpenFile''', '''DoSaveFile''', '''DoDisplayDate''', '''DoAdvanceDate''', '''DoOpenMenuCompanies''', '''DoOpenMenuProducts''', '''DoOpenMenuClients''', '''DoOpenMenuPurchases'''.}}

=== Salvaguarda do estado actual da aplicação ===

O conteúdo da aplicação (toda a informação detida pelo ERP actualmente em memória) pode ser guardado para posterior recuperação (via serialização Java: '''java.io.Serializable'''). Na leitura e escrita do estado da aplicação, devem ser tratadas as excepções associadas. A funcionalidade é a seguinte:

* '''Abrir''' -- Carrega os dados de uma sessão anterior a partir de um ficheiro previamente guardado (ficando este ficheiro associado à aplicação, para futuras operações de salvaguarda). Pede-se o nome do ficheiro a abrir ('''Prompt.openFile()'''). Caso ocorra um problema na abertura ou processamento do ficheiro, deve ser lançada a excepção '''FileOpenFailedException'''. A execução bem-sucedida desta opção substitui toda a informação da aplicação. Quando se abandona uma aplicação com modificações não guardadas (porque se abre outra e existem alterações não guardadas), deve perguntar-se ao utilizador se quer guardar a informação actual antes de a abandonar, através de '''Prompt.saveBeforeExit()''' (a resposta é obtida via '''Form.confirm()''').

* '''Guardar''' -- Guarda o estado actual da aplicação no ficheiro associado. Se não existir associação, pede-se o nome do ficheiro a utilizar, ficando a ele associado (para operações de salvaguarda subsequentes). Esta interacção realiza-se através do método '''Prompt.newSaveAs()'''. Não é executada nenhuma acção se não existirem alterações desde a última salvaguarda.

{{Suggestion|Note-se que a opção '''Abrir''' não permite a leitura de ficheiros de texto (estes apenas podem ser utilizados no início da aplicação).}}
{{Suggestion|A opção '''Sair''' nunca implica a salvaguarda do estado da aplicação, mesmo que existam alterações.}}

=== Mostrar data actual ===

A data actual do sistema é apresentada através da mensagem '''Message.currentDate()'''.

=== Avançar data actual ===

O número de dias a avançar é pedido através de '''Prompt.daysToAdvance()'''. O valor indicado deve ser positivo. Caso contrário, a operação não tem efeito.

Além da data, o sistema deve actualizar, caso seja necessário, outros aspectos que dela dependam, designadamente, a situação das entregas relativa às suas datas de chegada.

=== Gestão e consulta de dados da aplicação ===

* '''Menu de Gestão de Empresas''' -- Abre o menu de gestão de empresas e operações associadas.
* '''Menu de Gestão de Produtos''' -- Abre o menu de gestão de produtos e operações associadas.
* '''Menu de Gestão de Clientes''' -- Abre o menu de gestão de clientes e operações associadas.
* '''Menu de Gestão de Compras''' -- Abre o menu de gestão de compras e operações associadas.

== Menu de Gestão de Empresas ==

Este menu permite efectuar operações sobre a base de dados de empresas. A lista completa é a seguinte: [[#Registar empresa|Registar empresa]], [[#Mostrar empresa|Mostrar empresa]], [[#Mostrar empresas|Mostrar empresas]], [[#Disponibilizar produto|Disponibilizar produto]], [[#Mostrar produtos de uma empresa|Mostrar produtos de uma empresa]], [[#Mostrar clientes de uma empresa|Mostrar clientes de uma empresa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.company.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.company.Prompt''' e '''erp.app.company.Message'''.}} {{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.company''', respectivamente: '''DoRegisterCompany''', '''DoShowCompany''', '''DoShowCompanies''', '''DoSupplyProduct''', '''DoShowCompanyProducts''', '''DoShowCompanyClients'''.}}

=== Registar empresa ===

Pede o nome ('''Prompt.companyName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CompanyRegistrationFailedException'''.

Note-se que a atribuição do identificador da empresa é automática.

=== Mostrar empresa ===

É pedido o identificador da empresa, sendo apresentadas as informações sobre essa empresa, no [[#Formatos de Apresentação|formato de apresentação de uma empresa]].

=== Mostrar empresas ===

Apresenta informações sobre todas as empresas, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar empresa|Mostrar empresa]].

=== Disponibilizar produto ===

Faz com que uma empresa passe a disponibilizar um produto já registado no sistema. São pedidos o identificador da empresa, o identificador do produto, o número de unidades disponíveis ('''Prompt.unitsToSupply()''') e o factor multiplicativo do preço recomendado ('''Prompt.priceFactor()''', um valor real positivo). O sucesso é assinalado através da mensagem '''Message.supplySuccessful()'''.

Se a empresa já disponibilizava o produto, as unidades e o factor indicados substituem os anteriores.

=== Mostrar produtos de uma empresa ===

É pedido o identificador da empresa e apresentam-se os produtos que essa empresa disponibiliza, ordenados pelos identificadores dos produtos, no [[#Formatos de Apresentação|formato de apresentação da disponibilização de um produto por uma empresa]].

=== Mostrar clientes de uma empresa ===

É pedido o identificador da empresa e apresentam-se os clientes que já interagiram com essa empresa, ordenados pelos seus identificadores, no [[#Formatos de Apresentação|formato de apresentação de um cliente]].

== Menu de Gestão de Produtos ==

Este menu apresenta as operações disponíveis sobre produtos. A lista completa é a seguinte: [[#Registar produto|Registar produto]], [[#Mostrar produto|Mostrar produto]], [[#Mostrar produtos|Mostrar produtos]], [[#Alterar inventário de um produto|Alterar inventário de um produto]] e [[#Efectuar pesquisa|Efectuar pesquisa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.product.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.product.Prompt''' e '''erp.app.product.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.product''' (disponível no GIT), respectivamente: '''DoRegisterProduct''', '''DoShowProduct''', '''DoShowProducts''', '''DoChangeProductInventory''', '''DoPerformSearch'''.}}

=== Registar produto ===

Regista um produto no registo global de produtos. São pedidos, por esta ordem: o tipo de produto ('''Prompt.productType()'''), o nome ('''Prompt.productName()'''), o preço base ('''Prompt.basePrice()'''), a categoria ('''Prompt.productCategory()''') e o prazo de entrega base ('''Prompt.baseDelay()''').

Se o tipo indicado for '''IMPORTADO''', são ainda pedidos o país de origem ('''Prompt.originCountry()'''), a taxa alfandegária ('''Prompt.customsTax()''') e o prazo de transporte internacional ('''Prompt.internationalDelay()''').

O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''ProductRegistrationFailedException'''.

Note-se que a atribuição do identificador do produto é automática e que um produto registado não é, por si só, disponibilizado por qualquer empresa (ver [[#Disponibilizar produto|Disponibilizar produto]]).

=== Mostrar produto ===

É pedido o identificador do produto. Se o produto existir, é apresentado no [[#Formatos de Apresentação|formato de apresentação de um produto]].

=== Mostrar produtos ===

Apresenta informações sobre todos os produtos, ordenando-os pelos seus identificadores. O formato de apresentação é como descrito em [[#Mostrar produto|Mostrar produto]].

=== Alterar inventário de um produto ===

O inventário é uma propriedade da disponibilização de um produto por uma empresa. São pedidos o identificador da empresa, o identificador do produto e uma quantidade ('''Prompt.amountToUpdate()'''), sendo a quantidade indicada somada ao número de exemplares que essa empresa tem disponíveis.

No caso de não ser possível actualizar o número de exemplares devido ao facto de a quantidade indicada ser inválida (tornaria o inventário negativo), então a operação não deve ter qualquer efeito e deve ser apresentada a mensagem '''Message.notEnoughInventory()'''.

Note-se que o produto '''não''' é removido do sistema quando o seu inventário numa empresa chega a zero.

=== Efectuar pesquisa ===

Esta opção realiza uma procura sobre o registo de produtos. São pedidos o critério de pesquisa ('''Prompt.searchCriterion()''') e um termo ('''Prompt.searchTerm()''').

Os critérios iniciais são: '''NOME''', '''CATEGORIA''', '''TIPO''' e '''ORIGEM''' (país de origem, que apenas os produtos importados possuem).

Como resultado, deve ser apresentada uma lista dos produtos encontrados pela pesquisa, ordenados por ordem crescente do seu identificador, utilizando o formato descrito para [[#Mostrar produto|Mostrar produto]]. O termo de pesquisa é comparado sem distinção entre letras maiúsculas e minúsculas. Caso não sejam encontrados produtos, não deve ser produzido qualquer resultado.

== Menu de Gestão de Clientes ==

Este menu permite efectuar operações sobre a base de dados de clientes. A lista completa é a seguinte: [[#Registar cliente|Registar cliente]], [[#Mostrar cliente|Mostrar cliente]], [[#Mostrar clientes|Mostrar clientes]], [[#Alterar mecanismo de notificação|Alterar mecanismo de notificação]], [[#Mostrar notificações do cliente|Mostrar notificações do cliente]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.client.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.client.Prompt''' e '''erp. app.client.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.client''', respectivamente: '''DoRegisterClient''', '''DoShowClient''', '''DoShowClients''', '''DoSetNotificationMedium''', '''DoShowClientNotifications'''.}}

=== Registar cliente ===

Pede o nome ('''Prompt.clientName()'''), o endereço de correio electrónico ('''Prompt.clientEMail()''') e o mecanismo de notificação pretendido ('''Prompt.notificationMedium()'''). O registo bem sucedido é assinalado através da mensagem '''Message. registrationSuccessful()'''; caso contrário, é lançada a excepção '''ClientRegistrationFailedException'''.

Note-se que a atribuição do identificador do cliente é automática e que clientes diferentes são registados em cada operação de registo.

=== Mostrar cliente ===

É pedido o identificador do cliente, sendo apresentadas as informações sobre esse cliente, no [[#Formatos de Apresentação|formato de apresentação de um cliente]].

=== Mostrar clientes ===

Apresenta informações sobre todos os clientes, ordenando-os lexicograficamente pelo nome. Caso existam clientes com o mesmo nome, devem ser ordenados por ordem crescente dos seus identificadores. O formato é o descrito em [[#Mostrar cliente|Mostrar cliente]].

=== Alterar mecanismo de notificação ===

São pedidos o identificador do cliente e o novo mecanismo de notificação ('''Prompt.notificationMedium()'''). As notificações seguintes desse cliente passam a ser produzidas através do mecanismo indicado.

=== Mostrar notificações do cliente ===

É pedido o identificador do cliente, sendo apresentadas as notificações para esse cliente, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação das notificações de um cliente|
''assunto'': ''descrição da encomenda''
}}

O ''assunto'' é '''ENTREGA_AMANHA''' (a encomenda será entregue no dia seguinte) ou '''ENTREGUE''' (a encomenda foi entregue). A descrição da encomenda é a descrição resumida definida em [[#Formatos de Apresentação|Formatos de Apresentação]].

{{CollapsedCode|Exemplos de notificações|
<syntaxhighlight lang="text">
ENTREGA_AMANHA: 1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
ENTREGUE: 1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

As notificações de um cliente apenas devem ser apresentadas uma única vez. Após esta visualização, considera-se que o cliente fica sem notificações. As notificações devem ser apresentadas pela mesma ordem em que foram enviadas pelo sistema.

Note-se que o mecanismo através do qual a notificação foi produzida (correio electrónico, WhatsApp, ...) não altera este formato. No entanto, a solução deve ser suficientemente flexível para permitir outros formatos de apresentação das notificações (sem impacto no código do domínio da aplicação).

== Menu de Gestão de Transportadoras ==

Este menu permite efectuar operações sobre a base de dados de transportadoras. A lista completa é a seguinte: [[#Registar transportadora|Registar transportadora]], [[#Mostrar transportadora|Mostrar transportadora]], [[#Mostrar transportadoras|Mostrar transportadoras]], [[#Definir tarifa|Definir tarifa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.carrier.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.carrier.Prompt''' e '''erp.app.carrier.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.carrier''', respectivamente: '''DoRegisterCarrier''', '''DoShowCarrier''', '''DoShowCarriers''' e '''DoSetRate'''.}}

=== Registar transportadora ===

Pede o nome ('''Prompt.carrierName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CarrierRegistrationFailedException'''.

Note-se que a atribuição do identificador da transportadora é automática e que uma transportadora recém-registada ainda não oferece qualquer modalidade (ver [[#Definir tarifa|Definir tarifa]]).

=== Mostrar transportadora ===

É pedido o identificador da transportadora ('''Prompt.carrierId()'''). Na primeira linha apresenta-se a transportadora; de seguida, as suas tarifas, ordenadas pelo nome da modalidade e indentadas com dois espaços.

{{CollapsedCode|Formato de apresentação de uma transportadora (com tarifas)|
''id'' - ''nome''
␣␣''idTransportadora'' - ''modalidade'' - ''custo adicional'' - ''tempo de transporte''
␣␣...
}}

{{CollapsedCode|Exemplo de apresentação de uma transportadora|
<syntaxhighlight lang="text">
1 - CTT
1 - EXPRESSO - 8 - 1
1 - NORMAL - 3 - 3
</syntaxhighlight>
}}

=== Mostrar transportadoras ===

Apresenta informações sobre todas as transportadoras, ordenando-as pelos seus identificadores, apenas com a linha de resumo (''id'' - ''nome''), sem as tarifas.

=== Definir tarifa ===

São pedidos o identificador da transportadora ('''Prompt.carrierId()'''), a modalidade ('''Prompt.modality()'''), o custo adicional ('''Prompt.rateCost()''') e o tempo de transporte ('''Prompt. rateTransportDays()''').

A transportadora passa a oferecer a modalidade indicada com esses valores, o que é assinalado através da mensagem '''Message.rateSuccessful()'''. Se já oferecia essa modalidade, os valores anteriores são substituídos.

== Menu de Gestão de Compras ==

Este menu apresenta as operações relacionadas com compras e encomendas. A lista completa é a seguinte: [[#Efectuar compra|Efectuar compra]], [[#Mostrar compra|Mostrar compra]], [[#Mostrar compras|Mostrar compras]], [[#Mostrar encomendas de uma compra|Mostrar encomendas de uma compra]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.purchase.Label'''. Os métodos correspondentes aos pedidos deste menu estão definidos em '''erp.app.purchase.Prompt'''. As mensagens do processo de compra pertencem ao [[#Menu de Cabaz|menu de cabaz]] ('''erp.app.basket.Message''').}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.purchase''' (disponível no GIT), respectivamente: '''DoDoPurchase''', '''DoShowPurchase''', '''DoShowPurchases''', '''DoShowPurchaseOrders'''.}}

=== Efectuar compra ===

Esta opção não efectua, por si só, qualquer compra: abre o [[#Menu de Cabaz|menu de cabaz]] sobre o cabaz de um cliente numa empresa.

São pedidos o identificador do cliente e o identificador da empresa. Se ambos existirem, é aberto o [[#Menu de Cabaz|Menu de Cabaz]] sobre o cabaz desse cliente nessa empresa (criado vazio, se ainda não existir).

Como o cabaz pertence ao cliente, sair do menu sem finalizar a compra preserva o seu conteúdo e as suas opções para uma visita posterior.

=== Mostrar compra ===

É pedido o identificador da compra. Na primeira linha apresenta-se a informação da compra; de seguida, apresentam-se as suas encomendas '''em detalhe''' — o cabeçalho de cada encomenda (sem a lista de identificadores de produtos) seguido da descrição completa de cada um dos seus produtos, indentada com dois espaços. As encomendas são apresentadas por ordem crescente da data prevista de entrega e, em caso de empate, pelos identificadores dos produtos.

{{CollapsedCode|Formato de apresentação de uma compra (com encomendas em detalhe)| ''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo''
␣␣''descrição de produto'' ␣␣... }}

{{CollapsedCode|Exemplo de apresentação de uma compra|
<syntaxhighlight lang="text">
1 - 1 - 1 - 1 - 94 - 30 - 124
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 171
</syntaxhighlight>
}}

=== Mostrar compras ===

Apresenta informações sobre todas as compras, ordenando-as pelos seus identificadores, no [[#Formatos de Apresentação|formato de apresentação de uma compra]] (apenas a linha da compra, sem as encomendas).

=== Mostrar encomendas de uma compra ===

É pedido o identificador da compra e são apresentadas as encomendas correspondentes, ordenadas pela data prevista de entrega e, em caso de empate, pelos identificadores dos produtos. Ao contrário de [[#Mostrar compra|Mostrar compra]] (que apresenta as encomendas em detalhe), aqui cada encomenda é apresentada '''de forma resumida''' (uma linha, terminada pela lista de identificadores dos seus produtos), no [[#Formatos de Apresentação|formato de apresentação resumida de uma encomenda]].

{{CollapsedCode|Exemplo de apresentação de encomendas (compra do exemplo anterior)|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

= Leitura de Dados a Partir de Ficheiros Textuais =

Além das opções de manipulação de ficheiros descritas no [[#Menu Principal|menu principal]], é possível iniciar a aplicação com um ficheiro de texto especificado pela propriedade Java '''[[#Execução do Programa e Testes Automáticos|import]]'''.

Cada linha tem uma descrição distinta mas que segue o seguinte formato geral. É possível registar transportadoras, empresas, clientes e produtos, e definir as tarifas das transportadoras e as disponibilizações de produtos por parte das empresas. Assume-se que os campos de texto não podem conter o carácter ''':''' e que os preços são números inteiros. Não existem entradas mal-formadas.

O registo de transportadoras, e das tarifas que cada uma pratica, segue os formatos:
CARRIER:''nome''
RATE:''idTransportadora'':''modalidade'':''custo'':''dias''

As entradas '''RATE''' referem transportadoras já registadas em linhas anteriores. O registo de empresas e de clientes segue os formatos:
COMPANY:''nome''
CLIENT:''nome'':''email''
CLIENT:''nome'':''email'':''mecanismo''

O ''mecanismo'' é '''EMAIL''' ou '''WHATSAPP'''; se for omitido, assume-se '''EMAIL'''. Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:

Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:
NATIONAL:''nome'':''preçoBase'':''categoria'':''prazo''
IMPORTED:''nome'':''preçoBase'':''categoria'':''prazo'':''paisOrigem'':''taxa'':''prazoInternacional''

Note-se que o registo de um produto não indica qualquer empresa nem qualquer inventário: essas são propriedades da disponibilização, descrita por entradas próprias, em que ''unidades'' é o número de exemplares que a empresa tem disponíveis e ''factor'' o multiplicador (real) que aplica ao preço recomendado:
SUPPLY:''idEmpresa'':''idProduto'':''unidades'':''factor''

As entradas '''SUPPLY''' referem empresas e produtos já registados em linhas anteriores.

Um exemplo de conteúdo do ficheiro inicial é como se segue:
{{CollapsedCode|Exemplo de ficheiro de entrada textual|
<syntaxhighlight lang="text">
CARRIER:CTT
RATE:1:NORMAL:3:3
RATE:1:EXPRESSO:8:1
CARRIER:DHL
RATE:2:NORMAL:5:2
RATE:2:EXPRESSO:12:1
CARRIER:SEUR
RATE:3:EXPRESSO:10:1
COMPANY:Moageira Nacional
COMPANY:Importadora Atlantico
CLIENT:Obi-Wan Kenobi:obiwan@jedi.org
CLIENT:Ahsoka Tano:ahsoka@jedi.org:WHATSAPP
NATIONAL:Farinha:15:ALIMENTAR:3
IMPORTED:Telemovel:200:ELECTRONICA:3:China:30:5
NATIONAL:Camisa:45:VESTUARIO:2
SUPPLY:1:1:23:1.0
SUPPLY:2:1:150:0.9
SUPPLY:2:2:2:1.2
SUPPLY:1:3:4:1.1
</syntaxhighlight>
}}

A codificação dos ficheiros a ler é garantidamente [[wp:UTF-8|UTF-8]].

{{Suggestion|Os métodos '''String.split()''', para partir cadeias de caracteres, e '''String.trim()''', para remover espaços no início e no final, podem ser usados no processamento de cada linha.}}
{{Suggestion|Note-se que o programa nunca produz ficheiros com este formato (é apenas um formato para ficheiros de entrada).}}

= Execução do Programa e Testes Automáticos =

Usando os ficheiros '''test.import''', '''test.in''' e '''test.out''', é possível verificar automaticamente o resultado correcto do programa. Note-se que é necessária a definição apropriada da variável '''CLASSPATH''' (ou da opção equivalente '''-cp''' do comando '''java'''), para localizar as classes do programa, incluindo a que contém o método correspondente ao ponto de entrada da aplicação ('''erp.app.App.main'''). As propriedades são tratadas automaticamente pelo código de apoio.

java -Dimport=test.import -Din=test.in -Dout=test.outhyp erp.app.App

Assumindo que aqueles ficheiros estão no directório onde é dado o comando de execução, o programa produz o ficheiro de saída '''test.outhyp'''. Em caso de sucesso, os ficheiros das saídas esperada ('''test.out''') e obtida ('''test.outhyp''') devem ser iguais. A comparação pode ser feita com o comando:
diff -b test.out test.outhyp

Este comando não deve produzir qualquer resultado quando os ficheiros são iguais. Note-se, contudo, que este teste não garante o correcto funcionamento do código desenvolvido, apenas verificando alguns aspectos da sua funcionalidade.

= Notas de Implementação =

Tal como indicado acima, algumas classes fornecidas como [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|material de apoio]], são de uso obrigatório e não podem ser alteradas. Outras dessas classes são de uso obrigatório e têm de ser alteradas.

A serialização Java usa as classes da ''package'' [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/package-summary.html java.io], em particular, a interface [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/Serializable.html java.io. Serializable] e as classes de leitura [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/ObjectInputStream.html java.io.ObjectInputStream] e escrita [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/ObjectOutputStream.html java.io.ObjectOutputStream] (entre outras).

[[category: Ensino]]
[[category:PO]]
[[category: Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T13:55:55Z

Root: /* Menu de Gestão de Produtos */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

'''EM PREPARAÇÃO'''

'''ÉPOCA NORMAL'''

O objectivo do projecto é desenvolver um sistema de gestão de entregas rápidas de produtos (ERP — Express Retail Platform). O sistema deverá permitir, entre outras operações, (i) registar dados de empresas; (ii) registar dados de clientes; (iii) registar, gerir e pesquisar produtos; (iv) efectuar e gerir características de compras; (v) gerir as entregas correspondentes; e (vi) notificar os clientes sobre a situação das suas encomendas.

Neste texto, o tipo '''negrito''' indica um literal (i.e., é exactamente como apresentado); o símbolo ␣ indica um espaço; e o tipo ''itálico'' indica uma parte variável (i.e., uma descrição).

= Conceitos e Relações do Modelo =

Existem vários conceitos importantes neste contexto: [[#Empresas|empresas]], [[#Produtos|produtos]], [[#Clientes|clientes]], [[#Transportadoras|transportadoras]], [[#Cabaz de Compras|cabazes]], [[#Compras|compras]], [[#Divisão das Compras em Encomendas|encomendas]] e [[#Entregas|entregas]].

Os conceitos listados não são os únicos possíveis no modelo e as suas relações (assim como relações com outros conceitos não mencionados) podem depender das escolhas do projecto.

Os clientes e os produtos são independentes das empresas: existem por si e podem relacionar-se com várias empresas. Cada empresa, no entanto, mantém registo dos clientes com quem interage, dos produtos que disponibiliza, das compras feitas e das encomendas que expede.

Uma compra representa a aquisição de produtos por um cliente a uma empresa, e resulta de finalizar um [[#Cabaz de Compras|cabaz]]. Uma compra pode dar origem a uma ou mais encomendas, de acordo com a estratégia de divisão de encomendas utilizada.

Cada encomenda pode ser enviada através de uma determinada transportadora e pode incluir serviços adicionais que alteram o seu custo e/ou prazo de entrega.

== Produtos ==

O sistema mantém um registo global de produtos. Cada produto é identificado por um número de produto. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Todos os produtos têm: um nome/descrição (cadeia de caracteres não vazia); um preço base (número inteiro positivo); uma categoria; e um prazo de entrega base (número inteiro de dias).

O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O sistema utiliza o preço base para calcular o preço recomendado do produto. O preço recomendado representa o valor de referência do produto no sistema. O seu cálculo pode depender do tipo de produto e de outras informações disponíveis no sistema.

Cada produto tem uma categoria, de acordo com a sua natureza. Inicialmente, consideram-se as seguintes categorias: (i) alimentar; (ii) electrónica; e (iii) vestuário. Deve ser possível adicionar novas categorias com impacto mínimo na aplicação já desenvolvida.

O produto existe independentemente das empresas que o disponibilizam. Assim, o mesmo produto pode ser disponibilizado por várias empresas, sendo possível que cada uma pratique um preço de venda diferente.

A informação relativa à disponibilização de um produto por uma empresa não deve ser considerada parte das características intrínsecas do produto.

== Tipos de Produto ==

Todos os produtos considerados no sistema são fabricados, mas podem ter diferentes origens.

Inicialmente, consideram-se os seguintes tipos de produto:
* produto nacional;
* produto importado.

Um produto nacional possui apenas as propriedades gerais dos produtos.

Um produto importado possui, para além das propriedades gerais dos produtos:
* um país de origem (cadeia de caracteres não vazia);
* uma taxa alfandegária (número inteiro expressando uma percentagem);
* um prazo de transporte internacional (número inteiro de dias).

O preço recomendado é calculado de forma diferente consoante o tipo de produto.

Deve ser possível introduzir novos tipos de produto com impacto mínimo na implementação desenvolvida.

=== Produtos Nacionais ===

Para um produto nacional, o preço recomendado depende do preço base e do número total de unidades actualmente disponíveis desse produto nas empresas que o disponibilizam.

Se o número total de unidades disponíveis for:
* superior a 10000, o preço recomendado corresponde a 90% do preço base;
* inferior a 100, o preço recomendado corresponde a 130% do preço base;
* nos restantes casos, o preço recomendado corresponde ao preço base.

Por exemplo, considerando um produto nacional com preço base de 100 euros:
* Unidades disponíveis = 50 => Preço recomendado = 130 euros;
* Unidades disponíveis = 5000 => Preço recomendado = 100 euros;
* Unidades disponíveis = 12000 => Preço recomendado = 90 euros.

=== Produtos Importados ===

Para um produto importado, o preço recomendado corresponde ao preço base acrescido da taxa alfandegária.

Se a taxa alfandegária for '''t%''', o preço recomendado é calculado de acordo com:

'''preço base × (100 + t) / 100'''

Por exemplo, considerando um produto importado com preço base de 100 euros e uma taxa alfandegária de 20%, o preço recomendado será:

'''100 × (100 + 20) / 100 = 120 euros'''

O cálculo do preço recomendado deve ser realizado de forma polimórfica, de modo a que o código que utiliza produtos não tenha de conhecer explicitamente o tipo concreto de cada produto.

== Empresas ==

O sistema mantém um registo das empresas que operam na plataforma. Cada empresa é identificada por um número de empresa. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada empresa tem ainda um nome (cadeia de caracteres não vazia).

Uma empresa pode disponibilizar vários produtos e cada produto pode ser disponibilizado por várias empresas.

Para cada produto que disponibiliza, a empresa deve manter informação sobre:
* número de unidades disponíveis (valor inteiro);
* factor multiplicativo do preço recomendado (número positivo).

O número de unidades disponíveis e o factor multiplicativo podem ser diferentes para cada empresa que disponibiliza o mesmo produto.

O factor multiplicativo permite que uma empresa pratique um preço de venda diferente do preço recomendado pelo sistema. O preço de venda de um produto pela empresa é calculado multiplicando o preço recomendado do produto pelo factor multiplicativo definido pela empresa. Assim, duas empresas podem disponibilizar o mesmo produto a preços diferentes e com quantidades diferentes em stock.

Por exemplo, o produto P1, com um preço recomendado de 100 euros, pode ser disponibilizado pela empresa A com um preço de 90 euros, através de um factor multiplicativo de 0,9. A empresa B pode disponibilizar o mesmo produto com um preço de 120 euros, através de um factor multiplicativo de 1,2.

Deve ser possível adicionar outras propriedades às empresas sem impacto significativo no código já desenvolvido.

== Clientes ==

O sistema mantém um registo de clientes. Cada cliente é identificado por um número de cliente. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada cliente tem ainda informação sobre o seu nome e endereço de correio electrónico. Estes campos não podem ser vazios.

Assume-se que os clientes têm sempre dinheiro, i.e., uma compra nunca é recusada por falta de fundos.

== Compras ==

O sistema regista as compras efectuadas pelos clientes. Cada compra é identificada por um número de compra, atribuído automaticamente e incrementalmente. Uma compra é sempre feita por um único cliente a uma única empresa numa determinada data.

Uma compra é constituída por um conjunto de linhas (um "cabaz"). Cada linha corresponde a:
* um produto;
* uma quantidade (número de exemplares adquiridos desse produto);
* um preço unitário (o preço de venda do produto pela empresa no momento da compra);
* um preço total da linha (quantidade × preço unitário).

O preço unitário utilizado numa compra deve ser guardado na própria linha da compra. Alterações posteriores ao preço base, ao preço recomendado, ao factor multiplicativo da empresa, ou a qualquer outra propriedade utilizada no cálculo do preço, não devem alterar o valor de compras já efectuadas.

O preço total dos itens de uma compra é a soma dos preços totais das suas linhas. Uma compra pode dar origem a uma ou mais encomendas, de acordo com uma estratégia de divisão de encomendas.

A divisão de uma compra em várias encomendas pode ter impacto no custo total da compra.

== Cabaz de Compras ==

Antes de dar origem a uma compra, os produtos que um cliente pretende adquirir a uma empresa são acumulados num '''cabaz'''.

Cada cliente tem um cabaz por cada empresa em que compra. O cabaz é constituído por um conjunto de linhas; cada linha corresponde a um produto disponibilizado por essa empresa e a uma quantidade. Acrescentar ao cabaz um produto que já lá esteja acumula as quantidades.

O cabaz regista ainda as opções que serão aplicadas à compra:
* a [[#Divisão das Compras em Encomendas|estratégia de divisão em encomendas]]; * a [[#Transportadoras|transportadora]] e a [[#Transportadoras|modalidade de transporte]]; e
* o conjunto de [[#Serviços Adicionais|serviços adicionais]].

A transportadora, a modalidade e os serviços adicionais escolhidos aplicam-se a '''todas''' as encomendas resultantes da compra.

Enquanto não for finalizado, o cabaz não tem qualquer efeito no resto do sistema: em particular, não reserva nem consome inventário, e os preços apresentados são sempre os preços de venda praticados pela empresa '''nesse momento'''. Um cabaz faz parte do estado persistente da aplicação: pode ser abandonado e retomado mais tarde.

Ao '''finalizar''' o cabaz, e apenas nesse momento:
* os preços de venda são fixados nas linhas da compra;
* a compra é dividida em encomendas de acordo com a estratégia registada no cabaz;
* todas as encomendas recebem a modalidade de transporte e os serviços adicionais registados no cabaz;
* o inventário dos produtos na empresa é decrementado e o cliente é debitado;
* o cabaz fica vazio.

Um cabaz vazio não pode ser finalizado, nem o pode ser um cabaz em que ainda não tenham sido escolhidas transportadora e modalidade. Se, no momento de finalizar, a empresa já não tiver exemplares suficientes de algum dos produtos do cabaz (por exemplo, porque o inventário foi entretanto alterado), a operação falha sem qualquer efeito e o cabaz mantém-se intacto.

== Divisão das Compras em Encomendas ==

Cada encomenda tem um custo base de processamento e expedição, de '''5 euros'''. Assim, uma compra dividida em várias encomendas pode ter um custo superior ao de uma compra enviada numa única encomenda.

O custo base associado às encomendas corresponde ao número de encomendas multiplicado pelo custo base de uma encomenda.

A este custo podem acrescer os custos associados ao método de transporte seleccionado e aos serviços adicionais.

O custo total de uma compra corresponde, assim, ao custo dos produtos acrescido:
* do custo base das encomendas;
* dos custos adicionais das tarifas de transporte;
* dos custos dos serviços adicionais seleccionados.

A forma como uma compra é dividida em encomendas é determinada por uma estratégia de divisão de encomendas. Inicialmente, devem ser suportadas, pelo menos, as seguintes estratégias: encomenda única ('''UNICA''') e agrupamento por prazo de entrega ('''PRAZO''').

=== Encomenda única ===

Todos os produtos da compra são colocados numa única encomenda.

Neste caso, a compra origina uma única encomenda, independentemente dos prazos de entrega dos produtos.

=== Agrupamento por prazo de entrega ===

Os produtos são agrupados de acordo com os seus prazos de entrega.

Calcula-se a média dos prazos de entrega dos produtos das linhas da compra:
* todas as linhas cujo produto tem prazo menor ou igual à média são agrupadas numa única encomenda;
* cada linha cujo produto tem prazo estritamente maior do que a média é enviada separadamente, numa encomenda própria.

Por exemplo, considere-se uma compra com três linhas cujos produtos têm os prazos de entrega 3 (P1), 8 (P2) e 2 (P3). A média dos prazos é (3 + 8 + 2) / 3 ≈ 4,33. Logo, P1 e P3 (prazos ≤ 4,33) seguem juntos numa entrega e P2 (prazo > 4,33) segue numa outra encomenda:
* Encomenda A: {P1, P3} (prazo = 3)
* Encomenda B: {P2} (prazo = 8)

Uma estratégia de divisão que origina várias encomendas pode permitir que alguns produtos sejam entregues mais cedo, mas pode também resultar num custo superior devido ao custo associado a cada encomenda.

Deve ser possível introduzir novas estratégias de divisão de compras em encomendas com impacto mínimo na implementação desenvolvida.

== Transportadoras ==

O sistema mantém um registo das '''transportadoras''' que operam na plataforma. Cada transportadora é identificada por um número de transportadora. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada transportadora tem ainda um nome (cadeia de caracteres não vazia).

Cada encomenda é enviada através de uma transportadora, segundo uma '''modalidade de transporte'''. Inicialmente, devem ser suportadas, pelo menos, as seguintes modalidades: normal ('''NORMAL''') e expresso ('''EXPRESSO''').

Uma modalidade '''não''' define, por si só, qualquer custo ou prazo: é apenas o nome de um nível de serviço. Para cada modalidade que oferece, uma transportadora define uma '''tarifa''', constituída por:
* um custo adicional (número inteiro); e
* um tempo de transporte (número inteiro de dias).

Assim, a mesma modalidade pode custar e demorar valores diferentes consoante a transportadora.

Uma transportadora '''não tem de oferecer todas as modalidades''': oferece exactamente aquelas para as quais tenha uma tarifa definida. Pedir a uma transportadora uma modalidade que ela não oferece é um erro, e não uma escolha silenciosamente ignorada — ver [[#Definir modalidade de transporte|Definir modalidade de transporte]].

Entre os dois, '''a transportadora tem precedência sobre a modalidade''': como as modalidades disponíveis são as da transportadora, só se pode escolher uma modalidade depois de escolhida a transportadora, e mudar de transportadora anula a modalidade anteriormente escolhida (que passa a ser escolhida de novo, de entre as que a nova transportadora oferece).

Por exemplo:
{|
! style="background: #ebebeb;" | '''Transportadora'''
! style="background: #ebebeb;" | '''Modalidade'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo de transporte'''
|-
| CTT || '''NORMAL''' || 3 euros || 3 dias
|-
| CTT || '''EXPRESSO''' || 8 euros || 1 dia
|-
| DHL || '''NORMAL''' || 5 euros || 2 dias
|-
| DHL || '''EXPRESSO''' || 12 euros || 1 dia
|-
| SEUR || '''EXPRESSO''' || 10 euros || 1 dia
|}

No exemplo acima, a transportadora SEUR só oferece a modalidade expresso: não é possível enviar por SEUR em modalidade normal.

A transportadora e a modalidade são escolhidas no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda seja enviada por uma transportadora ou modalidade diferente.

A escolha da transportadora e da modalidade afecta tanto o custo como a data prevista de entrega da encomenda. Uma compra só pode ser finalizada depois de escolhidas ambas, e o par transportadora/modalidade de um cabaz é sempre um par que a transportadora oferece.

Deve ser possível introduzir novas modalidades de transporte com impacto mínimo na implementação desenvolvida. As transportadoras e as suas tarifas, por seu lado, fazem parte do estado da aplicação: são registadas pelo utilizador e não implicam qualquer alteração ao código.

== Serviços Adicionais ==

O cliente pode seleccionar serviços adicionais, podendo aumentar o custo de cada encomenda, assim como o tempo necessário para a sua preparação e entrega. Os serviços são escolhidos no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda tenha os seus próprios serviços.

Os serviços iniciais são os seguintes:
{|
! style="background: #ebebeb;" | '''Serviço'''
! style="background: #ebebeb;" | '''Chave'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo adicional'''
|-
| Embrulho || '''EMBRULHO''' || 2 euros || 1 dia
|-
| Cartão de oferta || '''CARTAO_OFERTA''' || 1 euro || 0 dias
|}

Os serviços adicionais podem ser combinados: uma encomenda pode incluir simultaneamente embrulho, cartão de oferta ou outro serviço adicional. O custo e o tempo adicionais de uma encomenda correspondem à soma dos contributos da modalidade de transporte e de todos os serviços seleccionados.

Deve ser possível introduzir novos serviços adicionais sem alterar o código das encomendas ou dos serviços já existentes.

== Entregas ==

Cada encomenda tem uma data prevista de entrega.
A data prevista de entrega é determinada considerando:
* a data da compra;
* os prazos de entrega dos produtos que constituem a encomenda;
* o tempo de transporte da tarifa da transportadora seleccionada;
* o tempo adicional introduzido pelos serviços seleccionados.

Para uma encomenda com vários produtos, o prazo dos produtos considerados para determinar a data prevista de entrega corresponde ao maior prazo de entrega dos seus produtos.

Não é necessário manter explicitamente um estado para representar se uma encomenda está ou não entregue. A situação da encomenda pode ser determinada a partir da data actual e da sua data prevista de entrega. Assim, uma encomenda é considerada entregue quando a data actual atinge ou ultrapassa a sua data prevista de entrega.

== Gestão de Tempo ==

A unidade de tempo do sistema é o dia. A data do sistema começa no dia 1 (um) e faz parte do estado persistente.

A data do sistema pode ser avançada. Sempre que a data é alterada, devem ser verificadas as encomendas existentes para determinar:
* quais as encomendas que serão entregues no dia seguinte;
* quais as encomendas cuja data prevista de entrega foi atingida ou ultrapassada.

Quando a data actual atinge ou ultrapassa a data prevista de entrega de uma encomenda, esta considera-se entregue.

A gestão do tempo deve ainda desencadear [[#Notificações|notificações]].

== Pesquisas ==

Para permitir que os clientes determinem a existência de um produto, deverá ser possível efectuar pesquisas.

As pesquisas consideram os campos relevantes dos vários produtos, por exemplo, nome, categoria, tipo de produto ou país de origem.

O termo de pesquisa deve ser comparado sem distinção entre letras maiúsculas e minúsculas.

O sistema deve suportar diferentes critérios de pesquisa. Por exemplo, uma pesquisa pode procurar produtos cujo nome contenha determinado termo ou produtos pertencentes a determinada categoria.

Deve ser possível introduzir novos métodos de pesquisa de produtos com impacto mínimo na implementação desenvolvida.

== Alterações de Inventário ==

O inventário de um produto numa empresa pode ser alterado através da especificação de um valor a somar ou subtrair ao número de exemplares disponíveis. Se a quantidade indicada for um valor positivo, aumenta-se o número de exemplares disponíveis.
Se a quantidade indicada for um valor negativo, decrementa-se o número de exemplares disponíveis, desde que o número de exemplares disponíveis não fique negativo.

Um produto não é removido do sistema quando o seu inventário numa empresa chega a zero.
Quando o inventário de um produto numa empresa chega a zero, o produto deixa de estar disponível nessa empresa, mas continua a existir no sistema e pode continuar a ser disponibilizado por outras empresas.
Se o inventário de um produto numa empresa passar de zero para um valor positivo, o produto volta a estar disponível nessa empresa.

O número total de unidades disponíveis de um produto corresponde à soma dos inventários desse produto em todas as empresas que o disponibilizam.

Esta informação é utilizada, nomeadamente, no cálculo do preço recomendado dos produtos nacionais.

== Notificações ==

O sistema deve notificar os clientes relativamente às suas encomendas.

Devem ser enviadas notificações em duas situações:
* um dia antes da data prevista de entrega, informando o cliente de que a encomenda será entregue no dia seguinte;
* no dia da entrega, informando o cliente de que a encomenda foi entregue.

Cada notificação deve ser enviada através do mecanismo de notificação seleccionado pelo cliente.
Inicialmente, devem ser suportados, pelo menos, os seguintes mecanismos:
* correio electrónico ('''EMAIL''');
* WhatsApp ('''WHATSAPP''').

Cada cliente pode escolher o mecanismo através do qual pretende receber notificações do sistema. O mecanismo de notificação pode variar de cliente para cliente. Por exemplo, um cliente pode receber notificações por correio electrónico, enquanto outro pode recebê-las através de WhatsApp.
Deve ser possível introduzir novos mecanismos de notificação sem necessidade de alterar o código dos clientes ou do sistema responsável por gerar as notificações.

Deve ser possível introduzir novos mecanismos de notificação com impacto mínimo na implementação desenvolvida.

As notificações devem ser enviadas pela ordem em que os acontecimentos ocorrem no sistema.

= Requisitos de Desenho =

A aplicação a desenvolver deve seguir o princípio de desenho aberto-fechado, por forma a aumentar a extensibilidade do seu código. Por exemplo, deve ser possível adicionar novos tipos de produto com um impacto mínimo no código já existente da aplicação.

Devem ser possíveis extensões ou alterações de funcionalidade com impacto mínimo no código já produzido para a aplicação. O objectivo é aumentar a flexibilidade da aplicação relativamente ao suporte de novas funções. Assim, deve ser possível:
* Adicionar novos tipos de produto (e.g., produtos digitais ou perecíveis), incluindo a respectiva regra de cálculo do preço recomendado; * Adicionar novas categorias de produto;
* Introduzir novas estratégias de divisão de compras em encomendas;
* Introduzir novas modalidades de transporte (os custos e prazos de cada uma são dados de cada transportadora, não código; nem todas as transportadoras têm de oferecer todas as modalidades);
* Introduzir novos serviços adicionais, sem alterar o código das encomendas nem o dos serviços já existentes;
* Introduzir novos mecanismos de notificação, sem alterar o código dos clientes nem o do sistema que gera as notificações;
* Introduzir novos critérios de discriminação/classificação dos clientes;
* Introduzir novos critérios de pesquisa de produtos.

= Funcionalidade da aplicação =

A aplicação permite manter informação sobre as entidades do modelo, permitindo, em particular, gerir empresas, produtos, clientes e compras. Possui ainda a capacidade de preservar o seu estado (não é possível manter várias versões do estado da aplicação em simultâneo).

Nenhuma entidade é removida pelas operações descritas neste enunciado (em particular, um produto cujo inventário numa empresa chegue a zero continua a existir no sistema). Ainda assim, a aplicação deve estar preparada para que a remoção de qualquer entidade possa vir a ser suportada.

No [[#Leitura de Dados a Partir de Ficheiros Textuais|início]], a aplicação está vazia, mas pode ser carregada uma base de dados textual com conceitos pré-definidos. Neste caso, a aplicação começará com um estado referente às entidades que foram carregadas no arranque da aplicação.

{{Suggestion|Note-se que não é necessário implementar de raiz a aplicação: já existem classes que representam e definem a interface geral da funcionalidade do ''core'' da aplicação, tal como é visível pelos comandos da aplicação.}}
{{CVSCode|A interface geral do ''core'' já está parcialmente implementada na classe '''erp.ErpManager''' e outras fornecidas (cujos nomes devem ser mantidos), devendo ser adaptadas onde necessário. É ainda necessário criar e implementar as restantes classes que suportam a operação da aplicação.}}

== Serialização ==

É possível guardar e recuperar o estado actual da aplicação, preservando toda a informação relacionada com o ERP e que foi descrita [[#Conceitos e Relações do Modelo|acima]].

Após a recuperação do estado, os identificadores atribuídos a novas entidades devem continuar a ser atribuídos incrementalmente a partir do último valor utilizado em cada caso.

= Interacção com o utilizador =

Descreve-se nesta secção a '''funcionalidade máxima''' da interface com o utilizador. Em geral, os comandos pedem toda a informação antes de procederem à sua validação (excepto onde indicado). Todos os menus têm automaticamente a opção '''Sair''' (fecha o menu).

As operações de pedido e apresentação de informação ao utilizador '''devem''' realizar-se através dos objectos ''form'' e ''display'', respectivamente, presentes em cada comando. As mensagens são produzidas pelos métodos das [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|bibliotecas de suporte]] ('''po-uilib''' e '''erp-app'''). As mensagens não podem ser usadas no núcleo da aplicação ('''erp-core'''). Além disso, não podem ser definidas novas. Potenciais omissões devem ser esclarecidas antes de qualquer implementação.

De um modo geral, sempre que no contexto de uma operação com o utilizador aconteça alguma excepção, então a operação não deve ter qualquer efeito no estado da aplicação, excepto em caso de indicação contrária na operação em causa. As excepções estão na package '''erp.app.exceptions''', excepto em caso de indicação contrária.

As excepções usadas na interacção (subclasses de '''pt.tecnico.uilib.menus.CommandException'''), excepto em caso de indicação contrária, são lançadas pelos comandos (subclasses de '''pt.tecnico.uilib.menus.Command''') e tratadas pelos menus (instâncias de subclasses de '''pt.tecnico.uilib.menus.Menu'''). Outras excepções não devem substituir as fornecidas nos casos descritos.

Nos pedidos e usos dos vários identificadores, podem ocorrer as seguintes excepções, caso o identificador indicado não corresponda a um objecto conhecido (excepto no processo de registo ou em caso de indicação contrária). Note-se que estas excepções não são utilizáveis no núcleo da aplicação.

{|
! style="background: #ebebeb;" | '''Tipo de dados'''
! style="background: #ebebeb;" | '''Classe'''
! style="background: #ebebeb;" | '''Pedido a apresentar'''
! style="background: #ebebeb;" | '''Excepção a lançar se desconhecido'''
|-
| Empresa
| '''Company'''
| '''erp.app.company.Prompt.companyId()'''
| '''erp.app.exceptions.UnknownCompanyKeyException'''
|-
| Produto
| '''Product'''
| '''erp.app.product.Prompt.productId()'''
| '''erp.app.exceptions.UnknownProductKeyException'''
|-
| Cliente
| '''Client'''
| '''erp.app.client.Prompt.clientId()'''
| '''erp.app.exceptions.UnknownClientKeyException'''
|-
| Transportadora
| '''Carrier'''
| '''erp.app.carrier.Prompt.carrierId()'''
| '''erp.app.exceptions.UnknownCarrierKeyException'''
|-
| Compra
| '''Purchase'''
| '''erp.app.purchase.Prompt.purchaseId()'''
| '''erp.app.exceptions.UnknownPurchaseKeyException'''
|}

Existe ainda um caso particular: sempre que uma operação se refira a um produto '''no contexto de uma empresa''' e essa empresa não disponibilize esse produto, deve ser lançada a excepção '''erp.app.exceptions.ProductNotSuppliedException''' (a empresa e o produto existem, mas não estão relacionados).

Alguns casos particulares podem usar pedidos específicos não apresentados nesta tabela.

Vários comandos pedem ao utilizador que escolha um valor de um conjunto fechado (tipo de produto, categoria, estratégia de divisão, modalidade de transporte, serviço adicional, mecanismo de notificação e critério de pesquisa). Estas escolhas '''devem''' ser pedidas através de campos de opção ('''Form.addOptionField()''' ou '''Form.requestOption()'''), sendo o conjunto de opções obtido do núcleo através da fachada. Desta forma, a introdução de uma nova estratégia, modalidade, serviço, mecanismo ou critério não implica qualquer alteração aos comandos.

{{CVSCode|Note-se que o programa principal e os comandos e menus, a seguir descritos, já estão parcial ou completamente implementados nas ''packages'' '''erp.app''', '''erp.app.main''', '''erp.app.company''', '''erp.app.product''', '''erp.app.client''', '''erp.app.purchase'''. Estas classes são de uso obrigatório e estão disponíveis no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|GIT]] (módulo '''erp-app''').}}

== Formatos de Apresentação ==

Os formatos usados pelos vários comandos são os seguintes. Todos os campos são separados por '''␣-␣'''.

{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma transportadora|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma tarifa|
''idTransportadora'' - ''modalidade'' - ''custo adicional'' - ''tempo de transporte''
}}

{{CollapsedCode|Formato de apresentação de um produto|
''id'' - ''tipo'' - ''nome'' - ''categoria'' - ''preço base'' - ''preço recomendado'' - ''prazo base'' - ''unidades totais'' - ''informação adicional''
}}

O ''tipo'' é '''NACIONAL''' ou '''IMPORTADO'''. As ''unidades totais'' correspondem à soma dos inventários do produto em todas as empresas que o disponibilizam. Para produtos nacionais não existe informação adicional; para produtos importados, a informação adicional corresponde ao país de origem, à taxa alfandegária e ao prazo de transporte internacional.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 173
2 - IMPORTADO - Telemovel - ELECTRONICA - 200 - 260 - 3 - 2 - China - 30 - 5
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 0
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação da disponibilização de um produto por uma empresa|
''idEmpresa'' - ''idProduto'' - ''unidades'' - ''factor'' - ''preço de venda''
}}

{{CollapsedCode|Exemplos de apresentação de disponibilizações|
<syntaxhighlight lang="text">
2 - 1 - 150 - 0.9 - 14
2 - 2 - 2 - 1.2 - 312
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''mecanismo de notificação'' - ''gasto total''
}}

O valor apresentado no fim corresponde ao total gasto pelo cliente em compras (um valor inteiro).

{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Ahsoka Tano - ahsoka@jedi.org - WHATSAPP - 0
1 - Obi-Wan Kenobi - obiwan@jedi.org - EMAIL - 124
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de uma compra|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
}}

{{CollapsedCode|Formato de apresentação (resumida) de uma encomenda|
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo'' - ''lista de identificadores de produtos''
}}

A ''descrição do transporte'' é o nome da transportadora e a modalidade seleccionadas, separados por '''/''', seguidos das chaves dos serviços adicionais seleccionados, separadas por '''+''' (por exemplo, '''DHL/ EXPRESSO+EMBRULHO+CARTAO_OFERTA'''). O ''custo'' de uma encomenda é o custo base de processamento acrescido do custo da modalidade e dos serviços.

{{CollapsedCode|Exemplos de apresentação de encomendas|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

== Menu Principal ==

As acções deste menu permitem gerir a salvaguarda do estado da aplicação e abrir submenus. A lista completa é a seguinte: [[#Salvaguarda do estado actual da aplicação|Abrir]], [[#Salvaguarda do estado actual da aplicação|Guardar]], [[#Mostrar data actual|Mostrar data actual]], [[#Avançar data actual|Avançar data actual]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Empresas]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Produtos]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Clientes]] e [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Compras]]. Inicialmente, a aplicação apenas tem informação sobre as entidades que foram carregadas no arranque.

{{CVSCode|As etiquetas das opções deste menu estão definidas na classe '''erp.app.main.Label'''. Todos os métodos correspondentes às mensagens de diálogo para este menu estão definidos na classe '''erp.app.main.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.main''', respectivamente: '''DoOpenFile''', '''DoSaveFile''', '''DoDisplayDate''', '''DoAdvanceDate''', '''DoOpenMenuCompanies''', '''DoOpenMenuProducts''', '''DoOpenMenuClients''', '''DoOpenMenuPurchases'''.}}

=== Salvaguarda do estado actual da aplicação ===

O conteúdo da aplicação (toda a informação detida pelo ERP actualmente em memória) pode ser guardado para posterior recuperação (via serialização Java: '''java.io.Serializable'''). Na leitura e escrita do estado da aplicação, devem ser tratadas as excepções associadas. A funcionalidade é a seguinte:

* '''Abrir''' -- Carrega os dados de uma sessão anterior a partir de um ficheiro previamente guardado (ficando este ficheiro associado à aplicação, para futuras operações de salvaguarda). Pede-se o nome do ficheiro a abrir ('''Prompt.openFile()'''). Caso ocorra um problema na abertura ou processamento do ficheiro, deve ser lançada a excepção '''FileOpenFailedException'''. A execução bem-sucedida desta opção substitui toda a informação da aplicação. Quando se abandona uma aplicação com modificações não guardadas (porque se abre outra e existem alterações não guardadas), deve perguntar-se ao utilizador se quer guardar a informação actual antes de a abandonar, através de '''Prompt.saveBeforeExit()''' (a resposta é obtida via '''Form.confirm()''').

* '''Guardar''' -- Guarda o estado actual da aplicação no ficheiro associado. Se não existir associação, pede-se o nome do ficheiro a utilizar, ficando a ele associado (para operações de salvaguarda subsequentes). Esta interacção realiza-se através do método '''Prompt.newSaveAs()'''. Não é executada nenhuma acção se não existirem alterações desde a última salvaguarda.

{{Suggestion|Note-se que a opção '''Abrir''' não permite a leitura de ficheiros de texto (estes apenas podem ser utilizados no início da aplicação).}}
{{Suggestion|A opção '''Sair''' nunca implica a salvaguarda do estado da aplicação, mesmo que existam alterações.}}

=== Mostrar data actual ===

A data actual do sistema é apresentada através da mensagem '''Message.currentDate()'''.

=== Avançar data actual ===

O número de dias a avançar é pedido através de '''Prompt.daysToAdvance()'''. O valor indicado deve ser positivo. Caso contrário, a operação não tem efeito.

Além da data, o sistema deve actualizar, caso seja necessário, outros aspectos que dela dependam, designadamente, a situação das entregas relativa às suas datas de chegada.

=== Gestão e consulta de dados da aplicação ===

* '''Menu de Gestão de Empresas''' -- Abre o menu de gestão de empresas e operações associadas.
* '''Menu de Gestão de Produtos''' -- Abre o menu de gestão de produtos e operações associadas.
* '''Menu de Gestão de Clientes''' -- Abre o menu de gestão de clientes e operações associadas.
* '''Menu de Gestão de Compras''' -- Abre o menu de gestão de compras e operações associadas.

== Menu de Gestão de Empresas ==

Este menu permite efectuar operações sobre a base de dados de empresas. A lista completa é a seguinte: [[#Registar empresa|Registar empresa]], [[#Mostrar empresa|Mostrar empresa]], [[#Mostrar empresas|Mostrar empresas]], [[#Mostrar produtos de uma empresa|Mostrar produtos de uma empresa]], [[#Mostrar clientes de uma empresa|Mostrar clientes de uma empresa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.company.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.company.Prompt''' e '''erp.app.company.Message'''.}}

=== Registar empresa ===

Pede o nome ('''Prompt.companyName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CompanyRegistrationFailedException'''.

Note-se que a atribuição do identificador da empresa é automática.

=== Mostrar empresa ===

É pedido o identificador da empresa, sendo apresentadas as informações sobre essa empresa, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

=== Mostrar empresas ===

Apresenta informações sobre todas as empresas, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar empresa|Mostrar empresa]].

=== Mostrar produtos de uma empresa ===

É pedido o identificador da empresa e apresentam-se os produtos que essa empresa vende, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar produto|Mostrar produto]].

=== Mostrar clientes de uma empresa ===

É pedido o identificador da empresa e apresentam-se os clientes que já interagiram com essa empresa, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar cliente|Mostrar cliente]].

== Menu de Gestão de Produtos ==

Este menu apresenta as operações disponíveis sobre produtos. A lista completa é a seguinte: [[#Registar produto|Registar produto]], [[#Mostrar produto|Mostrar produto]], [[#Mostrar produtos|Mostrar produtos]], [[#Alterar inventário de um produto|Alterar inventário de um produto]] e [[#Efectuar pesquisa|Efectuar pesquisa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.product.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.product.Prompt''' e '''erp.app.product.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.product''' (disponível no GIT), respectivamente: '''DoRegisterProduct''', '''DoShowProduct''', '''DoShowProducts''', '''DoChangeProductInventory''', '''DoPerformSearch'''.}}

=== Registar produto ===

Regista um produto no registo global de produtos. São pedidos, por esta ordem: o tipo de produto ('''Prompt.productType()'''), o nome ('''Prompt.productName()'''), o preço base ('''Prompt.basePrice()'''), a categoria ('''Prompt.productCategory()''') e o prazo de entrega base ('''Prompt.baseDelay()''').

Se o tipo indicado for '''IMPORTADO''', são ainda pedidos o país de origem ('''Prompt.originCountry()'''), a taxa alfandegária ('''Prompt.customsTax()''') e o prazo de transporte internacional ('''Prompt.internationalDelay()''').

O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''ProductRegistrationFailedException'''.

Note-se que a atribuição do identificador do produto é automática e que um produto registado não é, por si só, disponibilizado por qualquer empresa (ver [[#Disponibilizar produto|Disponibilizar produto]]).

=== Mostrar produto ===

É pedido o identificador do produto. Se o produto existir, é apresentado no [[#Formatos de Apresentação|formato de apresentação de um produto]].

=== Mostrar produtos ===

Apresenta informações sobre todos os produtos, ordenando-os pelos seus identificadores. O formato de apresentação é como descrito em [[#Mostrar produto|Mostrar produto]].

=== Alterar inventário de um produto ===

O inventário é uma propriedade da disponibilização de um produto por uma empresa. São pedidos o identificador da empresa, o identificador do produto e uma quantidade ('''Prompt.amountToUpdate()'''), sendo a quantidade indicada somada ao número de exemplares que essa empresa tem disponíveis.

No caso de não ser possível actualizar o número de exemplares devido ao facto de a quantidade indicada ser inválida (tornaria o inventário negativo), então a operação não deve ter qualquer efeito e deve ser apresentada a mensagem '''Message.notEnoughInventory()'''.

Note-se que o produto '''não''' é removido do sistema quando o seu inventário numa empresa chega a zero.

=== Efectuar pesquisa ===

Esta opção realiza uma procura sobre o registo de produtos. São pedidos o critério de pesquisa ('''Prompt.searchCriterion()''') e um termo ('''Prompt.searchTerm()''').

Os critérios iniciais são: '''NOME''', '''CATEGORIA''', '''TIPO''' e '''ORIGEM''' (país de origem, que apenas os produtos importados possuem).

Como resultado, deve ser apresentada uma lista dos produtos encontrados pela pesquisa, ordenados por ordem crescente do seu identificador, utilizando o formato descrito para [[#Mostrar produto|Mostrar produto]]. O termo de pesquisa é comparado sem distinção entre letras maiúsculas e minúsculas. Caso não sejam encontrados produtos, não deve ser produzido qualquer resultado.

== Menu de Gestão de Clientes ==

Este menu permite efectuar operações sobre a base de dados de clientes. A lista completa é a seguinte: [[#Registar cliente|Registar cliente]], [[#Mostrar cliente|Mostrar cliente]], [[#Mostrar clientes|Mostrar clientes]], [[#Alterar mecanismo de notificação|Alterar mecanismo de notificação]], [[#Mostrar notificações do cliente|Mostrar notificações do cliente]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.client.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.client.Prompt''' e '''erp. app.client.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.client''', respectivamente: '''DoRegisterClient''', '''DoShowClient''', '''DoShowClients''', '''DoSetNotificationMedium''', '''DoShowClientNotifications'''.}}

=== Registar cliente ===

Pede o nome ('''Prompt.clientName()'''), o endereço de correio electrónico ('''Prompt.clientEMail()''') e o mecanismo de notificação pretendido ('''Prompt.notificationMedium()'''). O registo bem sucedido é assinalado através da mensagem '''Message. registrationSuccessful()'''; caso contrário, é lançada a excepção '''ClientRegistrationFailedException'''.

Note-se que a atribuição do identificador do cliente é automática e que clientes diferentes são registados em cada operação de registo.

=== Mostrar cliente ===

É pedido o identificador do cliente, sendo apresentadas as informações sobre esse cliente, no [[#Formatos de Apresentação|formato de apresentação de um cliente]].

=== Mostrar clientes ===

Apresenta informações sobre todos os clientes, ordenando-os lexicograficamente pelo nome. Caso existam clientes com o mesmo nome, devem ser ordenados por ordem crescente dos seus identificadores. O formato é o descrito em [[#Mostrar cliente|Mostrar cliente]].

=== Alterar mecanismo de notificação ===

São pedidos o identificador do cliente e o novo mecanismo de notificação ('''Prompt.notificationMedium()'''). As notificações seguintes desse cliente passam a ser produzidas através do mecanismo indicado.

=== Mostrar notificações do cliente ===

É pedido o identificador do cliente, sendo apresentadas as notificações para esse cliente, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação das notificações de um cliente|
''assunto'': ''descrição da encomenda''
}}

O ''assunto'' é '''ENTREGA_AMANHA''' (a encomenda será entregue no dia seguinte) ou '''ENTREGUE''' (a encomenda foi entregue). A descrição da encomenda é a descrição resumida definida em [[#Formatos de Apresentação|Formatos de Apresentação]].

{{CollapsedCode|Exemplos de notificações|
<syntaxhighlight lang="text">
ENTREGA_AMANHA: 1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
ENTREGUE: 1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

As notificações de um cliente apenas devem ser apresentadas uma única vez. Após esta visualização, considera-se que o cliente fica sem notificações. As notificações devem ser apresentadas pela mesma ordem em que foram enviadas pelo sistema.

Note-se que o mecanismo através do qual a notificação foi produzida (correio electrónico, WhatsApp, ...) não altera este formato. No entanto, a solução deve ser suficientemente flexível para permitir outros formatos de apresentação das notificações (sem impacto no código do domínio da aplicação).

== Menu de Gestão de Transportadoras ==

Este menu permite efectuar operações sobre a base de dados de transportadoras. A lista completa é a seguinte: [[#Registar transportadora|Registar transportadora]], [[#Mostrar transportadora|Mostrar transportadora]], [[#Mostrar transportadoras|Mostrar transportadoras]], [[#Definir tarifa|Definir tarifa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.carrier.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.carrier.Prompt''' e '''erp.app.carrier.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.carrier''', respectivamente: '''DoRegisterCarrier''', '''DoShowCarrier''', '''DoShowCarriers''' e '''DoSetRate'''.}}

=== Registar transportadora ===

Pede o nome ('''Prompt.carrierName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CarrierRegistrationFailedException'''.

Note-se que a atribuição do identificador da transportadora é automática e que uma transportadora recém-registada ainda não oferece qualquer modalidade (ver [[#Definir tarifa|Definir tarifa]]).

=== Mostrar transportadora ===

É pedido o identificador da transportadora ('''Prompt.carrierId()'''). Na primeira linha apresenta-se a transportadora; de seguida, as suas tarifas, ordenadas pelo nome da modalidade e indentadas com dois espaços.

{{CollapsedCode|Formato de apresentação de uma transportadora (com tarifas)|
''id'' - ''nome''
␣␣''idTransportadora'' - ''modalidade'' - ''custo adicional'' - ''tempo de transporte''
␣␣...
}}

{{CollapsedCode|Exemplo de apresentação de uma transportadora|
<syntaxhighlight lang="text">
1 - CTT
1 - EXPRESSO - 8 - 1
1 - NORMAL - 3 - 3
</syntaxhighlight>
}}

=== Mostrar transportadoras ===

Apresenta informações sobre todas as transportadoras, ordenando-as pelos seus identificadores, apenas com a linha de resumo (''id'' - ''nome''), sem as tarifas.

=== Definir tarifa ===

São pedidos o identificador da transportadora ('''Prompt.carrierId()'''), a modalidade ('''Prompt.modality()'''), o custo adicional ('''Prompt.rateCost()''') e o tempo de transporte ('''Prompt. rateTransportDays()''').

A transportadora passa a oferecer a modalidade indicada com esses valores, o que é assinalado através da mensagem '''Message.rateSuccessful()'''. Se já oferecia essa modalidade, os valores anteriores são substituídos.

== Menu de Gestão de Compras ==

Este menu apresenta as operações relacionadas com compras e encomendas. A lista completa é a seguinte: [[#Efectuar compra|Efectuar compra]], [[#Mostrar compra|Mostrar compra]], [[#Mostrar compras|Mostrar compras]], [[#Mostrar encomendas de uma compra|Mostrar encomendas de uma compra]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.purchase.Label'''. Os métodos correspondentes aos pedidos deste menu estão definidos em '''erp.app.purchase.Prompt'''. As mensagens do processo de compra pertencem ao [[#Menu de Cabaz|menu de cabaz]] ('''erp.app.basket.Message''').}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.purchase''' (disponível no GIT), respectivamente: '''DoDoPurchase''', '''DoShowPurchase''', '''DoShowPurchases''', '''DoShowPurchaseOrders'''.}}

=== Efectuar compra ===

Esta opção não efectua, por si só, qualquer compra: abre o [[#Menu de Cabaz|menu de cabaz]] sobre o cabaz de um cliente numa empresa.

São pedidos o identificador do cliente e o identificador da empresa. Se ambos existirem, é aberto o [[#Menu de Cabaz|Menu de Cabaz]] sobre o cabaz desse cliente nessa empresa (criado vazio, se ainda não existir).

Como o cabaz pertence ao cliente, sair do menu sem finalizar a compra preserva o seu conteúdo e as suas opções para uma visita posterior.

=== Mostrar compra ===

É pedido o identificador da compra. Na primeira linha apresenta-se a informação da compra; de seguida, apresentam-se as suas encomendas '''em detalhe''' — o cabeçalho de cada encomenda (sem a lista de identificadores de produtos) seguido da descrição completa de cada um dos seus produtos, indentada com dois espaços. As encomendas são apresentadas por ordem crescente da data prevista de entrega e, em caso de empate, pelos identificadores dos produtos.

{{CollapsedCode|Formato de apresentação de uma compra (com encomendas em detalhe)| ''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo''
␣␣''descrição de produto'' ␣␣... }}

{{CollapsedCode|Exemplo de apresentação de uma compra|
<syntaxhighlight lang="text">
1 - 1 - 1 - 1 - 94 - 30 - 124
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 171
</syntaxhighlight>
}}

=== Mostrar compras ===

Apresenta informações sobre todas as compras, ordenando-as pelos seus identificadores, no [[#Formatos de Apresentação|formato de apresentação de uma compra]] (apenas a linha da compra, sem as encomendas).

=== Mostrar encomendas de uma compra ===

É pedido o identificador da compra e são apresentadas as encomendas correspondentes, ordenadas pela data prevista de entrega e, em caso de empate, pelos identificadores dos produtos. Ao contrário de [[#Mostrar compra|Mostrar compra]] (que apresenta as encomendas em detalhe), aqui cada encomenda é apresentada '''de forma resumida''' (uma linha, terminada pela lista de identificadores dos seus produtos), no [[#Formatos de Apresentação|formato de apresentação resumida de uma encomenda]].

{{CollapsedCode|Exemplo de apresentação de encomendas (compra do exemplo anterior)|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

= Leitura de Dados a Partir de Ficheiros Textuais =

Além das opções de manipulação de ficheiros descritas no [[#Menu Principal|menu principal]], é possível iniciar a aplicação com um ficheiro de texto especificado pela propriedade Java '''[[#Execução do Programa e Testes Automáticos|import]]'''.

Cada linha tem uma descrição distinta mas que segue o seguinte formato geral. É possível registar transportadoras, empresas, clientes e produtos, e definir as tarifas das transportadoras e as disponibilizações de produtos por parte das empresas. Assume-se que os campos de texto não podem conter o carácter ''':''' e que os preços são números inteiros. Não existem entradas mal-formadas.

O registo de transportadoras, e das tarifas que cada uma pratica, segue os formatos:
CARRIER:''nome''
RATE:''idTransportadora'':''modalidade'':''custo'':''dias''

As entradas '''RATE''' referem transportadoras já registadas em linhas anteriores. O registo de empresas e de clientes segue os formatos:
COMPANY:''nome''
CLIENT:''nome'':''email''
CLIENT:''nome'':''email'':''mecanismo''

O ''mecanismo'' é '''EMAIL''' ou '''WHATSAPP'''; se for omitido, assume-se '''EMAIL'''. Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:

Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:
NATIONAL:''nome'':''preçoBase'':''categoria'':''prazo''
IMPORTED:''nome'':''preçoBase'':''categoria'':''prazo'':''paisOrigem'':''taxa'':''prazoInternacional''

Note-se que o registo de um produto não indica qualquer empresa nem qualquer inventário: essas são propriedades da disponibilização, descrita por entradas próprias, em que ''unidades'' é o número de exemplares que a empresa tem disponíveis e ''factor'' o multiplicador (real) que aplica ao preço recomendado:
SUPPLY:''idEmpresa'':''idProduto'':''unidades'':''factor''

As entradas '''SUPPLY''' referem empresas e produtos já registados em linhas anteriores.

Um exemplo de conteúdo do ficheiro inicial é como se segue:
{{CollapsedCode|Exemplo de ficheiro de entrada textual|
<syntaxhighlight lang="text">
CARRIER:CTT
RATE:1:NORMAL:3:3
RATE:1:EXPRESSO:8:1
CARRIER:DHL
RATE:2:NORMAL:5:2
RATE:2:EXPRESSO:12:1
CARRIER:SEUR
RATE:3:EXPRESSO:10:1
COMPANY:Moageira Nacional
COMPANY:Importadora Atlantico
CLIENT:Obi-Wan Kenobi:obiwan@jedi.org
CLIENT:Ahsoka Tano:ahsoka@jedi.org:WHATSAPP
NATIONAL:Farinha:15:ALIMENTAR:3
IMPORTED:Telemovel:200:ELECTRONICA:3:China:30:5
NATIONAL:Camisa:45:VESTUARIO:2
SUPPLY:1:1:23:1.0
SUPPLY:2:1:150:0.9
SUPPLY:2:2:2:1.2
SUPPLY:1:3:4:1.1
</syntaxhighlight>
}}

A codificação dos ficheiros a ler é garantidamente [[wp:UTF-8|UTF-8]].

{{Suggestion|Os métodos '''String.split()''', para partir cadeias de caracteres, e '''String.trim()''', para remover espaços no início e no final, podem ser usados no processamento de cada linha.}}
{{Suggestion|Note-se que o programa nunca produz ficheiros com este formato (é apenas um formato para ficheiros de entrada).}}

= Execução do Programa e Testes Automáticos =

Usando os ficheiros '''test.import''', '''test.in''' e '''test.out''', é possível verificar automaticamente o resultado correcto do programa. Note-se que é necessária a definição apropriada da variável '''CLASSPATH''' (ou da opção equivalente '''-cp''' do comando '''java'''), para localizar as classes do programa, incluindo a que contém o método correspondente ao ponto de entrada da aplicação ('''erp.app.App.main'''). As propriedades são tratadas automaticamente pelo código de apoio.

java -Dimport=test.import -Din=test.in -Dout=test.outhyp erp.app.App

Assumindo que aqueles ficheiros estão no directório onde é dado o comando de execução, o programa produz o ficheiro de saída '''test.outhyp'''. Em caso de sucesso, os ficheiros das saídas esperada ('''test.out''') e obtida ('''test.outhyp''') devem ser iguais. A comparação pode ser feita com o comando:
diff -b test.out test.outhyp

Este comando não deve produzir qualquer resultado quando os ficheiros são iguais. Note-se, contudo, que este teste não garante o correcto funcionamento do código desenvolvido, apenas verificando alguns aspectos da sua funcionalidade.

= Notas de Implementação =

Tal como indicado acima, algumas classes fornecidas como [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|material de apoio]], são de uso obrigatório e não podem ser alteradas. Outras dessas classes são de uso obrigatório e têm de ser alteradas.

A serialização Java usa as classes da ''package'' [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/package-summary.html java.io], em particular, a interface [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/Serializable.html java.io. Serializable] e as classes de leitura [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/ObjectInputStream.html java.io.ObjectInputStream] e escrita [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/ObjectOutputStream.html java.io.ObjectOutputStream] (entre outras).

[[category: Ensino]]
[[category:PO]]
[[category: Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T13:29:59Z

Root: /* Menu de Gestão de Clientes */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

'''EM PREPARAÇÃO'''

'''ÉPOCA NORMAL'''

O objectivo do projecto é desenvolver um sistema de gestão de entregas rápidas de produtos (ERP — Express Retail Platform). O sistema deverá permitir, entre outras operações, (i) registar dados de empresas; (ii) registar dados de clientes; (iii) registar, gerir e pesquisar produtos; (iv) efectuar e gerir características de compras; (v) gerir as entregas correspondentes; e (vi) notificar os clientes sobre a situação das suas encomendas.

Neste texto, o tipo '''negrito''' indica um literal (i.e., é exactamente como apresentado); o símbolo ␣ indica um espaço; e o tipo ''itálico'' indica uma parte variável (i.e., uma descrição).

= Conceitos e Relações do Modelo =

Existem vários conceitos importantes neste contexto: [[#Empresas|empresas]], [[#Produtos|produtos]], [[#Clientes|clientes]], [[#Transportadoras|transportadoras]], [[#Cabaz de Compras|cabazes]], [[#Compras|compras]], [[#Divisão das Compras em Encomendas|encomendas]] e [[#Entregas|entregas]].

Os conceitos listados não são os únicos possíveis no modelo e as suas relações (assim como relações com outros conceitos não mencionados) podem depender das escolhas do projecto.

Os clientes e os produtos são independentes das empresas: existem por si e podem relacionar-se com várias empresas. Cada empresa, no entanto, mantém registo dos clientes com quem interage, dos produtos que disponibiliza, das compras feitas e das encomendas que expede.

Uma compra representa a aquisição de produtos por um cliente a uma empresa, e resulta de finalizar um [[#Cabaz de Compras|cabaz]]. Uma compra pode dar origem a uma ou mais encomendas, de acordo com a estratégia de divisão de encomendas utilizada.

Cada encomenda pode ser enviada através de uma determinada transportadora e pode incluir serviços adicionais que alteram o seu custo e/ou prazo de entrega.

== Produtos ==

O sistema mantém um registo global de produtos. Cada produto é identificado por um número de produto. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Todos os produtos têm: um nome/descrição (cadeia de caracteres não vazia); um preço base (número inteiro positivo); uma categoria; e um prazo de entrega base (número inteiro de dias).

O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O sistema utiliza o preço base para calcular o preço recomendado do produto. O preço recomendado representa o valor de referência do produto no sistema. O seu cálculo pode depender do tipo de produto e de outras informações disponíveis no sistema.

Cada produto tem uma categoria, de acordo com a sua natureza. Inicialmente, consideram-se as seguintes categorias: (i) alimentar; (ii) electrónica; e (iii) vestuário. Deve ser possível adicionar novas categorias com impacto mínimo na aplicação já desenvolvida.

O produto existe independentemente das empresas que o disponibilizam. Assim, o mesmo produto pode ser disponibilizado por várias empresas, sendo possível que cada uma pratique um preço de venda diferente.

A informação relativa à disponibilização de um produto por uma empresa não deve ser considerada parte das características intrínsecas do produto.

== Tipos de Produto ==

Todos os produtos considerados no sistema são fabricados, mas podem ter diferentes origens.

Inicialmente, consideram-se os seguintes tipos de produto:
* produto nacional;
* produto importado.

Um produto nacional possui apenas as propriedades gerais dos produtos.

Um produto importado possui, para além das propriedades gerais dos produtos:
* um país de origem (cadeia de caracteres não vazia);
* uma taxa alfandegária (número inteiro expressando uma percentagem);
* um prazo de transporte internacional (número inteiro de dias).

O preço recomendado é calculado de forma diferente consoante o tipo de produto.

Deve ser possível introduzir novos tipos de produto com impacto mínimo na implementação desenvolvida.

=== Produtos Nacionais ===

Para um produto nacional, o preço recomendado depende do preço base e do número total de unidades actualmente disponíveis desse produto nas empresas que o disponibilizam.

Se o número total de unidades disponíveis for:
* superior a 10000, o preço recomendado corresponde a 90% do preço base;
* inferior a 100, o preço recomendado corresponde a 130% do preço base;
* nos restantes casos, o preço recomendado corresponde ao preço base.

Por exemplo, considerando um produto nacional com preço base de 100 euros:
* Unidades disponíveis = 50 => Preço recomendado = 130 euros;
* Unidades disponíveis = 5000 => Preço recomendado = 100 euros;
* Unidades disponíveis = 12000 => Preço recomendado = 90 euros.

=== Produtos Importados ===

Para um produto importado, o preço recomendado corresponde ao preço base acrescido da taxa alfandegária.

Se a taxa alfandegária for '''t%''', o preço recomendado é calculado de acordo com:

'''preço base × (100 + t) / 100'''

Por exemplo, considerando um produto importado com preço base de 100 euros e uma taxa alfandegária de 20%, o preço recomendado será:

'''100 × (100 + 20) / 100 = 120 euros'''

O cálculo do preço recomendado deve ser realizado de forma polimórfica, de modo a que o código que utiliza produtos não tenha de conhecer explicitamente o tipo concreto de cada produto.

== Empresas ==

O sistema mantém um registo das empresas que operam na plataforma. Cada empresa é identificada por um número de empresa. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada empresa tem ainda um nome (cadeia de caracteres não vazia).

Uma empresa pode disponibilizar vários produtos e cada produto pode ser disponibilizado por várias empresas.

Para cada produto que disponibiliza, a empresa deve manter informação sobre:
* número de unidades disponíveis (valor inteiro);
* factor multiplicativo do preço recomendado (número positivo).

O número de unidades disponíveis e o factor multiplicativo podem ser diferentes para cada empresa que disponibiliza o mesmo produto.

O factor multiplicativo permite que uma empresa pratique um preço de venda diferente do preço recomendado pelo sistema. O preço de venda de um produto pela empresa é calculado multiplicando o preço recomendado do produto pelo factor multiplicativo definido pela empresa. Assim, duas empresas podem disponibilizar o mesmo produto a preços diferentes e com quantidades diferentes em stock.

Por exemplo, o produto P1, com um preço recomendado de 100 euros, pode ser disponibilizado pela empresa A com um preço de 90 euros, através de um factor multiplicativo de 0,9. A empresa B pode disponibilizar o mesmo produto com um preço de 120 euros, através de um factor multiplicativo de 1,2.

Deve ser possível adicionar outras propriedades às empresas sem impacto significativo no código já desenvolvido.

== Clientes ==

O sistema mantém um registo de clientes. Cada cliente é identificado por um número de cliente. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada cliente tem ainda informação sobre o seu nome e endereço de correio electrónico. Estes campos não podem ser vazios.

Assume-se que os clientes têm sempre dinheiro, i.e., uma compra nunca é recusada por falta de fundos.

== Compras ==

O sistema regista as compras efectuadas pelos clientes. Cada compra é identificada por um número de compra, atribuído automaticamente e incrementalmente. Uma compra é sempre feita por um único cliente a uma única empresa numa determinada data.

Uma compra é constituída por um conjunto de linhas (um "cabaz"). Cada linha corresponde a:
* um produto;
* uma quantidade (número de exemplares adquiridos desse produto);
* um preço unitário (o preço de venda do produto pela empresa no momento da compra);
* um preço total da linha (quantidade × preço unitário).

O preço unitário utilizado numa compra deve ser guardado na própria linha da compra. Alterações posteriores ao preço base, ao preço recomendado, ao factor multiplicativo da empresa, ou a qualquer outra propriedade utilizada no cálculo do preço, não devem alterar o valor de compras já efectuadas.

O preço total dos itens de uma compra é a soma dos preços totais das suas linhas. Uma compra pode dar origem a uma ou mais encomendas, de acordo com uma estratégia de divisão de encomendas.

A divisão de uma compra em várias encomendas pode ter impacto no custo total da compra.

== Cabaz de Compras ==

Antes de dar origem a uma compra, os produtos que um cliente pretende adquirir a uma empresa são acumulados num '''cabaz'''.

Cada cliente tem um cabaz por cada empresa em que compra. O cabaz é constituído por um conjunto de linhas; cada linha corresponde a um produto disponibilizado por essa empresa e a uma quantidade. Acrescentar ao cabaz um produto que já lá esteja acumula as quantidades.

O cabaz regista ainda as opções que serão aplicadas à compra:
* a [[#Divisão das Compras em Encomendas|estratégia de divisão em encomendas]]; * a [[#Transportadoras|transportadora]] e a [[#Transportadoras|modalidade de transporte]]; e
* o conjunto de [[#Serviços Adicionais|serviços adicionais]].

A transportadora, a modalidade e os serviços adicionais escolhidos aplicam-se a '''todas''' as encomendas resultantes da compra.

Enquanto não for finalizado, o cabaz não tem qualquer efeito no resto do sistema: em particular, não reserva nem consome inventário, e os preços apresentados são sempre os preços de venda praticados pela empresa '''nesse momento'''. Um cabaz faz parte do estado persistente da aplicação: pode ser abandonado e retomado mais tarde.

Ao '''finalizar''' o cabaz, e apenas nesse momento:
* os preços de venda são fixados nas linhas da compra;
* a compra é dividida em encomendas de acordo com a estratégia registada no cabaz;
* todas as encomendas recebem a modalidade de transporte e os serviços adicionais registados no cabaz;
* o inventário dos produtos na empresa é decrementado e o cliente é debitado;
* o cabaz fica vazio.

Um cabaz vazio não pode ser finalizado, nem o pode ser um cabaz em que ainda não tenham sido escolhidas transportadora e modalidade. Se, no momento de finalizar, a empresa já não tiver exemplares suficientes de algum dos produtos do cabaz (por exemplo, porque o inventário foi entretanto alterado), a operação falha sem qualquer efeito e o cabaz mantém-se intacto.

== Divisão das Compras em Encomendas ==

Cada encomenda tem um custo base de processamento e expedição, de '''5 euros'''. Assim, uma compra dividida em várias encomendas pode ter um custo superior ao de uma compra enviada numa única encomenda.

O custo base associado às encomendas corresponde ao número de encomendas multiplicado pelo custo base de uma encomenda.

A este custo podem acrescer os custos associados ao método de transporte seleccionado e aos serviços adicionais.

O custo total de uma compra corresponde, assim, ao custo dos produtos acrescido:
* do custo base das encomendas;
* dos custos adicionais das tarifas de transporte;
* dos custos dos serviços adicionais seleccionados.

A forma como uma compra é dividida em encomendas é determinada por uma estratégia de divisão de encomendas. Inicialmente, devem ser suportadas, pelo menos, as seguintes estratégias: encomenda única ('''UNICA''') e agrupamento por prazo de entrega ('''PRAZO''').

=== Encomenda única ===

Todos os produtos da compra são colocados numa única encomenda.

Neste caso, a compra origina uma única encomenda, independentemente dos prazos de entrega dos produtos.

=== Agrupamento por prazo de entrega ===

Os produtos são agrupados de acordo com os seus prazos de entrega.

Calcula-se a média dos prazos de entrega dos produtos das linhas da compra:
* todas as linhas cujo produto tem prazo menor ou igual à média são agrupadas numa única encomenda;
* cada linha cujo produto tem prazo estritamente maior do que a média é enviada separadamente, numa encomenda própria.

Por exemplo, considere-se uma compra com três linhas cujos produtos têm os prazos de entrega 3 (P1), 8 (P2) e 2 (P3). A média dos prazos é (3 + 8 + 2) / 3 ≈ 4,33. Logo, P1 e P3 (prazos ≤ 4,33) seguem juntos numa entrega e P2 (prazo > 4,33) segue numa outra encomenda:
* Encomenda A: {P1, P3} (prazo = 3)
* Encomenda B: {P2} (prazo = 8)

Uma estratégia de divisão que origina várias encomendas pode permitir que alguns produtos sejam entregues mais cedo, mas pode também resultar num custo superior devido ao custo associado a cada encomenda.

Deve ser possível introduzir novas estratégias de divisão de compras em encomendas com impacto mínimo na implementação desenvolvida.

== Transportadoras ==

O sistema mantém um registo das '''transportadoras''' que operam na plataforma. Cada transportadora é identificada por um número de transportadora. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada transportadora tem ainda um nome (cadeia de caracteres não vazia).

Cada encomenda é enviada através de uma transportadora, segundo uma '''modalidade de transporte'''. Inicialmente, devem ser suportadas, pelo menos, as seguintes modalidades: normal ('''NORMAL''') e expresso ('''EXPRESSO''').

Uma modalidade '''não''' define, por si só, qualquer custo ou prazo: é apenas o nome de um nível de serviço. Para cada modalidade que oferece, uma transportadora define uma '''tarifa''', constituída por:
* um custo adicional (número inteiro); e
* um tempo de transporte (número inteiro de dias).

Assim, a mesma modalidade pode custar e demorar valores diferentes consoante a transportadora.

Uma transportadora '''não tem de oferecer todas as modalidades''': oferece exactamente aquelas para as quais tenha uma tarifa definida. Pedir a uma transportadora uma modalidade que ela não oferece é um erro, e não uma escolha silenciosamente ignorada — ver [[#Definir modalidade de transporte|Definir modalidade de transporte]].

Entre os dois, '''a transportadora tem precedência sobre a modalidade''': como as modalidades disponíveis são as da transportadora, só se pode escolher uma modalidade depois de escolhida a transportadora, e mudar de transportadora anula a modalidade anteriormente escolhida (que passa a ser escolhida de novo, de entre as que a nova transportadora oferece).

Por exemplo:
{|
! style="background: #ebebeb;" | '''Transportadora'''
! style="background: #ebebeb;" | '''Modalidade'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo de transporte'''
|-
| CTT || '''NORMAL''' || 3 euros || 3 dias
|-
| CTT || '''EXPRESSO''' || 8 euros || 1 dia
|-
| DHL || '''NORMAL''' || 5 euros || 2 dias
|-
| DHL || '''EXPRESSO''' || 12 euros || 1 dia
|-
| SEUR || '''EXPRESSO''' || 10 euros || 1 dia
|}

No exemplo acima, a transportadora SEUR só oferece a modalidade expresso: não é possível enviar por SEUR em modalidade normal.

A transportadora e a modalidade são escolhidas no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda seja enviada por uma transportadora ou modalidade diferente.

A escolha da transportadora e da modalidade afecta tanto o custo como a data prevista de entrega da encomenda. Uma compra só pode ser finalizada depois de escolhidas ambas, e o par transportadora/modalidade de um cabaz é sempre um par que a transportadora oferece.

Deve ser possível introduzir novas modalidades de transporte com impacto mínimo na implementação desenvolvida. As transportadoras e as suas tarifas, por seu lado, fazem parte do estado da aplicação: são registadas pelo utilizador e não implicam qualquer alteração ao código.

== Serviços Adicionais ==

O cliente pode seleccionar serviços adicionais, podendo aumentar o custo de cada encomenda, assim como o tempo necessário para a sua preparação e entrega. Os serviços são escolhidos no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda tenha os seus próprios serviços.

Os serviços iniciais são os seguintes:
{|
! style="background: #ebebeb;" | '''Serviço'''
! style="background: #ebebeb;" | '''Chave'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo adicional'''
|-
| Embrulho || '''EMBRULHO''' || 2 euros || 1 dia
|-
| Cartão de oferta || '''CARTAO_OFERTA''' || 1 euro || 0 dias
|}

Os serviços adicionais podem ser combinados: uma encomenda pode incluir simultaneamente embrulho, cartão de oferta ou outro serviço adicional. O custo e o tempo adicionais de uma encomenda correspondem à soma dos contributos da modalidade de transporte e de todos os serviços seleccionados.

Deve ser possível introduzir novos serviços adicionais sem alterar o código das encomendas ou dos serviços já existentes.

== Entregas ==

Cada encomenda tem uma data prevista de entrega.
A data prevista de entrega é determinada considerando:
* a data da compra;
* os prazos de entrega dos produtos que constituem a encomenda;
* o tempo de transporte da tarifa da transportadora seleccionada;
* o tempo adicional introduzido pelos serviços seleccionados.

Para uma encomenda com vários produtos, o prazo dos produtos considerados para determinar a data prevista de entrega corresponde ao maior prazo de entrega dos seus produtos.

Não é necessário manter explicitamente um estado para representar se uma encomenda está ou não entregue. A situação da encomenda pode ser determinada a partir da data actual e da sua data prevista de entrega. Assim, uma encomenda é considerada entregue quando a data actual atinge ou ultrapassa a sua data prevista de entrega.

== Gestão de Tempo ==

A unidade de tempo do sistema é o dia. A data do sistema começa no dia 1 (um) e faz parte do estado persistente.

A data do sistema pode ser avançada. Sempre que a data é alterada, devem ser verificadas as encomendas existentes para determinar:
* quais as encomendas que serão entregues no dia seguinte;
* quais as encomendas cuja data prevista de entrega foi atingida ou ultrapassada.

Quando a data actual atinge ou ultrapassa a data prevista de entrega de uma encomenda, esta considera-se entregue.

A gestão do tempo deve ainda desencadear [[#Notificações|notificações]].

== Pesquisas ==

Para permitir que os clientes determinem a existência de um produto, deverá ser possível efectuar pesquisas.

As pesquisas consideram os campos relevantes dos vários produtos, por exemplo, nome, categoria, tipo de produto ou país de origem.

O termo de pesquisa deve ser comparado sem distinção entre letras maiúsculas e minúsculas.

O sistema deve suportar diferentes critérios de pesquisa. Por exemplo, uma pesquisa pode procurar produtos cujo nome contenha determinado termo ou produtos pertencentes a determinada categoria.

Deve ser possível introduzir novos métodos de pesquisa de produtos com impacto mínimo na implementação desenvolvida.

== Alterações de Inventário ==

O inventário de um produto numa empresa pode ser alterado através da especificação de um valor a somar ou subtrair ao número de exemplares disponíveis. Se a quantidade indicada for um valor positivo, aumenta-se o número de exemplares disponíveis.
Se a quantidade indicada for um valor negativo, decrementa-se o número de exemplares disponíveis, desde que o número de exemplares disponíveis não fique negativo.

Um produto não é removido do sistema quando o seu inventário numa empresa chega a zero.
Quando o inventário de um produto numa empresa chega a zero, o produto deixa de estar disponível nessa empresa, mas continua a existir no sistema e pode continuar a ser disponibilizado por outras empresas.
Se o inventário de um produto numa empresa passar de zero para um valor positivo, o produto volta a estar disponível nessa empresa.

O número total de unidades disponíveis de um produto corresponde à soma dos inventários desse produto em todas as empresas que o disponibilizam.

Esta informação é utilizada, nomeadamente, no cálculo do preço recomendado dos produtos nacionais.

== Notificações ==

O sistema deve notificar os clientes relativamente às suas encomendas.

Devem ser enviadas notificações em duas situações:
* um dia antes da data prevista de entrega, informando o cliente de que a encomenda será entregue no dia seguinte;
* no dia da entrega, informando o cliente de que a encomenda foi entregue.

Cada notificação deve ser enviada através do mecanismo de notificação seleccionado pelo cliente.
Inicialmente, devem ser suportados, pelo menos, os seguintes mecanismos:
* correio electrónico ('''EMAIL''');
* WhatsApp ('''WHATSAPP''').

Cada cliente pode escolher o mecanismo através do qual pretende receber notificações do sistema. O mecanismo de notificação pode variar de cliente para cliente. Por exemplo, um cliente pode receber notificações por correio electrónico, enquanto outro pode recebê-las através de WhatsApp.
Deve ser possível introduzir novos mecanismos de notificação sem necessidade de alterar o código dos clientes ou do sistema responsável por gerar as notificações.

Deve ser possível introduzir novos mecanismos de notificação com impacto mínimo na implementação desenvolvida.

As notificações devem ser enviadas pela ordem em que os acontecimentos ocorrem no sistema.

= Requisitos de Desenho =

A aplicação a desenvolver deve seguir o princípio de desenho aberto-fechado, por forma a aumentar a extensibilidade do seu código. Por exemplo, deve ser possível adicionar novos tipos de produto com um impacto mínimo no código já existente da aplicação.

Devem ser possíveis extensões ou alterações de funcionalidade com impacto mínimo no código já produzido para a aplicação. O objectivo é aumentar a flexibilidade da aplicação relativamente ao suporte de novas funções. Assim, deve ser possível:
* Adicionar novos tipos de produto (e.g., produtos digitais ou perecíveis), incluindo a respectiva regra de cálculo do preço recomendado; * Adicionar novas categorias de produto;
* Introduzir novas estratégias de divisão de compras em encomendas;
* Introduzir novas modalidades de transporte (os custos e prazos de cada uma são dados de cada transportadora, não código; nem todas as transportadoras têm de oferecer todas as modalidades);
* Introduzir novos serviços adicionais, sem alterar o código das encomendas nem o dos serviços já existentes;
* Introduzir novos mecanismos de notificação, sem alterar o código dos clientes nem o do sistema que gera as notificações;
* Introduzir novos critérios de discriminação/classificação dos clientes;
* Introduzir novos critérios de pesquisa de produtos.

= Funcionalidade da aplicação =

A aplicação permite manter informação sobre as entidades do modelo, permitindo, em particular, gerir empresas, produtos, clientes e compras. Possui ainda a capacidade de preservar o seu estado (não é possível manter várias versões do estado da aplicação em simultâneo).

Nenhuma entidade é removida pelas operações descritas neste enunciado (em particular, um produto cujo inventário numa empresa chegue a zero continua a existir no sistema). Ainda assim, a aplicação deve estar preparada para que a remoção de qualquer entidade possa vir a ser suportada.

No [[#Leitura de Dados a Partir de Ficheiros Textuais|início]], a aplicação está vazia, mas pode ser carregada uma base de dados textual com conceitos pré-definidos. Neste caso, a aplicação começará com um estado referente às entidades que foram carregadas no arranque da aplicação.

{{Suggestion|Note-se que não é necessário implementar de raiz a aplicação: já existem classes que representam e definem a interface geral da funcionalidade do ''core'' da aplicação, tal como é visível pelos comandos da aplicação.}}
{{CVSCode|A interface geral do ''core'' já está parcialmente implementada na classe '''erp.ErpManager''' e outras fornecidas (cujos nomes devem ser mantidos), devendo ser adaptadas onde necessário. É ainda necessário criar e implementar as restantes classes que suportam a operação da aplicação.}}

== Serialização ==

É possível guardar e recuperar o estado actual da aplicação, preservando toda a informação relacionada com o ERP e que foi descrita [[#Conceitos e Relações do Modelo|acima]].

Após a recuperação do estado, os identificadores atribuídos a novas entidades devem continuar a ser atribuídos incrementalmente a partir do último valor utilizado em cada caso.

= Interacção com o utilizador =

Descreve-se nesta secção a '''funcionalidade máxima''' da interface com o utilizador. Em geral, os comandos pedem toda a informação antes de procederem à sua validação (excepto onde indicado). Todos os menus têm automaticamente a opção '''Sair''' (fecha o menu).

As operações de pedido e apresentação de informação ao utilizador '''devem''' realizar-se através dos objectos ''form'' e ''display'', respectivamente, presentes em cada comando. As mensagens são produzidas pelos métodos das [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|bibliotecas de suporte]] ('''po-uilib''' e '''erp-app'''). As mensagens não podem ser usadas no núcleo da aplicação ('''erp-core'''). Além disso, não podem ser definidas novas. Potenciais omissões devem ser esclarecidas antes de qualquer implementação.

De um modo geral, sempre que no contexto de uma operação com o utilizador aconteça alguma excepção, então a operação não deve ter qualquer efeito no estado da aplicação, excepto em caso de indicação contrária na operação em causa. As excepções estão na package '''erp.app.exceptions''', excepto em caso de indicação contrária.

As excepções usadas na interacção (subclasses de '''pt.tecnico.uilib.menus.CommandException'''), excepto em caso de indicação contrária, são lançadas pelos comandos (subclasses de '''pt.tecnico.uilib.menus.Command''') e tratadas pelos menus (instâncias de subclasses de '''pt.tecnico.uilib.menus.Menu'''). Outras excepções não devem substituir as fornecidas nos casos descritos.

Nos pedidos e usos dos vários identificadores, podem ocorrer as seguintes excepções, caso o identificador indicado não corresponda a um objecto conhecido (excepto no processo de registo ou em caso de indicação contrária). Note-se que estas excepções não são utilizáveis no núcleo da aplicação.

{|
! style="background: #ebebeb;" | '''Tipo de dados'''
! style="background: #ebebeb;" | '''Classe'''
! style="background: #ebebeb;" | '''Pedido a apresentar'''
! style="background: #ebebeb;" | '''Excepção a lançar se desconhecido'''
|-
| Empresa
| '''Company'''
| '''erp.app.company.Prompt.companyId()'''
| '''erp.app.exceptions.UnknownCompanyKeyException'''
|-
| Produto
| '''Product'''
| '''erp.app.product.Prompt.productId()'''
| '''erp.app.exceptions.UnknownProductKeyException'''
|-
| Cliente
| '''Client'''
| '''erp.app.client.Prompt.clientId()'''
| '''erp.app.exceptions.UnknownClientKeyException'''
|-
| Transportadora
| '''Carrier'''
| '''erp.app.carrier.Prompt.carrierId()'''
| '''erp.app.exceptions.UnknownCarrierKeyException'''
|-
| Compra
| '''Purchase'''
| '''erp.app.purchase.Prompt.purchaseId()'''
| '''erp.app.exceptions.UnknownPurchaseKeyException'''
|}

Existe ainda um caso particular: sempre que uma operação se refira a um produto '''no contexto de uma empresa''' e essa empresa não disponibilize esse produto, deve ser lançada a excepção '''erp.app.exceptions.ProductNotSuppliedException''' (a empresa e o produto existem, mas não estão relacionados).

Alguns casos particulares podem usar pedidos específicos não apresentados nesta tabela.

Vários comandos pedem ao utilizador que escolha um valor de um conjunto fechado (tipo de produto, categoria, estratégia de divisão, modalidade de transporte, serviço adicional, mecanismo de notificação e critério de pesquisa). Estas escolhas '''devem''' ser pedidas através de campos de opção ('''Form.addOptionField()''' ou '''Form.requestOption()'''), sendo o conjunto de opções obtido do núcleo através da fachada. Desta forma, a introdução de uma nova estratégia, modalidade, serviço, mecanismo ou critério não implica qualquer alteração aos comandos.

{{CVSCode|Note-se que o programa principal e os comandos e menus, a seguir descritos, já estão parcial ou completamente implementados nas ''packages'' '''erp.app''', '''erp.app.main''', '''erp.app.company''', '''erp.app.product''', '''erp.app.client''', '''erp.app.purchase'''. Estas classes são de uso obrigatório e estão disponíveis no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|GIT]] (módulo '''erp-app''').}}

== Formatos de Apresentação ==

Os formatos usados pelos vários comandos são os seguintes. Todos os campos são separados por '''␣-␣'''.

{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma transportadora|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma tarifa|
''idTransportadora'' - ''modalidade'' - ''custo adicional'' - ''tempo de transporte''
}}

{{CollapsedCode|Formato de apresentação de um produto|
''id'' - ''tipo'' - ''nome'' - ''categoria'' - ''preço base'' - ''preço recomendado'' - ''prazo base'' - ''unidades totais'' - ''informação adicional''
}}

O ''tipo'' é '''NACIONAL''' ou '''IMPORTADO'''. As ''unidades totais'' correspondem à soma dos inventários do produto em todas as empresas que o disponibilizam. Para produtos nacionais não existe informação adicional; para produtos importados, a informação adicional corresponde ao país de origem, à taxa alfandegária e ao prazo de transporte internacional.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 173
2 - IMPORTADO - Telemovel - ELECTRONICA - 200 - 260 - 3 - 2 - China - 30 - 5
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 0
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação da disponibilização de um produto por uma empresa|
''idEmpresa'' - ''idProduto'' - ''unidades'' - ''factor'' - ''preço de venda''
}}

{{CollapsedCode|Exemplos de apresentação de disponibilizações|
<syntaxhighlight lang="text">
2 - 1 - 150 - 0.9 - 14
2 - 2 - 2 - 1.2 - 312
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''mecanismo de notificação'' - ''gasto total''
}}

O valor apresentado no fim corresponde ao total gasto pelo cliente em compras (um valor inteiro).

{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Ahsoka Tano - ahsoka@jedi.org - WHATSAPP - 0
1 - Obi-Wan Kenobi - obiwan@jedi.org - EMAIL - 124
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de uma compra|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
}}

{{CollapsedCode|Formato de apresentação (resumida) de uma encomenda|
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo'' - ''lista de identificadores de produtos''
}}

A ''descrição do transporte'' é o nome da transportadora e a modalidade seleccionadas, separados por '''/''', seguidos das chaves dos serviços adicionais seleccionados, separadas por '''+''' (por exemplo, '''DHL/ EXPRESSO+EMBRULHO+CARTAO_OFERTA'''). O ''custo'' de uma encomenda é o custo base de processamento acrescido do custo da modalidade e dos serviços.

{{CollapsedCode|Exemplos de apresentação de encomendas|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

== Menu Principal ==

As acções deste menu permitem gerir a salvaguarda do estado da aplicação e abrir submenus. A lista completa é a seguinte: [[#Salvaguarda do estado actual da aplicação|Abrir]], [[#Salvaguarda do estado actual da aplicação|Guardar]], [[#Mostrar data actual|Mostrar data actual]], [[#Avançar data actual|Avançar data actual]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Empresas]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Produtos]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Clientes]] e [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Compras]]. Inicialmente, a aplicação apenas tem informação sobre as entidades que foram carregadas no arranque.

{{CVSCode|As etiquetas das opções deste menu estão definidas na classe '''erp.app.main.Label'''. Todos os métodos correspondentes às mensagens de diálogo para este menu estão definidos na classe '''erp.app.main.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.main''', respectivamente: '''DoOpenFile''', '''DoSaveFile''', '''DoDisplayDate''', '''DoAdvanceDate''', '''DoOpenMenuCompanies''', '''DoOpenMenuProducts''', '''DoOpenMenuClients''', '''DoOpenMenuPurchases'''.}}

=== Salvaguarda do estado actual da aplicação ===

O conteúdo da aplicação (toda a informação detida pelo ERP actualmente em memória) pode ser guardado para posterior recuperação (via serialização Java: '''java.io.Serializable'''). Na leitura e escrita do estado da aplicação, devem ser tratadas as excepções associadas. A funcionalidade é a seguinte:

* '''Abrir''' -- Carrega os dados de uma sessão anterior a partir de um ficheiro previamente guardado (ficando este ficheiro associado à aplicação, para futuras operações de salvaguarda). Pede-se o nome do ficheiro a abrir ('''Prompt.openFile()'''). Caso ocorra um problema na abertura ou processamento do ficheiro, deve ser lançada a excepção '''FileOpenFailedException'''. A execução bem-sucedida desta opção substitui toda a informação da aplicação. Quando se abandona uma aplicação com modificações não guardadas (porque se abre outra e existem alterações não guardadas), deve perguntar-se ao utilizador se quer guardar a informação actual antes de a abandonar, através de '''Prompt.saveBeforeExit()''' (a resposta é obtida via '''Form.confirm()''').

* '''Guardar''' -- Guarda o estado actual da aplicação no ficheiro associado. Se não existir associação, pede-se o nome do ficheiro a utilizar, ficando a ele associado (para operações de salvaguarda subsequentes). Esta interacção realiza-se através do método '''Prompt.newSaveAs()'''. Não é executada nenhuma acção se não existirem alterações desde a última salvaguarda.

{{Suggestion|Note-se que a opção '''Abrir''' não permite a leitura de ficheiros de texto (estes apenas podem ser utilizados no início da aplicação).}}
{{Suggestion|A opção '''Sair''' nunca implica a salvaguarda do estado da aplicação, mesmo que existam alterações.}}

=== Mostrar data actual ===

A data actual do sistema é apresentada através da mensagem '''Message.currentDate()'''.

=== Avançar data actual ===

O número de dias a avançar é pedido através de '''Prompt.daysToAdvance()'''. O valor indicado deve ser positivo. Caso contrário, a operação não tem efeito.

Além da data, o sistema deve actualizar, caso seja necessário, outros aspectos que dela dependam, designadamente, a situação das entregas relativa às suas datas de chegada.

=== Gestão e consulta de dados da aplicação ===

* '''Menu de Gestão de Empresas''' -- Abre o menu de gestão de empresas e operações associadas.
* '''Menu de Gestão de Produtos''' -- Abre o menu de gestão de produtos e operações associadas.
* '''Menu de Gestão de Clientes''' -- Abre o menu de gestão de clientes e operações associadas.
* '''Menu de Gestão de Compras''' -- Abre o menu de gestão de compras e operações associadas.

== Menu de Gestão de Empresas ==

Este menu permite efectuar operações sobre a base de dados de empresas. A lista completa é a seguinte: [[#Registar empresa|Registar empresa]], [[#Mostrar empresa|Mostrar empresa]], [[#Mostrar empresas|Mostrar empresas]], [[#Mostrar produtos de uma empresa|Mostrar produtos de uma empresa]], [[#Mostrar clientes de uma empresa|Mostrar clientes de uma empresa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.company.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.company.Prompt''' e '''erp.app.company.Message'''.}}

=== Registar empresa ===

Pede o nome ('''Prompt.companyName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CompanyRegistrationFailedException'''.

Note-se que a atribuição do identificador da empresa é automática.

=== Mostrar empresa ===

É pedido o identificador da empresa, sendo apresentadas as informações sobre essa empresa, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

=== Mostrar empresas ===

Apresenta informações sobre todas as empresas, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar empresa|Mostrar empresa]].

=== Mostrar produtos de uma empresa ===

É pedido o identificador da empresa e apresentam-se os produtos que essa empresa vende, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar produto|Mostrar produto]].

=== Mostrar clientes de uma empresa ===

É pedido o identificador da empresa e apresentam-se os clientes que já interagiram com essa empresa, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar cliente|Mostrar cliente]].

== Menu de Gestão de Produtos ==

Este menu apresenta as operações disponíveis sobre produtos. A lista completa é a seguinte: [[#Mostrar produto|Mostrar produto]], [[#Mostrar produtos|Mostrar produtos]], [[#Alterar inventário de um produto|Alterar inventário de um produto]] e [[#Efectuar pesquisa|Efectuar pesquisa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.product.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.product.Prompt''' e '''erp.app.product.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.product''' (disponível no GIT), respectivamente: '''DoShowProduct''', '''DoShowProducts''', '''DoChangeProductInventory''', '''DoPerformSearch'''.}}

=== Mostrar produto ===

É pedido o identificador do produto. Se o produto existir, é apresentado de acordo com o seguinte formato. O formato genérico de apresentação de um produto é como se segue:
{{CollapsedCode|Formato de apresentação de produtos|
''id'' - ''stock'' - ''tipo'' - ''nome'' - ''preço'' - ''categoria'' - ''informação adicional''
}}

Para produtos fabricados, a informação adicional corresponde ao nome do fabricante e ao código de fabrico (separados pelo carácter ''';'''); para produtos importados, a informação adicional corresponde ao país de origem e à taxa alfandegária.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
3 - 20 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
4 - 2 - IMPORTADO - Telemóvel - 200 - ELECTRONICA - China - 30
5 - 0 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

=== Mostrar produtos ===

Apresenta informações sobre todos os produtos, ordenando-os pelos seus identificadores. O formato de apresentação é como descrito em [[#Mostrar produto|Mostrar produto]].

=== Alterar inventário de um produto ===

É pedido o identificador de um produto e uma quantidade ('''Prompt.amountToUpdate()''') e actualizado o número de exemplares disponíveis do produto indicado somando a quantidade indicada ao número de exemplares disponíveis. No caso de não ser possível actualizar o número de exemplares devido ao facto de a quantidade indicada ser inválida, então a operação não deve ter qualquer efeito e deve ser apresentada a mensagem '''Message.notEnoughInventory()'''.

=== Efectuar pesquisa ===

Esta opção realiza uma procura por termo (cadeia de caracteres), pedido através de '''Prompt.searchTerm()'''. Como resultado, deve ser apresentada uma lista dos produtos encontrados pela pesquisa, ordenados por ordem crescente do seu identificador, utilizando o formato descrito para [[#Mostrar produto|Mostrar produto]].

O termo de pesquisa deve ser comparado (sem distinção entre letras maiúsculas e minúsculas) com os campos relevantes de cada produto: o nome e a categoria. Só devem ser apresentados produtos que contenham o termo de pesquisa num dos campos relevantes. Caso não sejam encontrados produtos, não deve ser produzido qualquer resultado.

== Menu de Gestão de Clientes ==

Este menu permite efectuar operações sobre a base de dados de clientes. A lista completa é a seguinte: [[#Registar cliente|Registar cliente]], [[#Mostrar cliente|Mostrar cliente]], [[#Mostrar clientes|Mostrar clientes]], [[#Alterar mecanismo de notificação|Alterar mecanismo de notificação]], [[#Mostrar notificações do cliente|Mostrar notificações do cliente]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.client.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.client.Prompt''' e '''erp. app.client.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.client''', respectivamente: '''DoRegisterClient''', '''DoShowClient''', '''DoShowClients''', '''DoSetNotificationMedium''', '''DoShowClientNotifications'''.}}

=== Registar cliente ===

Pede o nome ('''Prompt.clientName()'''), o endereço de correio electrónico ('''Prompt.clientEMail()''') e o mecanismo de notificação pretendido ('''Prompt.notificationMedium()'''). O registo bem sucedido é assinalado através da mensagem '''Message. registrationSuccessful()'''; caso contrário, é lançada a excepção '''ClientRegistrationFailedException'''.

Note-se que a atribuição do identificador do cliente é automática e que clientes diferentes são registados em cada operação de registo.

=== Mostrar cliente ===

É pedido o identificador do cliente, sendo apresentadas as informações sobre esse cliente, no [[#Formatos de Apresentação|formato de apresentação de um cliente]].

=== Mostrar clientes ===

Apresenta informações sobre todos os clientes, ordenando-os lexicograficamente pelo nome. Caso existam clientes com o mesmo nome, devem ser ordenados por ordem crescente dos seus identificadores. O formato é o descrito em [[#Mostrar cliente|Mostrar cliente]].

=== Alterar mecanismo de notificação ===

São pedidos o identificador do cliente e o novo mecanismo de notificação ('''Prompt.notificationMedium()'''). As notificações seguintes desse cliente passam a ser produzidas através do mecanismo indicado.

=== Mostrar notificações do cliente ===

É pedido o identificador do cliente, sendo apresentadas as notificações para esse cliente, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação das notificações de um cliente|
''assunto'': ''descrição da encomenda''
}}

O ''assunto'' é '''ENTREGA_AMANHA''' (a encomenda será entregue no dia seguinte) ou '''ENTREGUE''' (a encomenda foi entregue). A descrição da encomenda é a descrição resumida definida em [[#Formatos de Apresentação|Formatos de Apresentação]].

{{CollapsedCode|Exemplos de notificações|
<syntaxhighlight lang="text">
ENTREGA_AMANHA: 1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
ENTREGUE: 1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

As notificações de um cliente apenas devem ser apresentadas uma única vez. Após esta visualização, considera-se que o cliente fica sem notificações. As notificações devem ser apresentadas pela mesma ordem em que foram enviadas pelo sistema.

Note-se que o mecanismo através do qual a notificação foi produzida (correio electrónico, WhatsApp, ...) não altera este formato. No entanto, a solução deve ser suficientemente flexível para permitir outros formatos de apresentação das notificações (sem impacto no código do domínio da aplicação).

== Menu de Gestão de Transportadoras ==

Este menu permite efectuar operações sobre a base de dados de transportadoras. A lista completa é a seguinte: [[#Registar transportadora|Registar transportadora]], [[#Mostrar transportadora|Mostrar transportadora]], [[#Mostrar transportadoras|Mostrar transportadoras]], [[#Definir tarifa|Definir tarifa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.carrier.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.carrier.Prompt''' e '''erp.app.carrier.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.carrier''', respectivamente: '''DoRegisterCarrier''', '''DoShowCarrier''', '''DoShowCarriers''' e '''DoSetRate'''.}}

=== Registar transportadora ===

Pede o nome ('''Prompt.carrierName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CarrierRegistrationFailedException'''.

Note-se que a atribuição do identificador da transportadora é automática e que uma transportadora recém-registada ainda não oferece qualquer modalidade (ver [[#Definir tarifa|Definir tarifa]]).

=== Mostrar transportadora ===

É pedido o identificador da transportadora ('''Prompt.carrierId()'''). Na primeira linha apresenta-se a transportadora; de seguida, as suas tarifas, ordenadas pelo nome da modalidade e indentadas com dois espaços.

{{CollapsedCode|Formato de apresentação de uma transportadora (com tarifas)|
''id'' - ''nome''
␣␣''idTransportadora'' - ''modalidade'' - ''custo adicional'' - ''tempo de transporte''
␣␣...
}}

{{CollapsedCode|Exemplo de apresentação de uma transportadora|
<syntaxhighlight lang="text">
1 - CTT
1 - EXPRESSO - 8 - 1
1 - NORMAL - 3 - 3
</syntaxhighlight>
}}

=== Mostrar transportadoras ===

Apresenta informações sobre todas as transportadoras, ordenando-as pelos seus identificadores, apenas com a linha de resumo (''id'' - ''nome''), sem as tarifas.

=== Definir tarifa ===

São pedidos o identificador da transportadora ('''Prompt.carrierId()'''), a modalidade ('''Prompt.modality()'''), o custo adicional ('''Prompt.rateCost()''') e o tempo de transporte ('''Prompt. rateTransportDays()''').

A transportadora passa a oferecer a modalidade indicada com esses valores, o que é assinalado através da mensagem '''Message.rateSuccessful()'''. Se já oferecia essa modalidade, os valores anteriores são substituídos.

== Menu de Gestão de Compras ==

Este menu apresenta as operações relacionadas com compras e encomendas. A lista completa é a seguinte: [[#Efectuar compra|Efectuar compra]], [[#Mostrar compra|Mostrar compra]], [[#Mostrar compras|Mostrar compras]], [[#Mostrar encomendas de uma compra|Mostrar encomendas de uma compra]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.purchase.Label'''. Os métodos correspondentes aos pedidos deste menu estão definidos em '''erp.app.purchase.Prompt'''. As mensagens do processo de compra pertencem ao [[#Menu de Cabaz|menu de cabaz]] ('''erp.app.basket.Message''').}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.purchase''' (disponível no GIT), respectivamente: '''DoDoPurchase''', '''DoShowPurchase''', '''DoShowPurchases''', '''DoShowPurchaseOrders'''.}}

=== Efectuar compra ===

Esta opção não efectua, por si só, qualquer compra: abre o [[#Menu de Cabaz|menu de cabaz]] sobre o cabaz de um cliente numa empresa.

São pedidos o identificador do cliente e o identificador da empresa. Se ambos existirem, é aberto o [[#Menu de Cabaz|Menu de Cabaz]] sobre o cabaz desse cliente nessa empresa (criado vazio, se ainda não existir).

Como o cabaz pertence ao cliente, sair do menu sem finalizar a compra preserva o seu conteúdo e as suas opções para uma visita posterior.

=== Mostrar compra ===

É pedido o identificador da compra. Na primeira linha apresenta-se a informação da compra; de seguida, apresentam-se as suas encomendas '''em detalhe''' — o cabeçalho de cada encomenda (sem a lista de identificadores de produtos) seguido da descrição completa de cada um dos seus produtos, indentada com dois espaços. As encomendas são apresentadas por ordem crescente da data prevista de entrega e, em caso de empate, pelos identificadores dos produtos.

{{CollapsedCode|Formato de apresentação de uma compra (com encomendas em detalhe)| ''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo''
␣␣''descrição de produto'' ␣␣... }}

{{CollapsedCode|Exemplo de apresentação de uma compra|
<syntaxhighlight lang="text">
1 - 1 - 1 - 1 - 94 - 30 - 124
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 171
</syntaxhighlight>
}}

=== Mostrar compras ===

Apresenta informações sobre todas as compras, ordenando-as pelos seus identificadores, no [[#Formatos de Apresentação|formato de apresentação de uma compra]] (apenas a linha da compra, sem as encomendas).

=== Mostrar encomendas de uma compra ===

É pedido o identificador da compra e são apresentadas as encomendas correspondentes, ordenadas pela data prevista de entrega e, em caso de empate, pelos identificadores dos produtos. Ao contrário de [[#Mostrar compra|Mostrar compra]] (que apresenta as encomendas em detalhe), aqui cada encomenda é apresentada '''de forma resumida''' (uma linha, terminada pela lista de identificadores dos seus produtos), no [[#Formatos de Apresentação|formato de apresentação resumida de uma encomenda]].

{{CollapsedCode|Exemplo de apresentação de encomendas (compra do exemplo anterior)|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

= Leitura de Dados a Partir de Ficheiros Textuais =

Além das opções de manipulação de ficheiros descritas no [[#Menu Principal|menu principal]], é possível iniciar a aplicação com um ficheiro de texto especificado pela propriedade Java '''[[#Execução do Programa e Testes Automáticos|import]]'''.

Cada linha tem uma descrição distinta mas que segue o seguinte formato geral. É possível registar transportadoras, empresas, clientes e produtos, e definir as tarifas das transportadoras e as disponibilizações de produtos por parte das empresas. Assume-se que os campos de texto não podem conter o carácter ''':''' e que os preços são números inteiros. Não existem entradas mal-formadas.

O registo de transportadoras, e das tarifas que cada uma pratica, segue os formatos:
CARRIER:''nome''
RATE:''idTransportadora'':''modalidade'':''custo'':''dias''

As entradas '''RATE''' referem transportadoras já registadas em linhas anteriores. O registo de empresas e de clientes segue os formatos:
COMPANY:''nome''
CLIENT:''nome'':''email''
CLIENT:''nome'':''email'':''mecanismo''

O ''mecanismo'' é '''EMAIL''' ou '''WHATSAPP'''; se for omitido, assume-se '''EMAIL'''. Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:

Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:
NATIONAL:''nome'':''preçoBase'':''categoria'':''prazo''
IMPORTED:''nome'':''preçoBase'':''categoria'':''prazo'':''paisOrigem'':''taxa'':''prazoInternacional''

Note-se que o registo de um produto não indica qualquer empresa nem qualquer inventário: essas são propriedades da disponibilização, descrita por entradas próprias, em que ''unidades'' é o número de exemplares que a empresa tem disponíveis e ''factor'' o multiplicador (real) que aplica ao preço recomendado:
SUPPLY:''idEmpresa'':''idProduto'':''unidades'':''factor''

As entradas '''SUPPLY''' referem empresas e produtos já registados em linhas anteriores.

Um exemplo de conteúdo do ficheiro inicial é como se segue:
{{CollapsedCode|Exemplo de ficheiro de entrada textual|
<syntaxhighlight lang="text">
CARRIER:CTT
RATE:1:NORMAL:3:3
RATE:1:EXPRESSO:8:1
CARRIER:DHL
RATE:2:NORMAL:5:2
RATE:2:EXPRESSO:12:1
CARRIER:SEUR
RATE:3:EXPRESSO:10:1
COMPANY:Moageira Nacional
COMPANY:Importadora Atlantico
CLIENT:Obi-Wan Kenobi:obiwan@jedi.org
CLIENT:Ahsoka Tano:ahsoka@jedi.org:WHATSAPP
NATIONAL:Farinha:15:ALIMENTAR:3
IMPORTED:Telemovel:200:ELECTRONICA:3:China:30:5
NATIONAL:Camisa:45:VESTUARIO:2
SUPPLY:1:1:23:1.0
SUPPLY:2:1:150:0.9
SUPPLY:2:2:2:1.2
SUPPLY:1:3:4:1.1
</syntaxhighlight>
}}

A codificação dos ficheiros a ler é garantidamente [[wp:UTF-8|UTF-8]].

{{Suggestion|Os métodos '''String.split()''', para partir cadeias de caracteres, e '''String.trim()''', para remover espaços no início e no final, podem ser usados no processamento de cada linha.}}
{{Suggestion|Note-se que o programa nunca produz ficheiros com este formato (é apenas um formato para ficheiros de entrada).}}

= Execução do Programa e Testes Automáticos =

Usando os ficheiros '''test.import''', '''test.in''' e '''test.out''', é possível verificar automaticamente o resultado correcto do programa. Note-se que é necessária a definição apropriada da variável '''CLASSPATH''' (ou da opção equivalente '''-cp''' do comando '''java'''), para localizar as classes do programa, incluindo a que contém o método correspondente ao ponto de entrada da aplicação ('''erp.app.App.main'''). As propriedades são tratadas automaticamente pelo código de apoio.

java -Dimport=test.import -Din=test.in -Dout=test.outhyp erp.app.App

Assumindo que aqueles ficheiros estão no directório onde é dado o comando de execução, o programa produz o ficheiro de saída '''test.outhyp'''. Em caso de sucesso, os ficheiros das saídas esperada ('''test.out''') e obtida ('''test.outhyp''') devem ser iguais. A comparação pode ser feita com o comando:
diff -b test.out test.outhyp

Este comando não deve produzir qualquer resultado quando os ficheiros são iguais. Note-se, contudo, que este teste não garante o correcto funcionamento do código desenvolvido, apenas verificando alguns aspectos da sua funcionalidade.

= Notas de Implementação =

Tal como indicado acima, algumas classes fornecidas como [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|material de apoio]], são de uso obrigatório e não podem ser alteradas. Outras dessas classes são de uso obrigatório e têm de ser alteradas.

A serialização Java usa as classes da ''package'' [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/package-summary.html java.io], em particular, a interface [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/Serializable.html java.io. Serializable] e as classes de leitura [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/ObjectInputStream.html java.io.ObjectInputStream] e escrita [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/ObjectOutputStream.html java.io.ObjectOutputStream] (entre outras).

[[category: Ensino]]
[[category:PO]]
[[category: Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T13:24:34Z

Root: /* Menu de Gestão de Compras */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

'''EM PREPARAÇÃO'''

'''ÉPOCA NORMAL'''

O objectivo do projecto é desenvolver um sistema de gestão de entregas rápidas de produtos (ERP — Express Retail Platform). O sistema deverá permitir, entre outras operações, (i) registar dados de empresas; (ii) registar dados de clientes; (iii) registar, gerir e pesquisar produtos; (iv) efectuar e gerir características de compras; (v) gerir as entregas correspondentes; e (vi) notificar os clientes sobre a situação das suas encomendas.

Neste texto, o tipo '''negrito''' indica um literal (i.e., é exactamente como apresentado); o símbolo ␣ indica um espaço; e o tipo ''itálico'' indica uma parte variável (i.e., uma descrição).

= Conceitos e Relações do Modelo =

Existem vários conceitos importantes neste contexto: [[#Empresas|empresas]], [[#Produtos|produtos]], [[#Clientes|clientes]], [[#Transportadoras|transportadoras]], [[#Cabaz de Compras|cabazes]], [[#Compras|compras]], [[#Divisão das Compras em Encomendas|encomendas]] e [[#Entregas|entregas]].

Os conceitos listados não são os únicos possíveis no modelo e as suas relações (assim como relações com outros conceitos não mencionados) podem depender das escolhas do projecto.

Os clientes e os produtos são independentes das empresas: existem por si e podem relacionar-se com várias empresas. Cada empresa, no entanto, mantém registo dos clientes com quem interage, dos produtos que disponibiliza, das compras feitas e das encomendas que expede.

Uma compra representa a aquisição de produtos por um cliente a uma empresa, e resulta de finalizar um [[#Cabaz de Compras|cabaz]]. Uma compra pode dar origem a uma ou mais encomendas, de acordo com a estratégia de divisão de encomendas utilizada.

Cada encomenda pode ser enviada através de uma determinada transportadora e pode incluir serviços adicionais que alteram o seu custo e/ou prazo de entrega.

== Produtos ==

O sistema mantém um registo global de produtos. Cada produto é identificado por um número de produto. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Todos os produtos têm: um nome/descrição (cadeia de caracteres não vazia); um preço base (número inteiro positivo); uma categoria; e um prazo de entrega base (número inteiro de dias).

O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O sistema utiliza o preço base para calcular o preço recomendado do produto. O preço recomendado representa o valor de referência do produto no sistema. O seu cálculo pode depender do tipo de produto e de outras informações disponíveis no sistema.

Cada produto tem uma categoria, de acordo com a sua natureza. Inicialmente, consideram-se as seguintes categorias: (i) alimentar; (ii) electrónica; e (iii) vestuário. Deve ser possível adicionar novas categorias com impacto mínimo na aplicação já desenvolvida.

O produto existe independentemente das empresas que o disponibilizam. Assim, o mesmo produto pode ser disponibilizado por várias empresas, sendo possível que cada uma pratique um preço de venda diferente.

A informação relativa à disponibilização de um produto por uma empresa não deve ser considerada parte das características intrínsecas do produto.

== Tipos de Produto ==

Todos os produtos considerados no sistema são fabricados, mas podem ter diferentes origens.

Inicialmente, consideram-se os seguintes tipos de produto:
* produto nacional;
* produto importado.

Um produto nacional possui apenas as propriedades gerais dos produtos.

Um produto importado possui, para além das propriedades gerais dos produtos:
* um país de origem (cadeia de caracteres não vazia);
* uma taxa alfandegária (número inteiro expressando uma percentagem);
* um prazo de transporte internacional (número inteiro de dias).

O preço recomendado é calculado de forma diferente consoante o tipo de produto.

Deve ser possível introduzir novos tipos de produto com impacto mínimo na implementação desenvolvida.

=== Produtos Nacionais ===

Para um produto nacional, o preço recomendado depende do preço base e do número total de unidades actualmente disponíveis desse produto nas empresas que o disponibilizam.

Se o número total de unidades disponíveis for:
* superior a 10000, o preço recomendado corresponde a 90% do preço base;
* inferior a 100, o preço recomendado corresponde a 130% do preço base;
* nos restantes casos, o preço recomendado corresponde ao preço base.

Por exemplo, considerando um produto nacional com preço base de 100 euros:
* Unidades disponíveis = 50 => Preço recomendado = 130 euros;
* Unidades disponíveis = 5000 => Preço recomendado = 100 euros;
* Unidades disponíveis = 12000 => Preço recomendado = 90 euros.

=== Produtos Importados ===

Para um produto importado, o preço recomendado corresponde ao preço base acrescido da taxa alfandegária.

Se a taxa alfandegária for '''t%''', o preço recomendado é calculado de acordo com:

'''preço base × (100 + t) / 100'''

Por exemplo, considerando um produto importado com preço base de 100 euros e uma taxa alfandegária de 20%, o preço recomendado será:

'''100 × (100 + 20) / 100 = 120 euros'''

O cálculo do preço recomendado deve ser realizado de forma polimórfica, de modo a que o código que utiliza produtos não tenha de conhecer explicitamente o tipo concreto de cada produto.

== Empresas ==

O sistema mantém um registo das empresas que operam na plataforma. Cada empresa é identificada por um número de empresa. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada empresa tem ainda um nome (cadeia de caracteres não vazia).

Uma empresa pode disponibilizar vários produtos e cada produto pode ser disponibilizado por várias empresas.

Para cada produto que disponibiliza, a empresa deve manter informação sobre:
* número de unidades disponíveis (valor inteiro);
* factor multiplicativo do preço recomendado (número positivo).

O número de unidades disponíveis e o factor multiplicativo podem ser diferentes para cada empresa que disponibiliza o mesmo produto.

O factor multiplicativo permite que uma empresa pratique um preço de venda diferente do preço recomendado pelo sistema. O preço de venda de um produto pela empresa é calculado multiplicando o preço recomendado do produto pelo factor multiplicativo definido pela empresa. Assim, duas empresas podem disponibilizar o mesmo produto a preços diferentes e com quantidades diferentes em stock.

Por exemplo, o produto P1, com um preço recomendado de 100 euros, pode ser disponibilizado pela empresa A com um preço de 90 euros, através de um factor multiplicativo de 0,9. A empresa B pode disponibilizar o mesmo produto com um preço de 120 euros, através de um factor multiplicativo de 1,2.

Deve ser possível adicionar outras propriedades às empresas sem impacto significativo no código já desenvolvido.

== Clientes ==

O sistema mantém um registo de clientes. Cada cliente é identificado por um número de cliente. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada cliente tem ainda informação sobre o seu nome e endereço de correio electrónico. Estes campos não podem ser vazios.

Assume-se que os clientes têm sempre dinheiro, i.e., uma compra nunca é recusada por falta de fundos.

== Compras ==

O sistema regista as compras efectuadas pelos clientes. Cada compra é identificada por um número de compra, atribuído automaticamente e incrementalmente. Uma compra é sempre feita por um único cliente a uma única empresa numa determinada data.

Uma compra é constituída por um conjunto de linhas (um "cabaz"). Cada linha corresponde a:
* um produto;
* uma quantidade (número de exemplares adquiridos desse produto);
* um preço unitário (o preço de venda do produto pela empresa no momento da compra);
* um preço total da linha (quantidade × preço unitário).

O preço unitário utilizado numa compra deve ser guardado na própria linha da compra. Alterações posteriores ao preço base, ao preço recomendado, ao factor multiplicativo da empresa, ou a qualquer outra propriedade utilizada no cálculo do preço, não devem alterar o valor de compras já efectuadas.

O preço total dos itens de uma compra é a soma dos preços totais das suas linhas. Uma compra pode dar origem a uma ou mais encomendas, de acordo com uma estratégia de divisão de encomendas.

A divisão de uma compra em várias encomendas pode ter impacto no custo total da compra.

== Cabaz de Compras ==

Antes de dar origem a uma compra, os produtos que um cliente pretende adquirir a uma empresa são acumulados num '''cabaz'''.

Cada cliente tem um cabaz por cada empresa em que compra. O cabaz é constituído por um conjunto de linhas; cada linha corresponde a um produto disponibilizado por essa empresa e a uma quantidade. Acrescentar ao cabaz um produto que já lá esteja acumula as quantidades.

O cabaz regista ainda as opções que serão aplicadas à compra:
* a [[#Divisão das Compras em Encomendas|estratégia de divisão em encomendas]]; * a [[#Transportadoras|transportadora]] e a [[#Transportadoras|modalidade de transporte]]; e
* o conjunto de [[#Serviços Adicionais|serviços adicionais]].

A transportadora, a modalidade e os serviços adicionais escolhidos aplicam-se a '''todas''' as encomendas resultantes da compra.

Enquanto não for finalizado, o cabaz não tem qualquer efeito no resto do sistema: em particular, não reserva nem consome inventário, e os preços apresentados são sempre os preços de venda praticados pela empresa '''nesse momento'''. Um cabaz faz parte do estado persistente da aplicação: pode ser abandonado e retomado mais tarde.

Ao '''finalizar''' o cabaz, e apenas nesse momento:
* os preços de venda são fixados nas linhas da compra;
* a compra é dividida em encomendas de acordo com a estratégia registada no cabaz;
* todas as encomendas recebem a modalidade de transporte e os serviços adicionais registados no cabaz;
* o inventário dos produtos na empresa é decrementado e o cliente é debitado;
* o cabaz fica vazio.

Um cabaz vazio não pode ser finalizado, nem o pode ser um cabaz em que ainda não tenham sido escolhidas transportadora e modalidade. Se, no momento de finalizar, a empresa já não tiver exemplares suficientes de algum dos produtos do cabaz (por exemplo, porque o inventário foi entretanto alterado), a operação falha sem qualquer efeito e o cabaz mantém-se intacto.

== Divisão das Compras em Encomendas ==

Cada encomenda tem um custo base de processamento e expedição, de '''5 euros'''. Assim, uma compra dividida em várias encomendas pode ter um custo superior ao de uma compra enviada numa única encomenda.

O custo base associado às encomendas corresponde ao número de encomendas multiplicado pelo custo base de uma encomenda.

A este custo podem acrescer os custos associados ao método de transporte seleccionado e aos serviços adicionais.

O custo total de uma compra corresponde, assim, ao custo dos produtos acrescido:
* do custo base das encomendas;
* dos custos adicionais das tarifas de transporte;
* dos custos dos serviços adicionais seleccionados.

A forma como uma compra é dividida em encomendas é determinada por uma estratégia de divisão de encomendas. Inicialmente, devem ser suportadas, pelo menos, as seguintes estratégias: encomenda única ('''UNICA''') e agrupamento por prazo de entrega ('''PRAZO''').

=== Encomenda única ===

Todos os produtos da compra são colocados numa única encomenda.

Neste caso, a compra origina uma única encomenda, independentemente dos prazos de entrega dos produtos.

=== Agrupamento por prazo de entrega ===

Os produtos são agrupados de acordo com os seus prazos de entrega.

Calcula-se a média dos prazos de entrega dos produtos das linhas da compra:
* todas as linhas cujo produto tem prazo menor ou igual à média são agrupadas numa única encomenda;
* cada linha cujo produto tem prazo estritamente maior do que a média é enviada separadamente, numa encomenda própria.

Por exemplo, considere-se uma compra com três linhas cujos produtos têm os prazos de entrega 3 (P1), 8 (P2) e 2 (P3). A média dos prazos é (3 + 8 + 2) / 3 ≈ 4,33. Logo, P1 e P3 (prazos ≤ 4,33) seguem juntos numa entrega e P2 (prazo > 4,33) segue numa outra encomenda:
* Encomenda A: {P1, P3} (prazo = 3)
* Encomenda B: {P2} (prazo = 8)

Uma estratégia de divisão que origina várias encomendas pode permitir que alguns produtos sejam entregues mais cedo, mas pode também resultar num custo superior devido ao custo associado a cada encomenda.

Deve ser possível introduzir novas estratégias de divisão de compras em encomendas com impacto mínimo na implementação desenvolvida.

== Transportadoras ==

O sistema mantém um registo das '''transportadoras''' que operam na plataforma. Cada transportadora é identificada por um número de transportadora. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada transportadora tem ainda um nome (cadeia de caracteres não vazia).

Cada encomenda é enviada através de uma transportadora, segundo uma '''modalidade de transporte'''. Inicialmente, devem ser suportadas, pelo menos, as seguintes modalidades: normal ('''NORMAL''') e expresso ('''EXPRESSO''').

Uma modalidade '''não''' define, por si só, qualquer custo ou prazo: é apenas o nome de um nível de serviço. Para cada modalidade que oferece, uma transportadora define uma '''tarifa''', constituída por:
* um custo adicional (número inteiro); e
* um tempo de transporte (número inteiro de dias).

Assim, a mesma modalidade pode custar e demorar valores diferentes consoante a transportadora.

Uma transportadora '''não tem de oferecer todas as modalidades''': oferece exactamente aquelas para as quais tenha uma tarifa definida. Pedir a uma transportadora uma modalidade que ela não oferece é um erro, e não uma escolha silenciosamente ignorada — ver [[#Definir modalidade de transporte|Definir modalidade de transporte]].

Entre os dois, '''a transportadora tem precedência sobre a modalidade''': como as modalidades disponíveis são as da transportadora, só se pode escolher uma modalidade depois de escolhida a transportadora, e mudar de transportadora anula a modalidade anteriormente escolhida (que passa a ser escolhida de novo, de entre as que a nova transportadora oferece).

Por exemplo:
{|
! style="background: #ebebeb;" | '''Transportadora'''
! style="background: #ebebeb;" | '''Modalidade'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo de transporte'''
|-
| CTT || '''NORMAL''' || 3 euros || 3 dias
|-
| CTT || '''EXPRESSO''' || 8 euros || 1 dia
|-
| DHL || '''NORMAL''' || 5 euros || 2 dias
|-
| DHL || '''EXPRESSO''' || 12 euros || 1 dia
|-
| SEUR || '''EXPRESSO''' || 10 euros || 1 dia
|}

No exemplo acima, a transportadora SEUR só oferece a modalidade expresso: não é possível enviar por SEUR em modalidade normal.

A transportadora e a modalidade são escolhidas no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda seja enviada por uma transportadora ou modalidade diferente.

A escolha da transportadora e da modalidade afecta tanto o custo como a data prevista de entrega da encomenda. Uma compra só pode ser finalizada depois de escolhidas ambas, e o par transportadora/modalidade de um cabaz é sempre um par que a transportadora oferece.

Deve ser possível introduzir novas modalidades de transporte com impacto mínimo na implementação desenvolvida. As transportadoras e as suas tarifas, por seu lado, fazem parte do estado da aplicação: são registadas pelo utilizador e não implicam qualquer alteração ao código.

== Serviços Adicionais ==

O cliente pode seleccionar serviços adicionais, podendo aumentar o custo de cada encomenda, assim como o tempo necessário para a sua preparação e entrega. Os serviços são escolhidos no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda tenha os seus próprios serviços.

Os serviços iniciais são os seguintes:
{|
! style="background: #ebebeb;" | '''Serviço'''
! style="background: #ebebeb;" | '''Chave'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo adicional'''
|-
| Embrulho || '''EMBRULHO''' || 2 euros || 1 dia
|-
| Cartão de oferta || '''CARTAO_OFERTA''' || 1 euro || 0 dias
|}

Os serviços adicionais podem ser combinados: uma encomenda pode incluir simultaneamente embrulho, cartão de oferta ou outro serviço adicional. O custo e o tempo adicionais de uma encomenda correspondem à soma dos contributos da modalidade de transporte e de todos os serviços seleccionados.

Deve ser possível introduzir novos serviços adicionais sem alterar o código das encomendas ou dos serviços já existentes.

== Entregas ==

Cada encomenda tem uma data prevista de entrega.
A data prevista de entrega é determinada considerando:
* a data da compra;
* os prazos de entrega dos produtos que constituem a encomenda;
* o tempo de transporte da tarifa da transportadora seleccionada;
* o tempo adicional introduzido pelos serviços seleccionados.

Para uma encomenda com vários produtos, o prazo dos produtos considerados para determinar a data prevista de entrega corresponde ao maior prazo de entrega dos seus produtos.

Não é necessário manter explicitamente um estado para representar se uma encomenda está ou não entregue. A situação da encomenda pode ser determinada a partir da data actual e da sua data prevista de entrega. Assim, uma encomenda é considerada entregue quando a data actual atinge ou ultrapassa a sua data prevista de entrega.

== Gestão de Tempo ==

A unidade de tempo do sistema é o dia. A data do sistema começa no dia 1 (um) e faz parte do estado persistente.

A data do sistema pode ser avançada. Sempre que a data é alterada, devem ser verificadas as encomendas existentes para determinar:
* quais as encomendas que serão entregues no dia seguinte;
* quais as encomendas cuja data prevista de entrega foi atingida ou ultrapassada.

Quando a data actual atinge ou ultrapassa a data prevista de entrega de uma encomenda, esta considera-se entregue.

A gestão do tempo deve ainda desencadear [[#Notificações|notificações]].

== Pesquisas ==

Para permitir que os clientes determinem a existência de um produto, deverá ser possível efectuar pesquisas.

As pesquisas consideram os campos relevantes dos vários produtos, por exemplo, nome, categoria, tipo de produto ou país de origem.

O termo de pesquisa deve ser comparado sem distinção entre letras maiúsculas e minúsculas.

O sistema deve suportar diferentes critérios de pesquisa. Por exemplo, uma pesquisa pode procurar produtos cujo nome contenha determinado termo ou produtos pertencentes a determinada categoria.

Deve ser possível introduzir novos métodos de pesquisa de produtos com impacto mínimo na implementação desenvolvida.

== Alterações de Inventário ==

O inventário de um produto numa empresa pode ser alterado através da especificação de um valor a somar ou subtrair ao número de exemplares disponíveis. Se a quantidade indicada for um valor positivo, aumenta-se o número de exemplares disponíveis.
Se a quantidade indicada for um valor negativo, decrementa-se o número de exemplares disponíveis, desde que o número de exemplares disponíveis não fique negativo.

Um produto não é removido do sistema quando o seu inventário numa empresa chega a zero.
Quando o inventário de um produto numa empresa chega a zero, o produto deixa de estar disponível nessa empresa, mas continua a existir no sistema e pode continuar a ser disponibilizado por outras empresas.
Se o inventário de um produto numa empresa passar de zero para um valor positivo, o produto volta a estar disponível nessa empresa.

O número total de unidades disponíveis de um produto corresponde à soma dos inventários desse produto em todas as empresas que o disponibilizam.

Esta informação é utilizada, nomeadamente, no cálculo do preço recomendado dos produtos nacionais.

== Notificações ==

O sistema deve notificar os clientes relativamente às suas encomendas.

Devem ser enviadas notificações em duas situações:
* um dia antes da data prevista de entrega, informando o cliente de que a encomenda será entregue no dia seguinte;
* no dia da entrega, informando o cliente de que a encomenda foi entregue.

Cada notificação deve ser enviada através do mecanismo de notificação seleccionado pelo cliente.
Inicialmente, devem ser suportados, pelo menos, os seguintes mecanismos:
* correio electrónico ('''EMAIL''');
* WhatsApp ('''WHATSAPP''').

Cada cliente pode escolher o mecanismo através do qual pretende receber notificações do sistema. O mecanismo de notificação pode variar de cliente para cliente. Por exemplo, um cliente pode receber notificações por correio electrónico, enquanto outro pode recebê-las através de WhatsApp.
Deve ser possível introduzir novos mecanismos de notificação sem necessidade de alterar o código dos clientes ou do sistema responsável por gerar as notificações.

Deve ser possível introduzir novos mecanismos de notificação com impacto mínimo na implementação desenvolvida.

As notificações devem ser enviadas pela ordem em que os acontecimentos ocorrem no sistema.

= Requisitos de Desenho =

A aplicação a desenvolver deve seguir o princípio de desenho aberto-fechado, por forma a aumentar a extensibilidade do seu código. Por exemplo, deve ser possível adicionar novos tipos de produto com um impacto mínimo no código já existente da aplicação.

Devem ser possíveis extensões ou alterações de funcionalidade com impacto mínimo no código já produzido para a aplicação. O objectivo é aumentar a flexibilidade da aplicação relativamente ao suporte de novas funções. Assim, deve ser possível:
* Adicionar novos tipos de produto (e.g., produtos digitais ou perecíveis), incluindo a respectiva regra de cálculo do preço recomendado; * Adicionar novas categorias de produto;
* Introduzir novas estratégias de divisão de compras em encomendas;
* Introduzir novas modalidades de transporte (os custos e prazos de cada uma são dados de cada transportadora, não código; nem todas as transportadoras têm de oferecer todas as modalidades);
* Introduzir novos serviços adicionais, sem alterar o código das encomendas nem o dos serviços já existentes;
* Introduzir novos mecanismos de notificação, sem alterar o código dos clientes nem o do sistema que gera as notificações;
* Introduzir novos critérios de discriminação/classificação dos clientes;
* Introduzir novos critérios de pesquisa de produtos.

= Funcionalidade da aplicação =

A aplicação permite manter informação sobre as entidades do modelo, permitindo, em particular, gerir empresas, produtos, clientes e compras. Possui ainda a capacidade de preservar o seu estado (não é possível manter várias versões do estado da aplicação em simultâneo).

Nenhuma entidade é removida pelas operações descritas neste enunciado (em particular, um produto cujo inventário numa empresa chegue a zero continua a existir no sistema). Ainda assim, a aplicação deve estar preparada para que a remoção de qualquer entidade possa vir a ser suportada.

No [[#Leitura de Dados a Partir de Ficheiros Textuais|início]], a aplicação está vazia, mas pode ser carregada uma base de dados textual com conceitos pré-definidos. Neste caso, a aplicação começará com um estado referente às entidades que foram carregadas no arranque da aplicação.

{{Suggestion|Note-se que não é necessário implementar de raiz a aplicação: já existem classes que representam e definem a interface geral da funcionalidade do ''core'' da aplicação, tal como é visível pelos comandos da aplicação.}}
{{CVSCode|A interface geral do ''core'' já está parcialmente implementada na classe '''erp.ErpManager''' e outras fornecidas (cujos nomes devem ser mantidos), devendo ser adaptadas onde necessário. É ainda necessário criar e implementar as restantes classes que suportam a operação da aplicação.}}

== Serialização ==

É possível guardar e recuperar o estado actual da aplicação, preservando toda a informação relacionada com o ERP e que foi descrita [[#Conceitos e Relações do Modelo|acima]].

Após a recuperação do estado, os identificadores atribuídos a novas entidades devem continuar a ser atribuídos incrementalmente a partir do último valor utilizado em cada caso.

= Interacção com o utilizador =

Descreve-se nesta secção a '''funcionalidade máxima''' da interface com o utilizador. Em geral, os comandos pedem toda a informação antes de procederem à sua validação (excepto onde indicado). Todos os menus têm automaticamente a opção '''Sair''' (fecha o menu).

As operações de pedido e apresentação de informação ao utilizador '''devem''' realizar-se através dos objectos ''form'' e ''display'', respectivamente, presentes em cada comando. As mensagens são produzidas pelos métodos das [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|bibliotecas de suporte]] ('''po-uilib''' e '''erp-app'''). As mensagens não podem ser usadas no núcleo da aplicação ('''erp-core'''). Além disso, não podem ser definidas novas. Potenciais omissões devem ser esclarecidas antes de qualquer implementação.

De um modo geral, sempre que no contexto de uma operação com o utilizador aconteça alguma excepção, então a operação não deve ter qualquer efeito no estado da aplicação, excepto em caso de indicação contrária na operação em causa. As excepções estão na package '''erp.app.exceptions''', excepto em caso de indicação contrária.

As excepções usadas na interacção (subclasses de '''pt.tecnico.uilib.menus.CommandException'''), excepto em caso de indicação contrária, são lançadas pelos comandos (subclasses de '''pt.tecnico.uilib.menus.Command''') e tratadas pelos menus (instâncias de subclasses de '''pt.tecnico.uilib.menus.Menu'''). Outras excepções não devem substituir as fornecidas nos casos descritos.

Nos pedidos e usos dos vários identificadores, podem ocorrer as seguintes excepções, caso o identificador indicado não corresponda a um objecto conhecido (excepto no processo de registo ou em caso de indicação contrária). Note-se que estas excepções não são utilizáveis no núcleo da aplicação.

{|
! style="background: #ebebeb;" | '''Tipo de dados'''
! style="background: #ebebeb;" | '''Classe'''
! style="background: #ebebeb;" | '''Pedido a apresentar'''
! style="background: #ebebeb;" | '''Excepção a lançar se desconhecido'''
|-
| Empresa
| '''Company'''
| '''erp.app.company.Prompt.companyId()'''
| '''erp.app.exceptions.UnknownCompanyKeyException'''
|-
| Produto
| '''Product'''
| '''erp.app.product.Prompt.productId()'''
| '''erp.app.exceptions.UnknownProductKeyException'''
|-
| Cliente
| '''Client'''
| '''erp.app.client.Prompt.clientId()'''
| '''erp.app.exceptions.UnknownClientKeyException'''
|-
| Transportadora
| '''Carrier'''
| '''erp.app.carrier.Prompt.carrierId()'''
| '''erp.app.exceptions.UnknownCarrierKeyException'''
|-
| Compra
| '''Purchase'''
| '''erp.app.purchase.Prompt.purchaseId()'''
| '''erp.app.exceptions.UnknownPurchaseKeyException'''
|}

Existe ainda um caso particular: sempre que uma operação se refira a um produto '''no contexto de uma empresa''' e essa empresa não disponibilize esse produto, deve ser lançada a excepção '''erp.app.exceptions.ProductNotSuppliedException''' (a empresa e o produto existem, mas não estão relacionados).

Alguns casos particulares podem usar pedidos específicos não apresentados nesta tabela.

Vários comandos pedem ao utilizador que escolha um valor de um conjunto fechado (tipo de produto, categoria, estratégia de divisão, modalidade de transporte, serviço adicional, mecanismo de notificação e critério de pesquisa). Estas escolhas '''devem''' ser pedidas através de campos de opção ('''Form.addOptionField()''' ou '''Form.requestOption()'''), sendo o conjunto de opções obtido do núcleo através da fachada. Desta forma, a introdução de uma nova estratégia, modalidade, serviço, mecanismo ou critério não implica qualquer alteração aos comandos.

{{CVSCode|Note-se que o programa principal e os comandos e menus, a seguir descritos, já estão parcial ou completamente implementados nas ''packages'' '''erp.app''', '''erp.app.main''', '''erp.app.company''', '''erp.app.product''', '''erp.app.client''', '''erp.app.purchase'''. Estas classes são de uso obrigatório e estão disponíveis no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|GIT]] (módulo '''erp-app''').}}

== Formatos de Apresentação ==

Os formatos usados pelos vários comandos são os seguintes. Todos os campos são separados por '''␣-␣'''.

{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma transportadora|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma tarifa|
''idTransportadora'' - ''modalidade'' - ''custo adicional'' - ''tempo de transporte''
}}

{{CollapsedCode|Formato de apresentação de um produto|
''id'' - ''tipo'' - ''nome'' - ''categoria'' - ''preço base'' - ''preço recomendado'' - ''prazo base'' - ''unidades totais'' - ''informação adicional''
}}

O ''tipo'' é '''NACIONAL''' ou '''IMPORTADO'''. As ''unidades totais'' correspondem à soma dos inventários do produto em todas as empresas que o disponibilizam. Para produtos nacionais não existe informação adicional; para produtos importados, a informação adicional corresponde ao país de origem, à taxa alfandegária e ao prazo de transporte internacional.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 173
2 - IMPORTADO - Telemovel - ELECTRONICA - 200 - 260 - 3 - 2 - China - 30 - 5
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 0
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação da disponibilização de um produto por uma empresa|
''idEmpresa'' - ''idProduto'' - ''unidades'' - ''factor'' - ''preço de venda''
}}

{{CollapsedCode|Exemplos de apresentação de disponibilizações|
<syntaxhighlight lang="text">
2 - 1 - 150 - 0.9 - 14
2 - 2 - 2 - 1.2 - 312
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''mecanismo de notificação'' - ''gasto total''
}}

O valor apresentado no fim corresponde ao total gasto pelo cliente em compras (um valor inteiro).

{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Ahsoka Tano - ahsoka@jedi.org - WHATSAPP - 0
1 - Obi-Wan Kenobi - obiwan@jedi.org - EMAIL - 124
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de uma compra|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
}}

{{CollapsedCode|Formato de apresentação (resumida) de uma encomenda|
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo'' - ''lista de identificadores de produtos''
}}

A ''descrição do transporte'' é o nome da transportadora e a modalidade seleccionadas, separados por '''/''', seguidos das chaves dos serviços adicionais seleccionados, separadas por '''+''' (por exemplo, '''DHL/ EXPRESSO+EMBRULHO+CARTAO_OFERTA'''). O ''custo'' de uma encomenda é o custo base de processamento acrescido do custo da modalidade e dos serviços.

{{CollapsedCode|Exemplos de apresentação de encomendas|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

== Menu Principal ==

As acções deste menu permitem gerir a salvaguarda do estado da aplicação e abrir submenus. A lista completa é a seguinte: [[#Salvaguarda do estado actual da aplicação|Abrir]], [[#Salvaguarda do estado actual da aplicação|Guardar]], [[#Mostrar data actual|Mostrar data actual]], [[#Avançar data actual|Avançar data actual]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Empresas]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Produtos]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Clientes]] e [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Compras]]. Inicialmente, a aplicação apenas tem informação sobre as entidades que foram carregadas no arranque.

{{CVSCode|As etiquetas das opções deste menu estão definidas na classe '''erp.app.main.Label'''. Todos os métodos correspondentes às mensagens de diálogo para este menu estão definidos na classe '''erp.app.main.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.main''', respectivamente: '''DoOpenFile''', '''DoSaveFile''', '''DoDisplayDate''', '''DoAdvanceDate''', '''DoOpenMenuCompanies''', '''DoOpenMenuProducts''', '''DoOpenMenuClients''', '''DoOpenMenuPurchases'''.}}

=== Salvaguarda do estado actual da aplicação ===

O conteúdo da aplicação (toda a informação detida pelo ERP actualmente em memória) pode ser guardado para posterior recuperação (via serialização Java: '''java.io.Serializable'''). Na leitura e escrita do estado da aplicação, devem ser tratadas as excepções associadas. A funcionalidade é a seguinte:

* '''Abrir''' -- Carrega os dados de uma sessão anterior a partir de um ficheiro previamente guardado (ficando este ficheiro associado à aplicação, para futuras operações de salvaguarda). Pede-se o nome do ficheiro a abrir ('''Prompt.openFile()'''). Caso ocorra um problema na abertura ou processamento do ficheiro, deve ser lançada a excepção '''FileOpenFailedException'''. A execução bem-sucedida desta opção substitui toda a informação da aplicação. Quando se abandona uma aplicação com modificações não guardadas (porque se abre outra e existem alterações não guardadas), deve perguntar-se ao utilizador se quer guardar a informação actual antes de a abandonar, através de '''Prompt.saveBeforeExit()''' (a resposta é obtida via '''Form.confirm()''').

* '''Guardar''' -- Guarda o estado actual da aplicação no ficheiro associado. Se não existir associação, pede-se o nome do ficheiro a utilizar, ficando a ele associado (para operações de salvaguarda subsequentes). Esta interacção realiza-se através do método '''Prompt.newSaveAs()'''. Não é executada nenhuma acção se não existirem alterações desde a última salvaguarda.

{{Suggestion|Note-se que a opção '''Abrir''' não permite a leitura de ficheiros de texto (estes apenas podem ser utilizados no início da aplicação).}}
{{Suggestion|A opção '''Sair''' nunca implica a salvaguarda do estado da aplicação, mesmo que existam alterações.}}

=== Mostrar data actual ===

A data actual do sistema é apresentada através da mensagem '''Message.currentDate()'''.

=== Avançar data actual ===

O número de dias a avançar é pedido através de '''Prompt.daysToAdvance()'''. O valor indicado deve ser positivo. Caso contrário, a operação não tem efeito.

Além da data, o sistema deve actualizar, caso seja necessário, outros aspectos que dela dependam, designadamente, a situação das entregas relativa às suas datas de chegada.

=== Gestão e consulta de dados da aplicação ===

* '''Menu de Gestão de Empresas''' -- Abre o menu de gestão de empresas e operações associadas.
* '''Menu de Gestão de Produtos''' -- Abre o menu de gestão de produtos e operações associadas.
* '''Menu de Gestão de Clientes''' -- Abre o menu de gestão de clientes e operações associadas.
* '''Menu de Gestão de Compras''' -- Abre o menu de gestão de compras e operações associadas.

== Menu de Gestão de Empresas ==

Este menu permite efectuar operações sobre a base de dados de empresas. A lista completa é a seguinte: [[#Registar empresa|Registar empresa]], [[#Mostrar empresa|Mostrar empresa]], [[#Mostrar empresas|Mostrar empresas]], [[#Mostrar produtos de uma empresa|Mostrar produtos de uma empresa]], [[#Mostrar clientes de uma empresa|Mostrar clientes de uma empresa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.company.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.company.Prompt''' e '''erp.app.company.Message'''.}}

=== Registar empresa ===

Pede o nome ('''Prompt.companyName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CompanyRegistrationFailedException'''.

Note-se que a atribuição do identificador da empresa é automática.

=== Mostrar empresa ===

É pedido o identificador da empresa, sendo apresentadas as informações sobre essa empresa, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

=== Mostrar empresas ===

Apresenta informações sobre todas as empresas, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar empresa|Mostrar empresa]].

=== Mostrar produtos de uma empresa ===

É pedido o identificador da empresa e apresentam-se os produtos que essa empresa vende, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar produto|Mostrar produto]].

=== Mostrar clientes de uma empresa ===

É pedido o identificador da empresa e apresentam-se os clientes que já interagiram com essa empresa, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar cliente|Mostrar cliente]].

== Menu de Gestão de Produtos ==

Este menu apresenta as operações disponíveis sobre produtos. A lista completa é a seguinte: [[#Mostrar produto|Mostrar produto]], [[#Mostrar produtos|Mostrar produtos]], [[#Alterar inventário de um produto|Alterar inventário de um produto]] e [[#Efectuar pesquisa|Efectuar pesquisa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.product.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.product.Prompt''' e '''erp.app.product.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.product''' (disponível no GIT), respectivamente: '''DoShowProduct''', '''DoShowProducts''', '''DoChangeProductInventory''', '''DoPerformSearch'''.}}

=== Mostrar produto ===

É pedido o identificador do produto. Se o produto existir, é apresentado de acordo com o seguinte formato. O formato genérico de apresentação de um produto é como se segue:
{{CollapsedCode|Formato de apresentação de produtos|
''id'' - ''stock'' - ''tipo'' - ''nome'' - ''preço'' - ''categoria'' - ''informação adicional''
}}

Para produtos fabricados, a informação adicional corresponde ao nome do fabricante e ao código de fabrico (separados pelo carácter ''';'''); para produtos importados, a informação adicional corresponde ao país de origem e à taxa alfandegária.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
3 - 20 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
4 - 2 - IMPORTADO - Telemóvel - 200 - ELECTRONICA - China - 30
5 - 0 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

=== Mostrar produtos ===

Apresenta informações sobre todos os produtos, ordenando-os pelos seus identificadores. O formato de apresentação é como descrito em [[#Mostrar produto|Mostrar produto]].

=== Alterar inventário de um produto ===

É pedido o identificador de um produto e uma quantidade ('''Prompt.amountToUpdate()''') e actualizado o número de exemplares disponíveis do produto indicado somando a quantidade indicada ao número de exemplares disponíveis. No caso de não ser possível actualizar o número de exemplares devido ao facto de a quantidade indicada ser inválida, então a operação não deve ter qualquer efeito e deve ser apresentada a mensagem '''Message.notEnoughInventory()'''.

=== Efectuar pesquisa ===

Esta opção realiza uma procura por termo (cadeia de caracteres), pedido através de '''Prompt.searchTerm()'''. Como resultado, deve ser apresentada uma lista dos produtos encontrados pela pesquisa, ordenados por ordem crescente do seu identificador, utilizando o formato descrito para [[#Mostrar produto|Mostrar produto]].

O termo de pesquisa deve ser comparado (sem distinção entre letras maiúsculas e minúsculas) com os campos relevantes de cada produto: o nome e a categoria. Só devem ser apresentados produtos que contenham o termo de pesquisa num dos campos relevantes. Caso não sejam encontrados produtos, não deve ser produzido qualquer resultado.

== Menu de Gestão de Clientes ==

Este menu permite efectuar operações sobre a base de dados de clientes. A lista completa é a seguinte: [[#Registar cliente|Registar cliente]], [[#Mostrar cliente|Mostrar cliente]], [[#Mostrar clientes|Mostrar clientes]], [[#Mostrar notificações do cliente|Mostrar notificações do cliente]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.client.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.client.Prompt''' e '''erp.app.client.Message'''.}}

=== Registar cliente ===

Pede o nome ('''Prompt.clientName()''') e o endereço de correio electrónico ('''Prompt.clientEMail()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''ClientRegistrationFailedException'''.

Note-se que a atribuição do identificador do cliente é automática e que clientes diferentes são registados em cada operação de registo.

=== Mostrar cliente ===

É pedido o identificador do cliente, sendo apresentadas as informações sobre esse cliente, de acordo com o seguinte formato. O valor apresentado após o email corresponde ao total gasto pelo cliente em compras (um valor inteiro).
{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''gasto total''
}}
{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Alberto Meireles - ameireles@mymail.com - 275
1 - Fernando Meireles - fmeireles@mymail.com - 0
</syntaxhighlight>
}}

=== Mostrar clientes ===

Apresenta informações sobre todos os clientes, ordenando-os lexicograficamente pelo nome. Caso existam clientes com o mesmo nome, devem ser ordenados por ordem crescente dos seus identificadores. O formato é o descrito em [[#Mostrar cliente|Mostrar cliente]].

=== Mostrar notificações do cliente ===

É pedido o identificador do cliente, sendo apresentadas as notificações para esse cliente, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação das notificações de um cliente|
DISPONIBILIDADE: ''descrição de produto disponível''
}}
{{CollapsedCode|Exemplos de notificações|
<syntaxhighlight lang="text">
DISPONIBILIDADE: 5 - 4 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

Note-se que a descrição é idêntica à que é realizada para mostrar cada produto. No entanto, a solução deve ser suficientemente flexível para permitir outros formatos de apresentação das notificações (sem impacto no código do domínio da aplicação).

== Menu de Gestão de Transportadoras ==

Este menu permite efectuar operações sobre a base de dados de transportadoras. A lista completa é a seguinte: [[#Registar transportadora|Registar transportadora]], [[#Mostrar transportadora|Mostrar transportadora]], [[#Mostrar transportadoras|Mostrar transportadoras]], [[#Definir tarifa|Definir tarifa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.carrier.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.carrier.Prompt''' e '''erp.app.carrier.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.carrier''', respectivamente: '''DoRegisterCarrier''', '''DoShowCarrier''', '''DoShowCarriers''' e '''DoSetRate'''.}}

=== Registar transportadora ===

Pede o nome ('''Prompt.carrierName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CarrierRegistrationFailedException'''.

Note-se que a atribuição do identificador da transportadora é automática e que uma transportadora recém-registada ainda não oferece qualquer modalidade (ver [[#Definir tarifa|Definir tarifa]]).

=== Mostrar transportadora ===

É pedido o identificador da transportadora ('''Prompt.carrierId()'''). Na primeira linha apresenta-se a transportadora; de seguida, as suas tarifas, ordenadas pelo nome da modalidade e indentadas com dois espaços.

{{CollapsedCode|Formato de apresentação de uma transportadora (com tarifas)|
''id'' - ''nome''
␣␣''idTransportadora'' - ''modalidade'' - ''custo adicional'' - ''tempo de transporte''
␣␣...
}}

{{CollapsedCode|Exemplo de apresentação de uma transportadora|
<syntaxhighlight lang="text">
1 - CTT
1 - EXPRESSO - 8 - 1
1 - NORMAL - 3 - 3
</syntaxhighlight>
}}

=== Mostrar transportadoras ===

Apresenta informações sobre todas as transportadoras, ordenando-as pelos seus identificadores, apenas com a linha de resumo (''id'' - ''nome''), sem as tarifas.

=== Definir tarifa ===

São pedidos o identificador da transportadora ('''Prompt.carrierId()'''), a modalidade ('''Prompt.modality()'''), o custo adicional ('''Prompt.rateCost()''') e o tempo de transporte ('''Prompt. rateTransportDays()''').

A transportadora passa a oferecer a modalidade indicada com esses valores, o que é assinalado através da mensagem '''Message.rateSuccessful()'''. Se já oferecia essa modalidade, os valores anteriores são substituídos.

== Menu de Gestão de Compras ==

Este menu apresenta as operações relacionadas com compras e encomendas. A lista completa é a seguinte: [[#Efectuar compra|Efectuar compra]], [[#Mostrar compra|Mostrar compra]], [[#Mostrar compras|Mostrar compras]], [[#Mostrar encomendas de uma compra|Mostrar encomendas de uma compra]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.purchase.Label'''. Os métodos correspondentes aos pedidos deste menu estão definidos em '''erp.app.purchase.Prompt'''. As mensagens do processo de compra pertencem ao [[#Menu de Cabaz|menu de cabaz]] ('''erp.app.basket.Message''').}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.purchase''' (disponível no GIT), respectivamente: '''DoDoPurchase''', '''DoShowPurchase''', '''DoShowPurchases''', '''DoShowPurchaseOrders'''.}}

=== Efectuar compra ===

Esta opção não efectua, por si só, qualquer compra: abre o [[#Menu de Cabaz|menu de cabaz]] sobre o cabaz de um cliente numa empresa.

São pedidos o identificador do cliente e o identificador da empresa. Se ambos existirem, é aberto o [[#Menu de Cabaz|Menu de Cabaz]] sobre o cabaz desse cliente nessa empresa (criado vazio, se ainda não existir).

Como o cabaz pertence ao cliente, sair do menu sem finalizar a compra preserva o seu conteúdo e as suas opções para uma visita posterior.

=== Mostrar compra ===

É pedido o identificador da compra. Na primeira linha apresenta-se a informação da compra; de seguida, apresentam-se as suas encomendas '''em detalhe''' — o cabeçalho de cada encomenda (sem a lista de identificadores de produtos) seguido da descrição completa de cada um dos seus produtos, indentada com dois espaços. As encomendas são apresentadas por ordem crescente da data prevista de entrega e, em caso de empate, pelos identificadores dos produtos.

{{CollapsedCode|Formato de apresentação de uma compra (com encomendas em detalhe)| ''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo''
␣␣''descrição de produto'' ␣␣... }}

{{CollapsedCode|Exemplo de apresentação de uma compra|
<syntaxhighlight lang="text">
1 - 1 - 1 - 1 - 94 - 30 - 124
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 171
</syntaxhighlight>
}}

=== Mostrar compras ===

Apresenta informações sobre todas as compras, ordenando-as pelos seus identificadores, no [[#Formatos de Apresentação|formato de apresentação de uma compra]] (apenas a linha da compra, sem as encomendas).

=== Mostrar encomendas de uma compra ===

É pedido o identificador da compra e são apresentadas as encomendas correspondentes, ordenadas pela data prevista de entrega e, em caso de empate, pelos identificadores dos produtos. Ao contrário de [[#Mostrar compra|Mostrar compra]] (que apresenta as encomendas em detalhe), aqui cada encomenda é apresentada '''de forma resumida''' (uma linha, terminada pela lista de identificadores dos seus produtos), no [[#Formatos de Apresentação|formato de apresentação resumida de uma encomenda]].

{{CollapsedCode|Exemplo de apresentação de encomendas (compra do exemplo anterior)|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

= Leitura de Dados a Partir de Ficheiros Textuais =

Além das opções de manipulação de ficheiros descritas no [[#Menu Principal|menu principal]], é possível iniciar a aplicação com um ficheiro de texto especificado pela propriedade Java '''[[#Execução do Programa e Testes Automáticos|import]]'''.

Cada linha tem uma descrição distinta mas que segue o seguinte formato geral. É possível registar transportadoras, empresas, clientes e produtos, e definir as tarifas das transportadoras e as disponibilizações de produtos por parte das empresas. Assume-se que os campos de texto não podem conter o carácter ''':''' e que os preços são números inteiros. Não existem entradas mal-formadas.

O registo de transportadoras, e das tarifas que cada uma pratica, segue os formatos:
CARRIER:''nome''
RATE:''idTransportadora'':''modalidade'':''custo'':''dias''

As entradas '''RATE''' referem transportadoras já registadas em linhas anteriores. O registo de empresas e de clientes segue os formatos:
COMPANY:''nome''
CLIENT:''nome'':''email''
CLIENT:''nome'':''email'':''mecanismo''

O ''mecanismo'' é '''EMAIL''' ou '''WHATSAPP'''; se for omitido, assume-se '''EMAIL'''. Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:

Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:
NATIONAL:''nome'':''preçoBase'':''categoria'':''prazo''
IMPORTED:''nome'':''preçoBase'':''categoria'':''prazo'':''paisOrigem'':''taxa'':''prazoInternacional''

Note-se que o registo de um produto não indica qualquer empresa nem qualquer inventário: essas são propriedades da disponibilização, descrita por entradas próprias, em que ''unidades'' é o número de exemplares que a empresa tem disponíveis e ''factor'' o multiplicador (real) que aplica ao preço recomendado:
SUPPLY:''idEmpresa'':''idProduto'':''unidades'':''factor''

As entradas '''SUPPLY''' referem empresas e produtos já registados em linhas anteriores.

Um exemplo de conteúdo do ficheiro inicial é como se segue:
{{CollapsedCode|Exemplo de ficheiro de entrada textual|
<syntaxhighlight lang="text">
CARRIER:CTT
RATE:1:NORMAL:3:3
RATE:1:EXPRESSO:8:1
CARRIER:DHL
RATE:2:NORMAL:5:2
RATE:2:EXPRESSO:12:1
CARRIER:SEUR
RATE:3:EXPRESSO:10:1
COMPANY:Moageira Nacional
COMPANY:Importadora Atlantico
CLIENT:Obi-Wan Kenobi:obiwan@jedi.org
CLIENT:Ahsoka Tano:ahsoka@jedi.org:WHATSAPP
NATIONAL:Farinha:15:ALIMENTAR:3
IMPORTED:Telemovel:200:ELECTRONICA:3:China:30:5
NATIONAL:Camisa:45:VESTUARIO:2
SUPPLY:1:1:23:1.0
SUPPLY:2:1:150:0.9
SUPPLY:2:2:2:1.2
SUPPLY:1:3:4:1.1
</syntaxhighlight>
}}

A codificação dos ficheiros a ler é garantidamente [[wp:UTF-8|UTF-8]].

{{Suggestion|Os métodos '''String.split()''', para partir cadeias de caracteres, e '''String.trim()''', para remover espaços no início e no final, podem ser usados no processamento de cada linha.}}
{{Suggestion|Note-se que o programa nunca produz ficheiros com este formato (é apenas um formato para ficheiros de entrada).}}

= Execução do Programa e Testes Automáticos =

Usando os ficheiros '''test.import''', '''test.in''' e '''test.out''', é possível verificar automaticamente o resultado correcto do programa. Note-se que é necessária a definição apropriada da variável '''CLASSPATH''' (ou da opção equivalente '''-cp''' do comando '''java'''), para localizar as classes do programa, incluindo a que contém o método correspondente ao ponto de entrada da aplicação ('''erp.app.App.main'''). As propriedades são tratadas automaticamente pelo código de apoio.

java -Dimport=test.import -Din=test.in -Dout=test.outhyp erp.app.App

Assumindo que aqueles ficheiros estão no directório onde é dado o comando de execução, o programa produz o ficheiro de saída '''test.outhyp'''. Em caso de sucesso, os ficheiros das saídas esperada ('''test.out''') e obtida ('''test.outhyp''') devem ser iguais. A comparação pode ser feita com o comando:
diff -b test.out test.outhyp

Este comando não deve produzir qualquer resultado quando os ficheiros são iguais. Note-se, contudo, que este teste não garante o correcto funcionamento do código desenvolvido, apenas verificando alguns aspectos da sua funcionalidade.

= Notas de Implementação =

Tal como indicado acima, algumas classes fornecidas como [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|material de apoio]], são de uso obrigatório e não podem ser alteradas. Outras dessas classes são de uso obrigatório e têm de ser alteradas.

A serialização Java usa as classes da ''package'' [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/package-summary.html java.io], em particular, a interface [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/Serializable.html java.io. Serializable] e as classes de leitura [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/ObjectInputStream.html java.io.ObjectInputStream] e escrita [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/ObjectOutputStream.html java.io.ObjectOutputStream] (entre outras).

[[category: Ensino]]
[[category:PO]]
[[category: Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T13:20:09Z

Root: /* Menu de Gestão de Compras */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

'''EM PREPARAÇÃO'''

'''ÉPOCA NORMAL'''

O objectivo do projecto é desenvolver um sistema de gestão de entregas rápidas de produtos (ERP — Express Retail Platform). O sistema deverá permitir, entre outras operações, (i) registar dados de empresas; (ii) registar dados de clientes; (iii) registar, gerir e pesquisar produtos; (iv) efectuar e gerir características de compras; (v) gerir as entregas correspondentes; e (vi) notificar os clientes sobre a situação das suas encomendas.

Neste texto, o tipo '''negrito''' indica um literal (i.e., é exactamente como apresentado); o símbolo ␣ indica um espaço; e o tipo ''itálico'' indica uma parte variável (i.e., uma descrição).

= Conceitos e Relações do Modelo =

Existem vários conceitos importantes neste contexto: [[#Empresas|empresas]], [[#Produtos|produtos]], [[#Clientes|clientes]], [[#Transportadoras|transportadoras]], [[#Cabaz de Compras|cabazes]], [[#Compras|compras]], [[#Divisão das Compras em Encomendas|encomendas]] e [[#Entregas|entregas]].

Os conceitos listados não são os únicos possíveis no modelo e as suas relações (assim como relações com outros conceitos não mencionados) podem depender das escolhas do projecto.

Os clientes e os produtos são independentes das empresas: existem por si e podem relacionar-se com várias empresas. Cada empresa, no entanto, mantém registo dos clientes com quem interage, dos produtos que disponibiliza, das compras feitas e das encomendas que expede.

Uma compra representa a aquisição de produtos por um cliente a uma empresa, e resulta de finalizar um [[#Cabaz de Compras|cabaz]]. Uma compra pode dar origem a uma ou mais encomendas, de acordo com a estratégia de divisão de encomendas utilizada.

Cada encomenda pode ser enviada através de uma determinada transportadora e pode incluir serviços adicionais que alteram o seu custo e/ou prazo de entrega.

== Produtos ==

O sistema mantém um registo global de produtos. Cada produto é identificado por um número de produto. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Todos os produtos têm: um nome/descrição (cadeia de caracteres não vazia); um preço base (número inteiro positivo); uma categoria; e um prazo de entrega base (número inteiro de dias).

O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O sistema utiliza o preço base para calcular o preço recomendado do produto. O preço recomendado representa o valor de referência do produto no sistema. O seu cálculo pode depender do tipo de produto e de outras informações disponíveis no sistema.

Cada produto tem uma categoria, de acordo com a sua natureza. Inicialmente, consideram-se as seguintes categorias: (i) alimentar; (ii) electrónica; e (iii) vestuário. Deve ser possível adicionar novas categorias com impacto mínimo na aplicação já desenvolvida.

O produto existe independentemente das empresas que o disponibilizam. Assim, o mesmo produto pode ser disponibilizado por várias empresas, sendo possível que cada uma pratique um preço de venda diferente.

A informação relativa à disponibilização de um produto por uma empresa não deve ser considerada parte das características intrínsecas do produto.

== Tipos de Produto ==

Todos os produtos considerados no sistema são fabricados, mas podem ter diferentes origens.

Inicialmente, consideram-se os seguintes tipos de produto:
* produto nacional;
* produto importado.

Um produto nacional possui apenas as propriedades gerais dos produtos.

Um produto importado possui, para além das propriedades gerais dos produtos:
* um país de origem (cadeia de caracteres não vazia);
* uma taxa alfandegária (número inteiro expressando uma percentagem);
* um prazo de transporte internacional (número inteiro de dias).

O preço recomendado é calculado de forma diferente consoante o tipo de produto.

Deve ser possível introduzir novos tipos de produto com impacto mínimo na implementação desenvolvida.

=== Produtos Nacionais ===

Para um produto nacional, o preço recomendado depende do preço base e do número total de unidades actualmente disponíveis desse produto nas empresas que o disponibilizam.

Se o número total de unidades disponíveis for:
* superior a 10000, o preço recomendado corresponde a 90% do preço base;
* inferior a 100, o preço recomendado corresponde a 130% do preço base;
* nos restantes casos, o preço recomendado corresponde ao preço base.

Por exemplo, considerando um produto nacional com preço base de 100 euros:
* Unidades disponíveis = 50 => Preço recomendado = 130 euros;
* Unidades disponíveis = 5000 => Preço recomendado = 100 euros;
* Unidades disponíveis = 12000 => Preço recomendado = 90 euros.

=== Produtos Importados ===

Para um produto importado, o preço recomendado corresponde ao preço base acrescido da taxa alfandegária.

Se a taxa alfandegária for '''t%''', o preço recomendado é calculado de acordo com:

'''preço base × (100 + t) / 100'''

Por exemplo, considerando um produto importado com preço base de 100 euros e uma taxa alfandegária de 20%, o preço recomendado será:

'''100 × (100 + 20) / 100 = 120 euros'''

O cálculo do preço recomendado deve ser realizado de forma polimórfica, de modo a que o código que utiliza produtos não tenha de conhecer explicitamente o tipo concreto de cada produto.

== Empresas ==

O sistema mantém um registo das empresas que operam na plataforma. Cada empresa é identificada por um número de empresa. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada empresa tem ainda um nome (cadeia de caracteres não vazia).

Uma empresa pode disponibilizar vários produtos e cada produto pode ser disponibilizado por várias empresas.

Para cada produto que disponibiliza, a empresa deve manter informação sobre:
* número de unidades disponíveis (valor inteiro);
* factor multiplicativo do preço recomendado (número positivo).

O número de unidades disponíveis e o factor multiplicativo podem ser diferentes para cada empresa que disponibiliza o mesmo produto.

O factor multiplicativo permite que uma empresa pratique um preço de venda diferente do preço recomendado pelo sistema. O preço de venda de um produto pela empresa é calculado multiplicando o preço recomendado do produto pelo factor multiplicativo definido pela empresa. Assim, duas empresas podem disponibilizar o mesmo produto a preços diferentes e com quantidades diferentes em stock.

Por exemplo, o produto P1, com um preço recomendado de 100 euros, pode ser disponibilizado pela empresa A com um preço de 90 euros, através de um factor multiplicativo de 0,9. A empresa B pode disponibilizar o mesmo produto com um preço de 120 euros, através de um factor multiplicativo de 1,2.

Deve ser possível adicionar outras propriedades às empresas sem impacto significativo no código já desenvolvido.

== Clientes ==

O sistema mantém um registo de clientes. Cada cliente é identificado por um número de cliente. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada cliente tem ainda informação sobre o seu nome e endereço de correio electrónico. Estes campos não podem ser vazios.

Assume-se que os clientes têm sempre dinheiro, i.e., uma compra nunca é recusada por falta de fundos.

== Compras ==

O sistema regista as compras efectuadas pelos clientes. Cada compra é identificada por um número de compra, atribuído automaticamente e incrementalmente. Uma compra é sempre feita por um único cliente a uma única empresa numa determinada data.

Uma compra é constituída por um conjunto de linhas (um "cabaz"). Cada linha corresponde a:
* um produto;
* uma quantidade (número de exemplares adquiridos desse produto);
* um preço unitário (o preço de venda do produto pela empresa no momento da compra);
* um preço total da linha (quantidade × preço unitário).

O preço unitário utilizado numa compra deve ser guardado na própria linha da compra. Alterações posteriores ao preço base, ao preço recomendado, ao factor multiplicativo da empresa, ou a qualquer outra propriedade utilizada no cálculo do preço, não devem alterar o valor de compras já efectuadas.

O preço total dos itens de uma compra é a soma dos preços totais das suas linhas. Uma compra pode dar origem a uma ou mais encomendas, de acordo com uma estratégia de divisão de encomendas.

A divisão de uma compra em várias encomendas pode ter impacto no custo total da compra.

== Cabaz de Compras ==

Antes de dar origem a uma compra, os produtos que um cliente pretende adquirir a uma empresa são acumulados num '''cabaz'''.

Cada cliente tem um cabaz por cada empresa em que compra. O cabaz é constituído por um conjunto de linhas; cada linha corresponde a um produto disponibilizado por essa empresa e a uma quantidade. Acrescentar ao cabaz um produto que já lá esteja acumula as quantidades.

O cabaz regista ainda as opções que serão aplicadas à compra:
* a [[#Divisão das Compras em Encomendas|estratégia de divisão em encomendas]]; * a [[#Transportadoras|transportadora]] e a [[#Transportadoras|modalidade de transporte]]; e
* o conjunto de [[#Serviços Adicionais|serviços adicionais]].

A transportadora, a modalidade e os serviços adicionais escolhidos aplicam-se a '''todas''' as encomendas resultantes da compra.

Enquanto não for finalizado, o cabaz não tem qualquer efeito no resto do sistema: em particular, não reserva nem consome inventário, e os preços apresentados são sempre os preços de venda praticados pela empresa '''nesse momento'''. Um cabaz faz parte do estado persistente da aplicação: pode ser abandonado e retomado mais tarde.

Ao '''finalizar''' o cabaz, e apenas nesse momento:
* os preços de venda são fixados nas linhas da compra;
* a compra é dividida em encomendas de acordo com a estratégia registada no cabaz;
* todas as encomendas recebem a modalidade de transporte e os serviços adicionais registados no cabaz;
* o inventário dos produtos na empresa é decrementado e o cliente é debitado;
* o cabaz fica vazio.

Um cabaz vazio não pode ser finalizado, nem o pode ser um cabaz em que ainda não tenham sido escolhidas transportadora e modalidade. Se, no momento de finalizar, a empresa já não tiver exemplares suficientes de algum dos produtos do cabaz (por exemplo, porque o inventário foi entretanto alterado), a operação falha sem qualquer efeito e o cabaz mantém-se intacto.

== Divisão das Compras em Encomendas ==

Cada encomenda tem um custo base de processamento e expedição, de '''5 euros'''. Assim, uma compra dividida em várias encomendas pode ter um custo superior ao de uma compra enviada numa única encomenda.

O custo base associado às encomendas corresponde ao número de encomendas multiplicado pelo custo base de uma encomenda.

A este custo podem acrescer os custos associados ao método de transporte seleccionado e aos serviços adicionais.

O custo total de uma compra corresponde, assim, ao custo dos produtos acrescido:
* do custo base das encomendas;
* dos custos adicionais das tarifas de transporte;
* dos custos dos serviços adicionais seleccionados.

A forma como uma compra é dividida em encomendas é determinada por uma estratégia de divisão de encomendas. Inicialmente, devem ser suportadas, pelo menos, as seguintes estratégias: encomenda única ('''UNICA''') e agrupamento por prazo de entrega ('''PRAZO''').

=== Encomenda única ===

Todos os produtos da compra são colocados numa única encomenda.

Neste caso, a compra origina uma única encomenda, independentemente dos prazos de entrega dos produtos.

=== Agrupamento por prazo de entrega ===

Os produtos são agrupados de acordo com os seus prazos de entrega.

Calcula-se a média dos prazos de entrega dos produtos das linhas da compra:
* todas as linhas cujo produto tem prazo menor ou igual à média são agrupadas numa única encomenda;
* cada linha cujo produto tem prazo estritamente maior do que a média é enviada separadamente, numa encomenda própria.

Por exemplo, considere-se uma compra com três linhas cujos produtos têm os prazos de entrega 3 (P1), 8 (P2) e 2 (P3). A média dos prazos é (3 + 8 + 2) / 3 ≈ 4,33. Logo, P1 e P3 (prazos ≤ 4,33) seguem juntos numa entrega e P2 (prazo > 4,33) segue numa outra encomenda:
* Encomenda A: {P1, P3} (prazo = 3)
* Encomenda B: {P2} (prazo = 8)

Uma estratégia de divisão que origina várias encomendas pode permitir que alguns produtos sejam entregues mais cedo, mas pode também resultar num custo superior devido ao custo associado a cada encomenda.

Deve ser possível introduzir novas estratégias de divisão de compras em encomendas com impacto mínimo na implementação desenvolvida.

== Transportadoras ==

O sistema mantém um registo das '''transportadoras''' que operam na plataforma. Cada transportadora é identificada por um número de transportadora. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada transportadora tem ainda um nome (cadeia de caracteres não vazia).

Cada encomenda é enviada através de uma transportadora, segundo uma '''modalidade de transporte'''. Inicialmente, devem ser suportadas, pelo menos, as seguintes modalidades: normal ('''NORMAL''') e expresso ('''EXPRESSO''').

Uma modalidade '''não''' define, por si só, qualquer custo ou prazo: é apenas o nome de um nível de serviço. Para cada modalidade que oferece, uma transportadora define uma '''tarifa''', constituída por:
* um custo adicional (número inteiro); e
* um tempo de transporte (número inteiro de dias).

Assim, a mesma modalidade pode custar e demorar valores diferentes consoante a transportadora.

Uma transportadora '''não tem de oferecer todas as modalidades''': oferece exactamente aquelas para as quais tenha uma tarifa definida. Pedir a uma transportadora uma modalidade que ela não oferece é um erro, e não uma escolha silenciosamente ignorada — ver [[#Definir modalidade de transporte|Definir modalidade de transporte]].

Entre os dois, '''a transportadora tem precedência sobre a modalidade''': como as modalidades disponíveis são as da transportadora, só se pode escolher uma modalidade depois de escolhida a transportadora, e mudar de transportadora anula a modalidade anteriormente escolhida (que passa a ser escolhida de novo, de entre as que a nova transportadora oferece).

Por exemplo:
{|
! style="background: #ebebeb;" | '''Transportadora'''
! style="background: #ebebeb;" | '''Modalidade'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo de transporte'''
|-
| CTT || '''NORMAL''' || 3 euros || 3 dias
|-
| CTT || '''EXPRESSO''' || 8 euros || 1 dia
|-
| DHL || '''NORMAL''' || 5 euros || 2 dias
|-
| DHL || '''EXPRESSO''' || 12 euros || 1 dia
|-
| SEUR || '''EXPRESSO''' || 10 euros || 1 dia
|}

No exemplo acima, a transportadora SEUR só oferece a modalidade expresso: não é possível enviar por SEUR em modalidade normal.

A transportadora e a modalidade são escolhidas no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda seja enviada por uma transportadora ou modalidade diferente.

A escolha da transportadora e da modalidade afecta tanto o custo como a data prevista de entrega da encomenda. Uma compra só pode ser finalizada depois de escolhidas ambas, e o par transportadora/modalidade de um cabaz é sempre um par que a transportadora oferece.

Deve ser possível introduzir novas modalidades de transporte com impacto mínimo na implementação desenvolvida. As transportadoras e as suas tarifas, por seu lado, fazem parte do estado da aplicação: são registadas pelo utilizador e não implicam qualquer alteração ao código.

== Serviços Adicionais ==

O cliente pode seleccionar serviços adicionais, podendo aumentar o custo de cada encomenda, assim como o tempo necessário para a sua preparação e entrega. Os serviços são escolhidos no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda tenha os seus próprios serviços.

Os serviços iniciais são os seguintes:
{|
! style="background: #ebebeb;" | '''Serviço'''
! style="background: #ebebeb;" | '''Chave'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo adicional'''
|-
| Embrulho || '''EMBRULHO''' || 2 euros || 1 dia
|-
| Cartão de oferta || '''CARTAO_OFERTA''' || 1 euro || 0 dias
|}

Os serviços adicionais podem ser combinados: uma encomenda pode incluir simultaneamente embrulho, cartão de oferta ou outro serviço adicional. O custo e o tempo adicionais de uma encomenda correspondem à soma dos contributos da modalidade de transporte e de todos os serviços seleccionados.

Deve ser possível introduzir novos serviços adicionais sem alterar o código das encomendas ou dos serviços já existentes.

== Entregas ==

Cada encomenda tem uma data prevista de entrega.
A data prevista de entrega é determinada considerando:
* a data da compra;
* os prazos de entrega dos produtos que constituem a encomenda;
* o tempo de transporte da tarifa da transportadora seleccionada;
* o tempo adicional introduzido pelos serviços seleccionados.

Para uma encomenda com vários produtos, o prazo dos produtos considerados para determinar a data prevista de entrega corresponde ao maior prazo de entrega dos seus produtos.

Não é necessário manter explicitamente um estado para representar se uma encomenda está ou não entregue. A situação da encomenda pode ser determinada a partir da data actual e da sua data prevista de entrega. Assim, uma encomenda é considerada entregue quando a data actual atinge ou ultrapassa a sua data prevista de entrega.

== Gestão de Tempo ==

A unidade de tempo do sistema é o dia. A data do sistema começa no dia 1 (um) e faz parte do estado persistente.

A data do sistema pode ser avançada. Sempre que a data é alterada, devem ser verificadas as encomendas existentes para determinar:
* quais as encomendas que serão entregues no dia seguinte;
* quais as encomendas cuja data prevista de entrega foi atingida ou ultrapassada.

Quando a data actual atinge ou ultrapassa a data prevista de entrega de uma encomenda, esta considera-se entregue.

A gestão do tempo deve ainda desencadear [[#Notificações|notificações]].

== Pesquisas ==

Para permitir que os clientes determinem a existência de um produto, deverá ser possível efectuar pesquisas.

As pesquisas consideram os campos relevantes dos vários produtos, por exemplo, nome, categoria, tipo de produto ou país de origem.

O termo de pesquisa deve ser comparado sem distinção entre letras maiúsculas e minúsculas.

O sistema deve suportar diferentes critérios de pesquisa. Por exemplo, uma pesquisa pode procurar produtos cujo nome contenha determinado termo ou produtos pertencentes a determinada categoria.

Deve ser possível introduzir novos métodos de pesquisa de produtos com impacto mínimo na implementação desenvolvida.

== Alterações de Inventário ==

O inventário de um produto numa empresa pode ser alterado através da especificação de um valor a somar ou subtrair ao número de exemplares disponíveis. Se a quantidade indicada for um valor positivo, aumenta-se o número de exemplares disponíveis.
Se a quantidade indicada for um valor negativo, decrementa-se o número de exemplares disponíveis, desde que o número de exemplares disponíveis não fique negativo.

Um produto não é removido do sistema quando o seu inventário numa empresa chega a zero.
Quando o inventário de um produto numa empresa chega a zero, o produto deixa de estar disponível nessa empresa, mas continua a existir no sistema e pode continuar a ser disponibilizado por outras empresas.
Se o inventário de um produto numa empresa passar de zero para um valor positivo, o produto volta a estar disponível nessa empresa.

O número total de unidades disponíveis de um produto corresponde à soma dos inventários desse produto em todas as empresas que o disponibilizam.

Esta informação é utilizada, nomeadamente, no cálculo do preço recomendado dos produtos nacionais.

== Notificações ==

O sistema deve notificar os clientes relativamente às suas encomendas.

Devem ser enviadas notificações em duas situações:
* um dia antes da data prevista de entrega, informando o cliente de que a encomenda será entregue no dia seguinte;
* no dia da entrega, informando o cliente de que a encomenda foi entregue.

Cada notificação deve ser enviada através do mecanismo de notificação seleccionado pelo cliente.
Inicialmente, devem ser suportados, pelo menos, os seguintes mecanismos:
* correio electrónico ('''EMAIL''');
* WhatsApp ('''WHATSAPP''').

Cada cliente pode escolher o mecanismo através do qual pretende receber notificações do sistema. O mecanismo de notificação pode variar de cliente para cliente. Por exemplo, um cliente pode receber notificações por correio electrónico, enquanto outro pode recebê-las através de WhatsApp.
Deve ser possível introduzir novos mecanismos de notificação sem necessidade de alterar o código dos clientes ou do sistema responsável por gerar as notificações.

Deve ser possível introduzir novos mecanismos de notificação com impacto mínimo na implementação desenvolvida.

As notificações devem ser enviadas pela ordem em que os acontecimentos ocorrem no sistema.

= Requisitos de Desenho =

A aplicação a desenvolver deve seguir o princípio de desenho aberto-fechado, por forma a aumentar a extensibilidade do seu código. Por exemplo, deve ser possível adicionar novos tipos de produto com um impacto mínimo no código já existente da aplicação.

Devem ser possíveis extensões ou alterações de funcionalidade com impacto mínimo no código já produzido para a aplicação. O objectivo é aumentar a flexibilidade da aplicação relativamente ao suporte de novas funções. Assim, deve ser possível:
* Adicionar novos tipos de produto (e.g., produtos digitais ou perecíveis), incluindo a respectiva regra de cálculo do preço recomendado; * Adicionar novas categorias de produto;
* Introduzir novas estratégias de divisão de compras em encomendas;
* Introduzir novas modalidades de transporte (os custos e prazos de cada uma são dados de cada transportadora, não código; nem todas as transportadoras têm de oferecer todas as modalidades);
* Introduzir novos serviços adicionais, sem alterar o código das encomendas nem o dos serviços já existentes;
* Introduzir novos mecanismos de notificação, sem alterar o código dos clientes nem o do sistema que gera as notificações;
* Introduzir novos critérios de discriminação/classificação dos clientes;
* Introduzir novos critérios de pesquisa de produtos.

= Funcionalidade da aplicação =

A aplicação permite manter informação sobre as entidades do modelo, permitindo, em particular, gerir empresas, produtos, clientes e compras. Possui ainda a capacidade de preservar o seu estado (não é possível manter várias versões do estado da aplicação em simultâneo).

Nenhuma entidade é removida pelas operações descritas neste enunciado (em particular, um produto cujo inventário numa empresa chegue a zero continua a existir no sistema). Ainda assim, a aplicação deve estar preparada para que a remoção de qualquer entidade possa vir a ser suportada.

No [[#Leitura de Dados a Partir de Ficheiros Textuais|início]], a aplicação está vazia, mas pode ser carregada uma base de dados textual com conceitos pré-definidos. Neste caso, a aplicação começará com um estado referente às entidades que foram carregadas no arranque da aplicação.

{{Suggestion|Note-se que não é necessário implementar de raiz a aplicação: já existem classes que representam e definem a interface geral da funcionalidade do ''core'' da aplicação, tal como é visível pelos comandos da aplicação.}}
{{CVSCode|A interface geral do ''core'' já está parcialmente implementada na classe '''erp.ErpManager''' e outras fornecidas (cujos nomes devem ser mantidos), devendo ser adaptadas onde necessário. É ainda necessário criar e implementar as restantes classes que suportam a operação da aplicação.}}

== Serialização ==

É possível guardar e recuperar o estado actual da aplicação, preservando toda a informação relacionada com o ERP e que foi descrita [[#Conceitos e Relações do Modelo|acima]].

Após a recuperação do estado, os identificadores atribuídos a novas entidades devem continuar a ser atribuídos incrementalmente a partir do último valor utilizado em cada caso.

= Interacção com o utilizador =

Descreve-se nesta secção a '''funcionalidade máxima''' da interface com o utilizador. Em geral, os comandos pedem toda a informação antes de procederem à sua validação (excepto onde indicado). Todos os menus têm automaticamente a opção '''Sair''' (fecha o menu).

As operações de pedido e apresentação de informação ao utilizador '''devem''' realizar-se através dos objectos ''form'' e ''display'', respectivamente, presentes em cada comando. As mensagens são produzidas pelos métodos das [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|bibliotecas de suporte]] ('''po-uilib''' e '''erp-app'''). As mensagens não podem ser usadas no núcleo da aplicação ('''erp-core'''). Além disso, não podem ser definidas novas. Potenciais omissões devem ser esclarecidas antes de qualquer implementação.

De um modo geral, sempre que no contexto de uma operação com o utilizador aconteça alguma excepção, então a operação não deve ter qualquer efeito no estado da aplicação, excepto em caso de indicação contrária na operação em causa. As excepções estão na package '''erp.app.exceptions''', excepto em caso de indicação contrária.

As excepções usadas na interacção (subclasses de '''pt.tecnico.uilib.menus.CommandException'''), excepto em caso de indicação contrária, são lançadas pelos comandos (subclasses de '''pt.tecnico.uilib.menus.Command''') e tratadas pelos menus (instâncias de subclasses de '''pt.tecnico.uilib.menus.Menu'''). Outras excepções não devem substituir as fornecidas nos casos descritos.

Nos pedidos e usos dos vários identificadores, podem ocorrer as seguintes excepções, caso o identificador indicado não corresponda a um objecto conhecido (excepto no processo de registo ou em caso de indicação contrária). Note-se que estas excepções não são utilizáveis no núcleo da aplicação.

{|
! style="background: #ebebeb;" | '''Tipo de dados'''
! style="background: #ebebeb;" | '''Classe'''
! style="background: #ebebeb;" | '''Pedido a apresentar'''
! style="background: #ebebeb;" | '''Excepção a lançar se desconhecido'''
|-
| Empresa
| '''Company'''
| '''erp.app.company.Prompt.companyId()'''
| '''erp.app.exceptions.UnknownCompanyKeyException'''
|-
| Produto
| '''Product'''
| '''erp.app.product.Prompt.productId()'''
| '''erp.app.exceptions.UnknownProductKeyException'''
|-
| Cliente
| '''Client'''
| '''erp.app.client.Prompt.clientId()'''
| '''erp.app.exceptions.UnknownClientKeyException'''
|-
| Transportadora
| '''Carrier'''
| '''erp.app.carrier.Prompt.carrierId()'''
| '''erp.app.exceptions.UnknownCarrierKeyException'''
|-
| Compra
| '''Purchase'''
| '''erp.app.purchase.Prompt.purchaseId()'''
| '''erp.app.exceptions.UnknownPurchaseKeyException'''
|}

Existe ainda um caso particular: sempre que uma operação se refira a um produto '''no contexto de uma empresa''' e essa empresa não disponibilize esse produto, deve ser lançada a excepção '''erp.app.exceptions.ProductNotSuppliedException''' (a empresa e o produto existem, mas não estão relacionados).

Alguns casos particulares podem usar pedidos específicos não apresentados nesta tabela.

Vários comandos pedem ao utilizador que escolha um valor de um conjunto fechado (tipo de produto, categoria, estratégia de divisão, modalidade de transporte, serviço adicional, mecanismo de notificação e critério de pesquisa). Estas escolhas '''devem''' ser pedidas através de campos de opção ('''Form.addOptionField()''' ou '''Form.requestOption()'''), sendo o conjunto de opções obtido do núcleo através da fachada. Desta forma, a introdução de uma nova estratégia, modalidade, serviço, mecanismo ou critério não implica qualquer alteração aos comandos.

{{CVSCode|Note-se que o programa principal e os comandos e menus, a seguir descritos, já estão parcial ou completamente implementados nas ''packages'' '''erp.app''', '''erp.app.main''', '''erp.app.company''', '''erp.app.product''', '''erp.app.client''', '''erp.app.purchase'''. Estas classes são de uso obrigatório e estão disponíveis no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|GIT]] (módulo '''erp-app''').}}

== Formatos de Apresentação ==

Os formatos usados pelos vários comandos são os seguintes. Todos os campos são separados por '''␣-␣'''.

{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma transportadora|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma tarifa|
''idTransportadora'' - ''modalidade'' - ''custo adicional'' - ''tempo de transporte''
}}

{{CollapsedCode|Formato de apresentação de um produto|
''id'' - ''tipo'' - ''nome'' - ''categoria'' - ''preço base'' - ''preço recomendado'' - ''prazo base'' - ''unidades totais'' - ''informação adicional''
}}

O ''tipo'' é '''NACIONAL''' ou '''IMPORTADO'''. As ''unidades totais'' correspondem à soma dos inventários do produto em todas as empresas que o disponibilizam. Para produtos nacionais não existe informação adicional; para produtos importados, a informação adicional corresponde ao país de origem, à taxa alfandegária e ao prazo de transporte internacional.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 173
2 - IMPORTADO - Telemovel - ELECTRONICA - 200 - 260 - 3 - 2 - China - 30 - 5
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 0
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação da disponibilização de um produto por uma empresa|
''idEmpresa'' - ''idProduto'' - ''unidades'' - ''factor'' - ''preço de venda''
}}

{{CollapsedCode|Exemplos de apresentação de disponibilizações|
<syntaxhighlight lang="text">
2 - 1 - 150 - 0.9 - 14
2 - 2 - 2 - 1.2 - 312
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''mecanismo de notificação'' - ''gasto total''
}}

O valor apresentado no fim corresponde ao total gasto pelo cliente em compras (um valor inteiro).

{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Ahsoka Tano - ahsoka@jedi.org - WHATSAPP - 0
1 - Obi-Wan Kenobi - obiwan@jedi.org - EMAIL - 124
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de uma compra|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
}}

{{CollapsedCode|Formato de apresentação (resumida) de uma encomenda|
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo'' - ''lista de identificadores de produtos''
}}

A ''descrição do transporte'' é o nome da transportadora e a modalidade seleccionadas, separados por '''/''', seguidos das chaves dos serviços adicionais seleccionados, separadas por '''+''' (por exemplo, '''DHL/ EXPRESSO+EMBRULHO+CARTAO_OFERTA'''). O ''custo'' de uma encomenda é o custo base de processamento acrescido do custo da modalidade e dos serviços.

{{CollapsedCode|Exemplos de apresentação de encomendas|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

== Menu Principal ==

As acções deste menu permitem gerir a salvaguarda do estado da aplicação e abrir submenus. A lista completa é a seguinte: [[#Salvaguarda do estado actual da aplicação|Abrir]], [[#Salvaguarda do estado actual da aplicação|Guardar]], [[#Mostrar data actual|Mostrar data actual]], [[#Avançar data actual|Avançar data actual]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Empresas]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Produtos]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Clientes]] e [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Compras]]. Inicialmente, a aplicação apenas tem informação sobre as entidades que foram carregadas no arranque.

{{CVSCode|As etiquetas das opções deste menu estão definidas na classe '''erp.app.main.Label'''. Todos os métodos correspondentes às mensagens de diálogo para este menu estão definidos na classe '''erp.app.main.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.main''', respectivamente: '''DoOpenFile''', '''DoSaveFile''', '''DoDisplayDate''', '''DoAdvanceDate''', '''DoOpenMenuCompanies''', '''DoOpenMenuProducts''', '''DoOpenMenuClients''', '''DoOpenMenuPurchases'''.}}

=== Salvaguarda do estado actual da aplicação ===

O conteúdo da aplicação (toda a informação detida pelo ERP actualmente em memória) pode ser guardado para posterior recuperação (via serialização Java: '''java.io.Serializable'''). Na leitura e escrita do estado da aplicação, devem ser tratadas as excepções associadas. A funcionalidade é a seguinte:

* '''Abrir''' -- Carrega os dados de uma sessão anterior a partir de um ficheiro previamente guardado (ficando este ficheiro associado à aplicação, para futuras operações de salvaguarda). Pede-se o nome do ficheiro a abrir ('''Prompt.openFile()'''). Caso ocorra um problema na abertura ou processamento do ficheiro, deve ser lançada a excepção '''FileOpenFailedException'''. A execução bem-sucedida desta opção substitui toda a informação da aplicação. Quando se abandona uma aplicação com modificações não guardadas (porque se abre outra e existem alterações não guardadas), deve perguntar-se ao utilizador se quer guardar a informação actual antes de a abandonar, através de '''Prompt.saveBeforeExit()''' (a resposta é obtida via '''Form.confirm()''').

* '''Guardar''' -- Guarda o estado actual da aplicação no ficheiro associado. Se não existir associação, pede-se o nome do ficheiro a utilizar, ficando a ele associado (para operações de salvaguarda subsequentes). Esta interacção realiza-se através do método '''Prompt.newSaveAs()'''. Não é executada nenhuma acção se não existirem alterações desde a última salvaguarda.

{{Suggestion|Note-se que a opção '''Abrir''' não permite a leitura de ficheiros de texto (estes apenas podem ser utilizados no início da aplicação).}}
{{Suggestion|A opção '''Sair''' nunca implica a salvaguarda do estado da aplicação, mesmo que existam alterações.}}

=== Mostrar data actual ===

A data actual do sistema é apresentada através da mensagem '''Message.currentDate()'''.

=== Avançar data actual ===

O número de dias a avançar é pedido através de '''Prompt.daysToAdvance()'''. O valor indicado deve ser positivo. Caso contrário, a operação não tem efeito.

Além da data, o sistema deve actualizar, caso seja necessário, outros aspectos que dela dependam, designadamente, a situação das entregas relativa às suas datas de chegada.

=== Gestão e consulta de dados da aplicação ===

* '''Menu de Gestão de Empresas''' -- Abre o menu de gestão de empresas e operações associadas.
* '''Menu de Gestão de Produtos''' -- Abre o menu de gestão de produtos e operações associadas.
* '''Menu de Gestão de Clientes''' -- Abre o menu de gestão de clientes e operações associadas.
* '''Menu de Gestão de Compras''' -- Abre o menu de gestão de compras e operações associadas.

== Menu de Gestão de Empresas ==

Este menu permite efectuar operações sobre a base de dados de empresas. A lista completa é a seguinte: [[#Registar empresa|Registar empresa]], [[#Mostrar empresa|Mostrar empresa]], [[#Mostrar empresas|Mostrar empresas]], [[#Mostrar produtos de uma empresa|Mostrar produtos de uma empresa]], [[#Mostrar clientes de uma empresa|Mostrar clientes de uma empresa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.company.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.company.Prompt''' e '''erp.app.company.Message'''.}}

=== Registar empresa ===

Pede o nome ('''Prompt.companyName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CompanyRegistrationFailedException'''.

Note-se que a atribuição do identificador da empresa é automática.

=== Mostrar empresa ===

É pedido o identificador da empresa, sendo apresentadas as informações sobre essa empresa, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

=== Mostrar empresas ===

Apresenta informações sobre todas as empresas, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar empresa|Mostrar empresa]].

=== Mostrar produtos de uma empresa ===

É pedido o identificador da empresa e apresentam-se os produtos que essa empresa vende, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar produto|Mostrar produto]].

=== Mostrar clientes de uma empresa ===

É pedido o identificador da empresa e apresentam-se os clientes que já interagiram com essa empresa, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar cliente|Mostrar cliente]].

== Menu de Gestão de Produtos ==

Este menu apresenta as operações disponíveis sobre produtos. A lista completa é a seguinte: [[#Mostrar produto|Mostrar produto]], [[#Mostrar produtos|Mostrar produtos]], [[#Alterar inventário de um produto|Alterar inventário de um produto]] e [[#Efectuar pesquisa|Efectuar pesquisa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.product.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.product.Prompt''' e '''erp.app.product.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.product''' (disponível no GIT), respectivamente: '''DoShowProduct''', '''DoShowProducts''', '''DoChangeProductInventory''', '''DoPerformSearch'''.}}

=== Mostrar produto ===

É pedido o identificador do produto. Se o produto existir, é apresentado de acordo com o seguinte formato. O formato genérico de apresentação de um produto é como se segue:
{{CollapsedCode|Formato de apresentação de produtos|
''id'' - ''stock'' - ''tipo'' - ''nome'' - ''preço'' - ''categoria'' - ''informação adicional''
}}

Para produtos fabricados, a informação adicional corresponde ao nome do fabricante e ao código de fabrico (separados pelo carácter ''';'''); para produtos importados, a informação adicional corresponde ao país de origem e à taxa alfandegária.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
3 - 20 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
4 - 2 - IMPORTADO - Telemóvel - 200 - ELECTRONICA - China - 30
5 - 0 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

=== Mostrar produtos ===

Apresenta informações sobre todos os produtos, ordenando-os pelos seus identificadores. O formato de apresentação é como descrito em [[#Mostrar produto|Mostrar produto]].

=== Alterar inventário de um produto ===

É pedido o identificador de um produto e uma quantidade ('''Prompt.amountToUpdate()''') e actualizado o número de exemplares disponíveis do produto indicado somando a quantidade indicada ao número de exemplares disponíveis. No caso de não ser possível actualizar o número de exemplares devido ao facto de a quantidade indicada ser inválida, então a operação não deve ter qualquer efeito e deve ser apresentada a mensagem '''Message.notEnoughInventory()'''.

=== Efectuar pesquisa ===

Esta opção realiza uma procura por termo (cadeia de caracteres), pedido através de '''Prompt.searchTerm()'''. Como resultado, deve ser apresentada uma lista dos produtos encontrados pela pesquisa, ordenados por ordem crescente do seu identificador, utilizando o formato descrito para [[#Mostrar produto|Mostrar produto]].

O termo de pesquisa deve ser comparado (sem distinção entre letras maiúsculas e minúsculas) com os campos relevantes de cada produto: o nome e a categoria. Só devem ser apresentados produtos que contenham o termo de pesquisa num dos campos relevantes. Caso não sejam encontrados produtos, não deve ser produzido qualquer resultado.

== Menu de Gestão de Clientes ==

Este menu permite efectuar operações sobre a base de dados de clientes. A lista completa é a seguinte: [[#Registar cliente|Registar cliente]], [[#Mostrar cliente|Mostrar cliente]], [[#Mostrar clientes|Mostrar clientes]], [[#Mostrar notificações do cliente|Mostrar notificações do cliente]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.client.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.client.Prompt''' e '''erp.app.client.Message'''.}}

=== Registar cliente ===

Pede o nome ('''Prompt.clientName()''') e o endereço de correio electrónico ('''Prompt.clientEMail()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''ClientRegistrationFailedException'''.

Note-se que a atribuição do identificador do cliente é automática e que clientes diferentes são registados em cada operação de registo.

=== Mostrar cliente ===

É pedido o identificador do cliente, sendo apresentadas as informações sobre esse cliente, de acordo com o seguinte formato. O valor apresentado após o email corresponde ao total gasto pelo cliente em compras (um valor inteiro).
{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''gasto total''
}}
{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Alberto Meireles - ameireles@mymail.com - 275
1 - Fernando Meireles - fmeireles@mymail.com - 0
</syntaxhighlight>
}}

=== Mostrar clientes ===

Apresenta informações sobre todos os clientes, ordenando-os lexicograficamente pelo nome. Caso existam clientes com o mesmo nome, devem ser ordenados por ordem crescente dos seus identificadores. O formato é o descrito em [[#Mostrar cliente|Mostrar cliente]].

=== Mostrar notificações do cliente ===

É pedido o identificador do cliente, sendo apresentadas as notificações para esse cliente, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação das notificações de um cliente|
DISPONIBILIDADE: ''descrição de produto disponível''
}}
{{CollapsedCode|Exemplos de notificações|
<syntaxhighlight lang="text">
DISPONIBILIDADE: 5 - 4 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

Note-se que a descrição é idêntica à que é realizada para mostrar cada produto. No entanto, a solução deve ser suficientemente flexível para permitir outros formatos de apresentação das notificações (sem impacto no código do domínio da aplicação).

== Menu de Gestão de Compras ==

Este menu apresenta as operações relacionadas com compras e encomendas. A lista completa é a seguinte: [[#Efectuar compra|Efectuar compra]], [[#Mostrar compra|Mostrar compra]], [[#Mostrar compras|Mostrar compras]], [[#Mostrar encomendas de uma compra|Mostrar encomendas de uma compra]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp. app.purchase.Label'''. Os métodos correspondentes aos pedidos deste menu estão definidos em '''erp.app.purchase.Prompt'''. As mensagens do processo de compra pertencem ao [[#Menu de Cabaz|menu de cabaz]] ('''erp.app.basket.Message''').}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.purchase''' (disponível no GIT), respectivamente: '''DoDoPurchase''', '''DoShowPurchase''', '''DoShowPurchases''', '''DoShowPurchaseOrders'''.}}

=== Efectuar compra ===

Esta opção não efectua, por si só, qualquer compra: abre o [[#Menu de Cabaz|menu de cabaz]] sobre o cabaz de um cliente numa empresa.

São pedidos o identificador do cliente e o identificador da empresa. Se ambos existirem, é aberto o [[#Menu de Cabaz|Menu de Cabaz]] sobre o cabaz desse cliente nessa empresa (criado vazio, se ainda não existir).

Como o cabaz pertence ao cliente, sair do menu sem finalizar a compra preserva o seu conteúdo e as suas opções para uma visita posterior.

=== Mostrar compra ===

É pedido o identificador da compra. Na primeira linha apresenta-se a informação da compra; de seguida, apresentam-se as suas encomendas '''em detalhe''' — o cabeçalho de cada encomenda (sem a lista de identificadores de produtos) seguido da descrição completa de cada um dos seus produtos, indentada com dois espaços. As encomendas são apresentadas por ordem crescente da data prevista de entrega e, em caso de empate, pelos identificadores dos produtos.

{{CollapsedCode|Formato de apresentação de uma compra (com encomendas em detalhe)| ''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo''
␣␣''descrição de produto'' ␣␣... }}

{{CollapsedCode|Exemplo de apresentação de uma compra|
<syntaxhighlight lang="text">
1 - 1 - 1 - 1 - 94 - 30 - 124
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 171
</syntaxhighlight>
}}

=== Mostrar compras ===

Apresenta informações sobre todas as compras, ordenando-as pelos seus identificadores, no [[#Formatos de Apresentação|formato de apresentação de uma compra]] (apenas a linha da compra, sem as encomendas).

=== Mostrar encomendas de uma compra ===

É pedido o identificador da compra e são apresentadas as encomendas correspondentes, ordenadas pela data prevista de entrega e, em caso de empate, pelos identificadores dos produtos. Ao contrário de [[#Mostrar compra|Mostrar compra]] (que apresenta as encomendas em detalhe), aqui cada encomenda é apresentada '''de forma resumida''' (uma linha, terminada pela lista de identificadores dos seus produtos), no [[#Formatos de Apresentação|formato de apresentação resumida de uma encomenda]].

{{CollapsedCode|Exemplo de apresentação de encomendas (compra do exemplo anterior)|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

= Leitura de Dados a Partir de Ficheiros Textuais =

Além das opções de manipulação de ficheiros descritas no [[#Menu Principal|menu principal]], é possível iniciar a aplicação com um ficheiro de texto especificado pela propriedade Java '''[[#Execução do Programa e Testes Automáticos|import]]'''.

Cada linha tem uma descrição distinta mas que segue o seguinte formato geral. É possível registar transportadoras, empresas, clientes e produtos, e definir as tarifas das transportadoras e as disponibilizações de produtos por parte das empresas. Assume-se que os campos de texto não podem conter o carácter ''':''' e que os preços são números inteiros. Não existem entradas mal-formadas.

O registo de transportadoras, e das tarifas que cada uma pratica, segue os formatos:
CARRIER:''nome''
RATE:''idTransportadora'':''modalidade'':''custo'':''dias''

As entradas '''RATE''' referem transportadoras já registadas em linhas anteriores. O registo de empresas e de clientes segue os formatos:
COMPANY:''nome''
CLIENT:''nome'':''email''
CLIENT:''nome'':''email'':''mecanismo''

O ''mecanismo'' é '''EMAIL''' ou '''WHATSAPP'''; se for omitido, assume-se '''EMAIL'''. Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:

Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:
NATIONAL:''nome'':''preçoBase'':''categoria'':''prazo''
IMPORTED:''nome'':''preçoBase'':''categoria'':''prazo'':''paisOrigem'':''taxa'':''prazoInternacional''

Note-se que o registo de um produto não indica qualquer empresa nem qualquer inventário: essas são propriedades da disponibilização, descrita por entradas próprias, em que ''unidades'' é o número de exemplares que a empresa tem disponíveis e ''factor'' o multiplicador (real) que aplica ao preço recomendado:
SUPPLY:''idEmpresa'':''idProduto'':''unidades'':''factor''

As entradas '''SUPPLY''' referem empresas e produtos já registados em linhas anteriores.

Um exemplo de conteúdo do ficheiro inicial é como se segue:
{{CollapsedCode|Exemplo de ficheiro de entrada textual|
<syntaxhighlight lang="text">
CARRIER:CTT
RATE:1:NORMAL:3:3
RATE:1:EXPRESSO:8:1
CARRIER:DHL
RATE:2:NORMAL:5:2
RATE:2:EXPRESSO:12:1
CARRIER:SEUR
RATE:3:EXPRESSO:10:1
COMPANY:Moageira Nacional
COMPANY:Importadora Atlantico
CLIENT:Obi-Wan Kenobi:obiwan@jedi.org
CLIENT:Ahsoka Tano:ahsoka@jedi.org:WHATSAPP
NATIONAL:Farinha:15:ALIMENTAR:3
IMPORTED:Telemovel:200:ELECTRONICA:3:China:30:5
NATIONAL:Camisa:45:VESTUARIO:2
SUPPLY:1:1:23:1.0
SUPPLY:2:1:150:0.9
SUPPLY:2:2:2:1.2
SUPPLY:1:3:4:1.1
</syntaxhighlight>
}}

A codificação dos ficheiros a ler é garantidamente [[wp:UTF-8|UTF-8]].

{{Suggestion|Os métodos '''String.split()''', para partir cadeias de caracteres, e '''String.trim()''', para remover espaços no início e no final, podem ser usados no processamento de cada linha.}}
{{Suggestion|Note-se que o programa nunca produz ficheiros com este formato (é apenas um formato para ficheiros de entrada).}}

= Execução do Programa e Testes Automáticos =

Usando os ficheiros '''test.import''', '''test.in''' e '''test.out''', é possível verificar automaticamente o resultado correcto do programa. Note-se que é necessária a definição apropriada da variável '''CLASSPATH''' (ou da opção equivalente '''-cp''' do comando '''java'''), para localizar as classes do programa, incluindo a que contém o método correspondente ao ponto de entrada da aplicação ('''erp.app.App.main'''). As propriedades são tratadas automaticamente pelo código de apoio.

java -Dimport=test.import -Din=test.in -Dout=test.outhyp erp.app.App

Assumindo que aqueles ficheiros estão no directório onde é dado o comando de execução, o programa produz o ficheiro de saída '''test.outhyp'''. Em caso de sucesso, os ficheiros das saídas esperada ('''test.out''') e obtida ('''test.outhyp''') devem ser iguais. A comparação pode ser feita com o comando:
diff -b test.out test.outhyp

Este comando não deve produzir qualquer resultado quando os ficheiros são iguais. Note-se, contudo, que este teste não garante o correcto funcionamento do código desenvolvido, apenas verificando alguns aspectos da sua funcionalidade.

= Notas de Implementação =

Tal como indicado acima, algumas classes fornecidas como [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|material de apoio]], são de uso obrigatório e não podem ser alteradas. Outras dessas classes são de uso obrigatório e têm de ser alteradas.

A serialização Java usa as classes da ''package'' [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/package-summary.html java.io], em particular, a interface [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/Serializable.html java.io. Serializable] e as classes de leitura [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/ObjectInputStream.html java.io.ObjectInputStream] e escrita [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/ObjectOutputStream.html java.io.ObjectOutputStream] (entre outras).

[[category: Ensino]]
[[category:PO]]
[[category: Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T13:14:19Z

Root: /* Notas de Implementação */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

'''EM PREPARAÇÃO'''

'''ÉPOCA NORMAL'''

O objectivo do projecto é desenvolver um sistema de gestão de entregas rápidas de produtos (ERP — Express Retail Platform). O sistema deverá permitir, entre outras operações, (i) registar dados de empresas; (ii) registar dados de clientes; (iii) registar, gerir e pesquisar produtos; (iv) efectuar e gerir características de compras; (v) gerir as entregas correspondentes; e (vi) notificar os clientes sobre a situação das suas encomendas.

Neste texto, o tipo '''negrito''' indica um literal (i.e., é exactamente como apresentado); o símbolo ␣ indica um espaço; e o tipo ''itálico'' indica uma parte variável (i.e., uma descrição).

= Conceitos e Relações do Modelo =

Existem vários conceitos importantes neste contexto: [[#Empresas|empresas]], [[#Produtos|produtos]], [[#Clientes|clientes]], [[#Transportadoras|transportadoras]], [[#Cabaz de Compras|cabazes]], [[#Compras|compras]], [[#Divisão das Compras em Encomendas|encomendas]] e [[#Entregas|entregas]].

Os conceitos listados não são os únicos possíveis no modelo e as suas relações (assim como relações com outros conceitos não mencionados) podem depender das escolhas do projecto.

Os clientes e os produtos são independentes das empresas: existem por si e podem relacionar-se com várias empresas. Cada empresa, no entanto, mantém registo dos clientes com quem interage, dos produtos que disponibiliza, das compras feitas e das encomendas que expede.

Uma compra representa a aquisição de produtos por um cliente a uma empresa, e resulta de finalizar um [[#Cabaz de Compras|cabaz]]. Uma compra pode dar origem a uma ou mais encomendas, de acordo com a estratégia de divisão de encomendas utilizada.

Cada encomenda pode ser enviada através de uma determinada transportadora e pode incluir serviços adicionais que alteram o seu custo e/ou prazo de entrega.

== Produtos ==

O sistema mantém um registo global de produtos. Cada produto é identificado por um número de produto. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Todos os produtos têm: um nome/descrição (cadeia de caracteres não vazia); um preço base (número inteiro positivo); uma categoria; e um prazo de entrega base (número inteiro de dias).

O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O sistema utiliza o preço base para calcular o preço recomendado do produto. O preço recomendado representa o valor de referência do produto no sistema. O seu cálculo pode depender do tipo de produto e de outras informações disponíveis no sistema.

Cada produto tem uma categoria, de acordo com a sua natureza. Inicialmente, consideram-se as seguintes categorias: (i) alimentar; (ii) electrónica; e (iii) vestuário. Deve ser possível adicionar novas categorias com impacto mínimo na aplicação já desenvolvida.

O produto existe independentemente das empresas que o disponibilizam. Assim, o mesmo produto pode ser disponibilizado por várias empresas, sendo possível que cada uma pratique um preço de venda diferente.

A informação relativa à disponibilização de um produto por uma empresa não deve ser considerada parte das características intrínsecas do produto.

== Tipos de Produto ==

Todos os produtos considerados no sistema são fabricados, mas podem ter diferentes origens.

Inicialmente, consideram-se os seguintes tipos de produto:
* produto nacional;
* produto importado.

Um produto nacional possui apenas as propriedades gerais dos produtos.

Um produto importado possui, para além das propriedades gerais dos produtos:
* um país de origem (cadeia de caracteres não vazia);
* uma taxa alfandegária (número inteiro expressando uma percentagem);
* um prazo de transporte internacional (número inteiro de dias).

O preço recomendado é calculado de forma diferente consoante o tipo de produto.

Deve ser possível introduzir novos tipos de produto com impacto mínimo na implementação desenvolvida.

=== Produtos Nacionais ===

Para um produto nacional, o preço recomendado depende do preço base e do número total de unidades actualmente disponíveis desse produto nas empresas que o disponibilizam.

Se o número total de unidades disponíveis for:
* superior a 10000, o preço recomendado corresponde a 90% do preço base;
* inferior a 100, o preço recomendado corresponde a 130% do preço base;
* nos restantes casos, o preço recomendado corresponde ao preço base.

Por exemplo, considerando um produto nacional com preço base de 100 euros:
* Unidades disponíveis = 50 => Preço recomendado = 130 euros;
* Unidades disponíveis = 5000 => Preço recomendado = 100 euros;
* Unidades disponíveis = 12000 => Preço recomendado = 90 euros.

=== Produtos Importados ===

Para um produto importado, o preço recomendado corresponde ao preço base acrescido da taxa alfandegária.

Se a taxa alfandegária for '''t%''', o preço recomendado é calculado de acordo com:

'''preço base × (100 + t) / 100'''

Por exemplo, considerando um produto importado com preço base de 100 euros e uma taxa alfandegária de 20%, o preço recomendado será:

'''100 × (100 + 20) / 100 = 120 euros'''

O cálculo do preço recomendado deve ser realizado de forma polimórfica, de modo a que o código que utiliza produtos não tenha de conhecer explicitamente o tipo concreto de cada produto.

== Empresas ==

O sistema mantém um registo das empresas que operam na plataforma. Cada empresa é identificada por um número de empresa. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada empresa tem ainda um nome (cadeia de caracteres não vazia).

Uma empresa pode disponibilizar vários produtos e cada produto pode ser disponibilizado por várias empresas.

Para cada produto que disponibiliza, a empresa deve manter informação sobre:
* número de unidades disponíveis (valor inteiro);
* factor multiplicativo do preço recomendado (número positivo).

O número de unidades disponíveis e o factor multiplicativo podem ser diferentes para cada empresa que disponibiliza o mesmo produto.

O factor multiplicativo permite que uma empresa pratique um preço de venda diferente do preço recomendado pelo sistema. O preço de venda de um produto pela empresa é calculado multiplicando o preço recomendado do produto pelo factor multiplicativo definido pela empresa. Assim, duas empresas podem disponibilizar o mesmo produto a preços diferentes e com quantidades diferentes em stock.

Por exemplo, o produto P1, com um preço recomendado de 100 euros, pode ser disponibilizado pela empresa A com um preço de 90 euros, através de um factor multiplicativo de 0,9. A empresa B pode disponibilizar o mesmo produto com um preço de 120 euros, através de um factor multiplicativo de 1,2.

Deve ser possível adicionar outras propriedades às empresas sem impacto significativo no código já desenvolvido.

== Clientes ==

O sistema mantém um registo de clientes. Cada cliente é identificado por um número de cliente. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada cliente tem ainda informação sobre o seu nome e endereço de correio electrónico. Estes campos não podem ser vazios.

Assume-se que os clientes têm sempre dinheiro, i.e., uma compra nunca é recusada por falta de fundos.

== Compras ==

O sistema regista as compras efectuadas pelos clientes. Cada compra é identificada por um número de compra, atribuído automaticamente e incrementalmente. Uma compra é sempre feita por um único cliente a uma única empresa numa determinada data.

Uma compra é constituída por um conjunto de linhas (um "cabaz"). Cada linha corresponde a:
* um produto;
* uma quantidade (número de exemplares adquiridos desse produto);
* um preço unitário (o preço de venda do produto pela empresa no momento da compra);
* um preço total da linha (quantidade × preço unitário).

O preço unitário utilizado numa compra deve ser guardado na própria linha da compra. Alterações posteriores ao preço base, ao preço recomendado, ao factor multiplicativo da empresa, ou a qualquer outra propriedade utilizada no cálculo do preço, não devem alterar o valor de compras já efectuadas.

O preço total dos itens de uma compra é a soma dos preços totais das suas linhas. Uma compra pode dar origem a uma ou mais encomendas, de acordo com uma estratégia de divisão de encomendas.

A divisão de uma compra em várias encomendas pode ter impacto no custo total da compra.

== Cabaz de Compras ==

Antes de dar origem a uma compra, os produtos que um cliente pretende adquirir a uma empresa são acumulados num '''cabaz'''.

Cada cliente tem um cabaz por cada empresa em que compra. O cabaz é constituído por um conjunto de linhas; cada linha corresponde a um produto disponibilizado por essa empresa e a uma quantidade. Acrescentar ao cabaz um produto que já lá esteja acumula as quantidades.

O cabaz regista ainda as opções que serão aplicadas à compra:
* a [[#Divisão das Compras em Encomendas|estratégia de divisão em encomendas]]; * a [[#Transportadoras|transportadora]] e a [[#Transportadoras|modalidade de transporte]]; e
* o conjunto de [[#Serviços Adicionais|serviços adicionais]].

A transportadora, a modalidade e os serviços adicionais escolhidos aplicam-se a '''todas''' as encomendas resultantes da compra.

Enquanto não for finalizado, o cabaz não tem qualquer efeito no resto do sistema: em particular, não reserva nem consome inventário, e os preços apresentados são sempre os preços de venda praticados pela empresa '''nesse momento'''. Um cabaz faz parte do estado persistente da aplicação: pode ser abandonado e retomado mais tarde.

Ao '''finalizar''' o cabaz, e apenas nesse momento:
* os preços de venda são fixados nas linhas da compra;
* a compra é dividida em encomendas de acordo com a estratégia registada no cabaz;
* todas as encomendas recebem a modalidade de transporte e os serviços adicionais registados no cabaz;
* o inventário dos produtos na empresa é decrementado e o cliente é debitado;
* o cabaz fica vazio.

Um cabaz vazio não pode ser finalizado, nem o pode ser um cabaz em que ainda não tenham sido escolhidas transportadora e modalidade. Se, no momento de finalizar, a empresa já não tiver exemplares suficientes de algum dos produtos do cabaz (por exemplo, porque o inventário foi entretanto alterado), a operação falha sem qualquer efeito e o cabaz mantém-se intacto.

== Divisão das Compras em Encomendas ==

Cada encomenda tem um custo base de processamento e expedição, de '''5 euros'''. Assim, uma compra dividida em várias encomendas pode ter um custo superior ao de uma compra enviada numa única encomenda.

O custo base associado às encomendas corresponde ao número de encomendas multiplicado pelo custo base de uma encomenda.

A este custo podem acrescer os custos associados ao método de transporte seleccionado e aos serviços adicionais.

O custo total de uma compra corresponde, assim, ao custo dos produtos acrescido:
* do custo base das encomendas;
* dos custos adicionais das tarifas de transporte;
* dos custos dos serviços adicionais seleccionados.

A forma como uma compra é dividida em encomendas é determinada por uma estratégia de divisão de encomendas. Inicialmente, devem ser suportadas, pelo menos, as seguintes estratégias: encomenda única ('''UNICA''') e agrupamento por prazo de entrega ('''PRAZO''').

=== Encomenda única ===

Todos os produtos da compra são colocados numa única encomenda.

Neste caso, a compra origina uma única encomenda, independentemente dos prazos de entrega dos produtos.

=== Agrupamento por prazo de entrega ===

Os produtos são agrupados de acordo com os seus prazos de entrega.

Calcula-se a média dos prazos de entrega dos produtos das linhas da compra:
* todas as linhas cujo produto tem prazo menor ou igual à média são agrupadas numa única encomenda;
* cada linha cujo produto tem prazo estritamente maior do que a média é enviada separadamente, numa encomenda própria.

Por exemplo, considere-se uma compra com três linhas cujos produtos têm os prazos de entrega 3 (P1), 8 (P2) e 2 (P3). A média dos prazos é (3 + 8 + 2) / 3 ≈ 4,33. Logo, P1 e P3 (prazos ≤ 4,33) seguem juntos numa entrega e P2 (prazo > 4,33) segue numa outra encomenda:
* Encomenda A: {P1, P3} (prazo = 3)
* Encomenda B: {P2} (prazo = 8)

Uma estratégia de divisão que origina várias encomendas pode permitir que alguns produtos sejam entregues mais cedo, mas pode também resultar num custo superior devido ao custo associado a cada encomenda.

Deve ser possível introduzir novas estratégias de divisão de compras em encomendas com impacto mínimo na implementação desenvolvida.

== Transportadoras ==

O sistema mantém um registo das '''transportadoras''' que operam na plataforma. Cada transportadora é identificada por um número de transportadora. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada transportadora tem ainda um nome (cadeia de caracteres não vazia).

Cada encomenda é enviada através de uma transportadora, segundo uma '''modalidade de transporte'''. Inicialmente, devem ser suportadas, pelo menos, as seguintes modalidades: normal ('''NORMAL''') e expresso ('''EXPRESSO''').

Uma modalidade '''não''' define, por si só, qualquer custo ou prazo: é apenas o nome de um nível de serviço. Para cada modalidade que oferece, uma transportadora define uma '''tarifa''', constituída por:
* um custo adicional (número inteiro); e
* um tempo de transporte (número inteiro de dias).

Assim, a mesma modalidade pode custar e demorar valores diferentes consoante a transportadora.

Uma transportadora '''não tem de oferecer todas as modalidades''': oferece exactamente aquelas para as quais tenha uma tarifa definida. Pedir a uma transportadora uma modalidade que ela não oferece é um erro, e não uma escolha silenciosamente ignorada — ver [[#Definir modalidade de transporte|Definir modalidade de transporte]].

Entre os dois, '''a transportadora tem precedência sobre a modalidade''': como as modalidades disponíveis são as da transportadora, só se pode escolher uma modalidade depois de escolhida a transportadora, e mudar de transportadora anula a modalidade anteriormente escolhida (que passa a ser escolhida de novo, de entre as que a nova transportadora oferece).

Por exemplo:
{|
! style="background: #ebebeb;" | '''Transportadora'''
! style="background: #ebebeb;" | '''Modalidade'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo de transporte'''
|-
| CTT || '''NORMAL''' || 3 euros || 3 dias
|-
| CTT || '''EXPRESSO''' || 8 euros || 1 dia
|-
| DHL || '''NORMAL''' || 5 euros || 2 dias
|-
| DHL || '''EXPRESSO''' || 12 euros || 1 dia
|-
| SEUR || '''EXPRESSO''' || 10 euros || 1 dia
|}

No exemplo acima, a transportadora SEUR só oferece a modalidade expresso: não é possível enviar por SEUR em modalidade normal.

A transportadora e a modalidade são escolhidas no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda seja enviada por uma transportadora ou modalidade diferente.

A escolha da transportadora e da modalidade afecta tanto o custo como a data prevista de entrega da encomenda. Uma compra só pode ser finalizada depois de escolhidas ambas, e o par transportadora/modalidade de um cabaz é sempre um par que a transportadora oferece.

Deve ser possível introduzir novas modalidades de transporte com impacto mínimo na implementação desenvolvida. As transportadoras e as suas tarifas, por seu lado, fazem parte do estado da aplicação: são registadas pelo utilizador e não implicam qualquer alteração ao código.

== Serviços Adicionais ==

O cliente pode seleccionar serviços adicionais, podendo aumentar o custo de cada encomenda, assim como o tempo necessário para a sua preparação e entrega. Os serviços são escolhidos no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda tenha os seus próprios serviços.

Os serviços iniciais são os seguintes:
{|
! style="background: #ebebeb;" | '''Serviço'''
! style="background: #ebebeb;" | '''Chave'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo adicional'''
|-
| Embrulho || '''EMBRULHO''' || 2 euros || 1 dia
|-
| Cartão de oferta || '''CARTAO_OFERTA''' || 1 euro || 0 dias
|}

Os serviços adicionais podem ser combinados: uma encomenda pode incluir simultaneamente embrulho, cartão de oferta ou outro serviço adicional. O custo e o tempo adicionais de uma encomenda correspondem à soma dos contributos da modalidade de transporte e de todos os serviços seleccionados.

Deve ser possível introduzir novos serviços adicionais sem alterar o código das encomendas ou dos serviços já existentes.

== Entregas ==

Cada encomenda tem uma data prevista de entrega.
A data prevista de entrega é determinada considerando:
* a data da compra;
* os prazos de entrega dos produtos que constituem a encomenda;
* o tempo de transporte da tarifa da transportadora seleccionada;
* o tempo adicional introduzido pelos serviços seleccionados.

Para uma encomenda com vários produtos, o prazo dos produtos considerados para determinar a data prevista de entrega corresponde ao maior prazo de entrega dos seus produtos.

Não é necessário manter explicitamente um estado para representar se uma encomenda está ou não entregue. A situação da encomenda pode ser determinada a partir da data actual e da sua data prevista de entrega. Assim, uma encomenda é considerada entregue quando a data actual atinge ou ultrapassa a sua data prevista de entrega.

== Gestão de Tempo ==

A unidade de tempo do sistema é o dia. A data do sistema começa no dia 1 (um) e faz parte do estado persistente.

A data do sistema pode ser avançada. Sempre que a data é alterada, devem ser verificadas as encomendas existentes para determinar:
* quais as encomendas que serão entregues no dia seguinte;
* quais as encomendas cuja data prevista de entrega foi atingida ou ultrapassada.

Quando a data actual atinge ou ultrapassa a data prevista de entrega de uma encomenda, esta considera-se entregue.

A gestão do tempo deve ainda desencadear [[#Notificações|notificações]].

== Pesquisas ==

Para permitir que os clientes determinem a existência de um produto, deverá ser possível efectuar pesquisas.

As pesquisas consideram os campos relevantes dos vários produtos, por exemplo, nome, categoria, tipo de produto ou país de origem.

O termo de pesquisa deve ser comparado sem distinção entre letras maiúsculas e minúsculas.

O sistema deve suportar diferentes critérios de pesquisa. Por exemplo, uma pesquisa pode procurar produtos cujo nome contenha determinado termo ou produtos pertencentes a determinada categoria.

Deve ser possível introduzir novos métodos de pesquisa de produtos com impacto mínimo na implementação desenvolvida.

== Alterações de Inventário ==

O inventário de um produto numa empresa pode ser alterado através da especificação de um valor a somar ou subtrair ao número de exemplares disponíveis. Se a quantidade indicada for um valor positivo, aumenta-se o número de exemplares disponíveis.
Se a quantidade indicada for um valor negativo, decrementa-se o número de exemplares disponíveis, desde que o número de exemplares disponíveis não fique negativo.

Um produto não é removido do sistema quando o seu inventário numa empresa chega a zero.
Quando o inventário de um produto numa empresa chega a zero, o produto deixa de estar disponível nessa empresa, mas continua a existir no sistema e pode continuar a ser disponibilizado por outras empresas.
Se o inventário de um produto numa empresa passar de zero para um valor positivo, o produto volta a estar disponível nessa empresa.

O número total de unidades disponíveis de um produto corresponde à soma dos inventários desse produto em todas as empresas que o disponibilizam.

Esta informação é utilizada, nomeadamente, no cálculo do preço recomendado dos produtos nacionais.

== Notificações ==

O sistema deve notificar os clientes relativamente às suas encomendas.

Devem ser enviadas notificações em duas situações:
* um dia antes da data prevista de entrega, informando o cliente de que a encomenda será entregue no dia seguinte;
* no dia da entrega, informando o cliente de que a encomenda foi entregue.

Cada notificação deve ser enviada através do mecanismo de notificação seleccionado pelo cliente.
Inicialmente, devem ser suportados, pelo menos, os seguintes mecanismos:
* correio electrónico ('''EMAIL''');
* WhatsApp ('''WHATSAPP''').

Cada cliente pode escolher o mecanismo através do qual pretende receber notificações do sistema. O mecanismo de notificação pode variar de cliente para cliente. Por exemplo, um cliente pode receber notificações por correio electrónico, enquanto outro pode recebê-las através de WhatsApp.
Deve ser possível introduzir novos mecanismos de notificação sem necessidade de alterar o código dos clientes ou do sistema responsável por gerar as notificações.

Deve ser possível introduzir novos mecanismos de notificação com impacto mínimo na implementação desenvolvida.

As notificações devem ser enviadas pela ordem em que os acontecimentos ocorrem no sistema.

= Requisitos de Desenho =

A aplicação a desenvolver deve seguir o princípio de desenho aberto-fechado, por forma a aumentar a extensibilidade do seu código. Por exemplo, deve ser possível adicionar novos tipos de produto com um impacto mínimo no código já existente da aplicação.

Devem ser possíveis extensões ou alterações de funcionalidade com impacto mínimo no código já produzido para a aplicação. O objectivo é aumentar a flexibilidade da aplicação relativamente ao suporte de novas funções. Assim, deve ser possível:
* Adicionar novos tipos de produto (e.g., produtos digitais ou perecíveis), incluindo a respectiva regra de cálculo do preço recomendado; * Adicionar novas categorias de produto;
* Introduzir novas estratégias de divisão de compras em encomendas;
* Introduzir novas modalidades de transporte (os custos e prazos de cada uma são dados de cada transportadora, não código; nem todas as transportadoras têm de oferecer todas as modalidades);
* Introduzir novos serviços adicionais, sem alterar o código das encomendas nem o dos serviços já existentes;
* Introduzir novos mecanismos de notificação, sem alterar o código dos clientes nem o do sistema que gera as notificações;
* Introduzir novos critérios de discriminação/classificação dos clientes;
* Introduzir novos critérios de pesquisa de produtos.

= Funcionalidade da aplicação =

A aplicação permite manter informação sobre as entidades do modelo, permitindo, em particular, gerir empresas, produtos, clientes e compras. Possui ainda a capacidade de preservar o seu estado (não é possível manter várias versões do estado da aplicação em simultâneo).

Nenhuma entidade é removida pelas operações descritas neste enunciado (em particular, um produto cujo inventário numa empresa chegue a zero continua a existir no sistema). Ainda assim, a aplicação deve estar preparada para que a remoção de qualquer entidade possa vir a ser suportada.

No [[#Leitura de Dados a Partir de Ficheiros Textuais|início]], a aplicação está vazia, mas pode ser carregada uma base de dados textual com conceitos pré-definidos. Neste caso, a aplicação começará com um estado referente às entidades que foram carregadas no arranque da aplicação.

{{Suggestion|Note-se que não é necessário implementar de raiz a aplicação: já existem classes que representam e definem a interface geral da funcionalidade do ''core'' da aplicação, tal como é visível pelos comandos da aplicação.}}
{{CVSCode|A interface geral do ''core'' já está parcialmente implementada na classe '''erp.ErpManager''' e outras fornecidas (cujos nomes devem ser mantidos), devendo ser adaptadas onde necessário. É ainda necessário criar e implementar as restantes classes que suportam a operação da aplicação.}}

== Serialização ==

É possível guardar e recuperar o estado actual da aplicação, preservando toda a informação relacionada com o ERP e que foi descrita [[#Conceitos e Relações do Modelo|acima]].

Após a recuperação do estado, os identificadores atribuídos a novas entidades devem continuar a ser atribuídos incrementalmente a partir do último valor utilizado em cada caso.

= Interacção com o utilizador =

Descreve-se nesta secção a '''funcionalidade máxima''' da interface com o utilizador. Em geral, os comandos pedem toda a informação antes de procederem à sua validação (excepto onde indicado). Todos os menus têm automaticamente a opção '''Sair''' (fecha o menu).

As operações de pedido e apresentação de informação ao utilizador '''devem''' realizar-se através dos objectos ''form'' e ''display'', respectivamente, presentes em cada comando. As mensagens são produzidas pelos métodos das [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|bibliotecas de suporte]] ('''po-uilib''' e '''erp-app'''). As mensagens não podem ser usadas no núcleo da aplicação ('''erp-core'''). Além disso, não podem ser definidas novas. Potenciais omissões devem ser esclarecidas antes de qualquer implementação.

De um modo geral, sempre que no contexto de uma operação com o utilizador aconteça alguma excepção, então a operação não deve ter qualquer efeito no estado da aplicação, excepto em caso de indicação contrária na operação em causa. As excepções estão na package '''erp.app.exceptions''', excepto em caso de indicação contrária.

As excepções usadas na interacção (subclasses de '''pt.tecnico.uilib.menus.CommandException'''), excepto em caso de indicação contrária, são lançadas pelos comandos (subclasses de '''pt.tecnico.uilib.menus.Command''') e tratadas pelos menus (instâncias de subclasses de '''pt.tecnico.uilib.menus.Menu'''). Outras excepções não devem substituir as fornecidas nos casos descritos.

Nos pedidos e usos dos vários identificadores, podem ocorrer as seguintes excepções, caso o identificador indicado não corresponda a um objecto conhecido (excepto no processo de registo ou em caso de indicação contrária). Note-se que estas excepções não são utilizáveis no núcleo da aplicação.

{|
! style="background: #ebebeb;" | '''Tipo de dados'''
! style="background: #ebebeb;" | '''Classe'''
! style="background: #ebebeb;" | '''Pedido a apresentar'''
! style="background: #ebebeb;" | '''Excepção a lançar se desconhecido'''
|-
| Empresa
| '''Company'''
| '''erp.app.company.Prompt.companyId()'''
| '''erp.app.exceptions.UnknownCompanyKeyException'''
|-
| Produto
| '''Product'''
| '''erp.app.product.Prompt.productId()'''
| '''erp.app.exceptions.UnknownProductKeyException'''
|-
| Cliente
| '''Client'''
| '''erp.app.client.Prompt.clientId()'''
| '''erp.app.exceptions.UnknownClientKeyException'''
|-
| Transportadora
| '''Carrier'''
| '''erp.app.carrier.Prompt.carrierId()'''
| '''erp.app.exceptions.UnknownCarrierKeyException'''
|-
| Compra
| '''Purchase'''
| '''erp.app.purchase.Prompt.purchaseId()'''
| '''erp.app.exceptions.UnknownPurchaseKeyException'''
|}

Existe ainda um caso particular: sempre que uma operação se refira a um produto '''no contexto de uma empresa''' e essa empresa não disponibilize esse produto, deve ser lançada a excepção '''erp.app.exceptions.ProductNotSuppliedException''' (a empresa e o produto existem, mas não estão relacionados).

Alguns casos particulares podem usar pedidos específicos não apresentados nesta tabela.

Vários comandos pedem ao utilizador que escolha um valor de um conjunto fechado (tipo de produto, categoria, estratégia de divisão, modalidade de transporte, serviço adicional, mecanismo de notificação e critério de pesquisa). Estas escolhas '''devem''' ser pedidas através de campos de opção ('''Form.addOptionField()''' ou '''Form.requestOption()'''), sendo o conjunto de opções obtido do núcleo através da fachada. Desta forma, a introdução de uma nova estratégia, modalidade, serviço, mecanismo ou critério não implica qualquer alteração aos comandos.

{{CVSCode|Note-se que o programa principal e os comandos e menus, a seguir descritos, já estão parcial ou completamente implementados nas ''packages'' '''erp.app''', '''erp.app.main''', '''erp.app.company''', '''erp.app.product''', '''erp.app.client''', '''erp.app.purchase'''. Estas classes são de uso obrigatório e estão disponíveis no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|GIT]] (módulo '''erp-app''').}}

== Formatos de Apresentação ==

Os formatos usados pelos vários comandos são os seguintes. Todos os campos são separados por '''␣-␣'''.

{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma transportadora|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma tarifa|
''idTransportadora'' - ''modalidade'' - ''custo adicional'' - ''tempo de transporte''
}}

{{CollapsedCode|Formato de apresentação de um produto|
''id'' - ''tipo'' - ''nome'' - ''categoria'' - ''preço base'' - ''preço recomendado'' - ''prazo base'' - ''unidades totais'' - ''informação adicional''
}}

O ''tipo'' é '''NACIONAL''' ou '''IMPORTADO'''. As ''unidades totais'' correspondem à soma dos inventários do produto em todas as empresas que o disponibilizam. Para produtos nacionais não existe informação adicional; para produtos importados, a informação adicional corresponde ao país de origem, à taxa alfandegária e ao prazo de transporte internacional.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 173
2 - IMPORTADO - Telemovel - ELECTRONICA - 200 - 260 - 3 - 2 - China - 30 - 5
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 0
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação da disponibilização de um produto por uma empresa|
''idEmpresa'' - ''idProduto'' - ''unidades'' - ''factor'' - ''preço de venda''
}}

{{CollapsedCode|Exemplos de apresentação de disponibilizações|
<syntaxhighlight lang="text">
2 - 1 - 150 - 0.9 - 14
2 - 2 - 2 - 1.2 - 312
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''mecanismo de notificação'' - ''gasto total''
}}

O valor apresentado no fim corresponde ao total gasto pelo cliente em compras (um valor inteiro).

{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Ahsoka Tano - ahsoka@jedi.org - WHATSAPP - 0
1 - Obi-Wan Kenobi - obiwan@jedi.org - EMAIL - 124
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de uma compra|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
}}

{{CollapsedCode|Formato de apresentação (resumida) de uma encomenda|
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo'' - ''lista de identificadores de produtos''
}}

A ''descrição do transporte'' é o nome da transportadora e a modalidade seleccionadas, separados por '''/''', seguidos das chaves dos serviços adicionais seleccionados, separadas por '''+''' (por exemplo, '''DHL/ EXPRESSO+EMBRULHO+CARTAO_OFERTA'''). O ''custo'' de uma encomenda é o custo base de processamento acrescido do custo da modalidade e dos serviços.

{{CollapsedCode|Exemplos de apresentação de encomendas|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

== Menu Principal ==

As acções deste menu permitem gerir a salvaguarda do estado da aplicação e abrir submenus. A lista completa é a seguinte: [[#Salvaguarda do estado actual da aplicação|Abrir]], [[#Salvaguarda do estado actual da aplicação|Guardar]], [[#Mostrar data actual|Mostrar data actual]], [[#Avançar data actual|Avançar data actual]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Empresas]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Produtos]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Clientes]] e [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Compras]]. Inicialmente, a aplicação apenas tem informação sobre as entidades que foram carregadas no arranque.

{{CVSCode|As etiquetas das opções deste menu estão definidas na classe '''erp.app.main.Label'''. Todos os métodos correspondentes às mensagens de diálogo para este menu estão definidos na classe '''erp.app.main.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.main''', respectivamente: '''DoOpenFile''', '''DoSaveFile''', '''DoDisplayDate''', '''DoAdvanceDate''', '''DoOpenMenuCompanies''', '''DoOpenMenuProducts''', '''DoOpenMenuClients''', '''DoOpenMenuPurchases'''.}}

=== Salvaguarda do estado actual da aplicação ===

O conteúdo da aplicação (toda a informação detida pelo ERP actualmente em memória) pode ser guardado para posterior recuperação (via serialização Java: '''java.io.Serializable'''). Na leitura e escrita do estado da aplicação, devem ser tratadas as excepções associadas. A funcionalidade é a seguinte:

* '''Abrir''' -- Carrega os dados de uma sessão anterior a partir de um ficheiro previamente guardado (ficando este ficheiro associado à aplicação, para futuras operações de salvaguarda). Pede-se o nome do ficheiro a abrir ('''Prompt.openFile()'''). Caso ocorra um problema na abertura ou processamento do ficheiro, deve ser lançada a excepção '''FileOpenFailedException'''. A execução bem-sucedida desta opção substitui toda a informação da aplicação. Quando se abandona uma aplicação com modificações não guardadas (porque se abre outra e existem alterações não guardadas), deve perguntar-se ao utilizador se quer guardar a informação actual antes de a abandonar, através de '''Prompt.saveBeforeExit()''' (a resposta é obtida via '''Form.confirm()''').

* '''Guardar''' -- Guarda o estado actual da aplicação no ficheiro associado. Se não existir associação, pede-se o nome do ficheiro a utilizar, ficando a ele associado (para operações de salvaguarda subsequentes). Esta interacção realiza-se através do método '''Prompt.newSaveAs()'''. Não é executada nenhuma acção se não existirem alterações desde a última salvaguarda.

{{Suggestion|Note-se que a opção '''Abrir''' não permite a leitura de ficheiros de texto (estes apenas podem ser utilizados no início da aplicação).}}
{{Suggestion|A opção '''Sair''' nunca implica a salvaguarda do estado da aplicação, mesmo que existam alterações.}}

=== Mostrar data actual ===

A data actual do sistema é apresentada através da mensagem '''Message.currentDate()'''.

=== Avançar data actual ===

O número de dias a avançar é pedido através de '''Prompt.daysToAdvance()'''. O valor indicado deve ser positivo. Caso contrário, a operação não tem efeito.

Além da data, o sistema deve actualizar, caso seja necessário, outros aspectos que dela dependam, designadamente, a situação das entregas relativa às suas datas de chegada.

=== Gestão e consulta de dados da aplicação ===

* '''Menu de Gestão de Empresas''' -- Abre o menu de gestão de empresas e operações associadas.
* '''Menu de Gestão de Produtos''' -- Abre o menu de gestão de produtos e operações associadas.
* '''Menu de Gestão de Clientes''' -- Abre o menu de gestão de clientes e operações associadas.
* '''Menu de Gestão de Compras''' -- Abre o menu de gestão de compras e operações associadas.

== Menu de Gestão de Empresas ==

Este menu permite efectuar operações sobre a base de dados de empresas. A lista completa é a seguinte: [[#Registar empresa|Registar empresa]], [[#Mostrar empresa|Mostrar empresa]], [[#Mostrar empresas|Mostrar empresas]], [[#Mostrar produtos de uma empresa|Mostrar produtos de uma empresa]], [[#Mostrar clientes de uma empresa|Mostrar clientes de uma empresa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.company.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.company.Prompt''' e '''erp.app.company.Message'''.}}

=== Registar empresa ===

Pede o nome ('''Prompt.companyName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CompanyRegistrationFailedException'''.

Note-se que a atribuição do identificador da empresa é automática.

=== Mostrar empresa ===

É pedido o identificador da empresa, sendo apresentadas as informações sobre essa empresa, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

=== Mostrar empresas ===

Apresenta informações sobre todas as empresas, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar empresa|Mostrar empresa]].

=== Mostrar produtos de uma empresa ===

É pedido o identificador da empresa e apresentam-se os produtos que essa empresa vende, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar produto|Mostrar produto]].

=== Mostrar clientes de uma empresa ===

É pedido o identificador da empresa e apresentam-se os clientes que já interagiram com essa empresa, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar cliente|Mostrar cliente]].

== Menu de Gestão de Produtos ==

Este menu apresenta as operações disponíveis sobre produtos. A lista completa é a seguinte: [[#Mostrar produto|Mostrar produto]], [[#Mostrar produtos|Mostrar produtos]], [[#Alterar inventário de um produto|Alterar inventário de um produto]] e [[#Efectuar pesquisa|Efectuar pesquisa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.product.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.product.Prompt''' e '''erp.app.product.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.product''' (disponível no GIT), respectivamente: '''DoShowProduct''', '''DoShowProducts''', '''DoChangeProductInventory''', '''DoPerformSearch'''.}}

=== Mostrar produto ===

É pedido o identificador do produto. Se o produto existir, é apresentado de acordo com o seguinte formato. O formato genérico de apresentação de um produto é como se segue:
{{CollapsedCode|Formato de apresentação de produtos|
''id'' - ''stock'' - ''tipo'' - ''nome'' - ''preço'' - ''categoria'' - ''informação adicional''
}}

Para produtos fabricados, a informação adicional corresponde ao nome do fabricante e ao código de fabrico (separados pelo carácter ''';'''); para produtos importados, a informação adicional corresponde ao país de origem e à taxa alfandegária.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
3 - 20 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
4 - 2 - IMPORTADO - Telemóvel - 200 - ELECTRONICA - China - 30
5 - 0 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

=== Mostrar produtos ===

Apresenta informações sobre todos os produtos, ordenando-os pelos seus identificadores. O formato de apresentação é como descrito em [[#Mostrar produto|Mostrar produto]].

=== Alterar inventário de um produto ===

É pedido o identificador de um produto e uma quantidade ('''Prompt.amountToUpdate()''') e actualizado o número de exemplares disponíveis do produto indicado somando a quantidade indicada ao número de exemplares disponíveis. No caso de não ser possível actualizar o número de exemplares devido ao facto de a quantidade indicada ser inválida, então a operação não deve ter qualquer efeito e deve ser apresentada a mensagem '''Message.notEnoughInventory()'''.

=== Efectuar pesquisa ===

Esta opção realiza uma procura por termo (cadeia de caracteres), pedido através de '''Prompt.searchTerm()'''. Como resultado, deve ser apresentada uma lista dos produtos encontrados pela pesquisa, ordenados por ordem crescente do seu identificador, utilizando o formato descrito para [[#Mostrar produto|Mostrar produto]].

O termo de pesquisa deve ser comparado (sem distinção entre letras maiúsculas e minúsculas) com os campos relevantes de cada produto: o nome e a categoria. Só devem ser apresentados produtos que contenham o termo de pesquisa num dos campos relevantes. Caso não sejam encontrados produtos, não deve ser produzido qualquer resultado.

== Menu de Gestão de Clientes ==

Este menu permite efectuar operações sobre a base de dados de clientes. A lista completa é a seguinte: [[#Registar cliente|Registar cliente]], [[#Mostrar cliente|Mostrar cliente]], [[#Mostrar clientes|Mostrar clientes]], [[#Mostrar notificações do cliente|Mostrar notificações do cliente]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.client.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.client.Prompt''' e '''erp.app.client.Message'''.}}

=== Registar cliente ===

Pede o nome ('''Prompt.clientName()''') e o endereço de correio electrónico ('''Prompt.clientEMail()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''ClientRegistrationFailedException'''.

Note-se que a atribuição do identificador do cliente é automática e que clientes diferentes são registados em cada operação de registo.

=== Mostrar cliente ===

É pedido o identificador do cliente, sendo apresentadas as informações sobre esse cliente, de acordo com o seguinte formato. O valor apresentado após o email corresponde ao total gasto pelo cliente em compras (um valor inteiro).
{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''gasto total''
}}
{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Alberto Meireles - ameireles@mymail.com - 275
1 - Fernando Meireles - fmeireles@mymail.com - 0
</syntaxhighlight>
}}

=== Mostrar clientes ===

Apresenta informações sobre todos os clientes, ordenando-os lexicograficamente pelo nome. Caso existam clientes com o mesmo nome, devem ser ordenados por ordem crescente dos seus identificadores. O formato é o descrito em [[#Mostrar cliente|Mostrar cliente]].

=== Mostrar notificações do cliente ===

É pedido o identificador do cliente, sendo apresentadas as notificações para esse cliente, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação das notificações de um cliente|
DISPONIBILIDADE: ''descrição de produto disponível''
}}
{{CollapsedCode|Exemplos de notificações|
<syntaxhighlight lang="text">
DISPONIBILIDADE: 5 - 4 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

Note-se que a descrição é idêntica à que é realizada para mostrar cada produto. No entanto, a solução deve ser suficientemente flexível para permitir outros formatos de apresentação das notificações (sem impacto no código do domínio da aplicação).

== Menu de Gestão de Compras ==

Este menu apresenta as operações relacionadas com compras e entregas. A lista completa é a seguinte: [[#Efectuar compra|Efectuar compra]], [[#Mostrar compra|Mostrar compra]], [[#Mostrar compras|Mostrar compras]], [[#Mostrar entregas de uma compra|Mostrar entregas de uma compra]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.purchase.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.purchase.Prompt''' e '''erp.app.purchase.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.purchase''' (disponível no GIT), respectivamente: '''DoDoPurchase''', '''DoShowPurchase''', '''DoShowPurchases''', '''DoShowPurchaseDeliveries'''.}}

=== Efectuar compra ===

No processo de efectuar uma compra, o sistema pede, primeiro, a identificação do cliente; de seguida, a identificação da empresa a que a compra é feita; e, finalmente, para cada linha, o identificador do produto e a quantidade pretendida ('''Prompt.productId()''' e '''Prompt.amountToBuy()'''). O processo de adição de linhas termina de acordo com a interacção definida no comando.

Se não houver exemplares suficientes de um produto para satisfazer a quantidade pretendida, deve ser apresentada a mensagem '''Message.notEnoughInventory()''' e essa linha não é adicionada. Concluída a compra, o ''stock'' dos produtos é decrementado, a empresa passa a seguir o cliente e são determinadas as entregas correspondentes. A data limite de chegada de cada entrega é comunicada através da mensagem '''Message.deliveryDate()'''.

=== Mostrar compra ===

É pedido o identificador da compra. Na primeira linha apresenta-se a informação da compra; de seguida, apresentam-se as suas entregas '''em detalhe''' — cada entrega (identificador da compra e data de chegada) seguida da descrição completa de cada um dos seus produtos (o mesmo formato de [[#Mostrar produto|Mostrar produto]]). O formato é o seguinte:
{{CollapsedCode|Formato de apresentação de uma compra (com entregas em detalhe)|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''sobretaxa de entrega'' - ''preço total''
''idCompra'' - ''data de chegada''
''descrição de produto''
...
}}
{{CollapsedCode|Exemplos de apresentação de compras|
<syntaxhighlight lang="text">
7 - 3 - 1 - 4 - 90 - 9 - 99
7 - 7
1 - 18 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
3 - 2 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
7 - 12
2 - 1 - IMPORTADO - Telemovel - 200 - ELECTRONICA - China - 30
</syntaxhighlight>
}}

=== Mostrar compras ===

Apresenta informações sobre todas as compras, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar compra|Mostrar compra]].

=== Mostrar entregas de uma compra ===

É pedido o identificador da compra e são apresentadas as entregas correspondentes, ordenadas pela data de chegada e, em caso de empate, pelos identificadores dos produtos. Ao contrário de [[#Mostrar compra|Mostrar compra]] (que apresenta as entregas em detalhe), aqui cada entrega é apresentada '''de forma resumida''' (uma linha, apenas com os identificadores dos produtos), de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma entrega|
''idCompra'' - ''data de chegada'' - ''lista de identificadores de produtos''
}}
{{CollapsedCode|Exemplos de apresentação de entregas (compra do exemplo da secção Entregas)|
<syntaxhighlight lang="text">
7 - 7 - 1, 3
7 - 12 - 2
</syntaxhighlight>
}}

= Leitura de Dados a Partir de Ficheiros Textuais =

Além das opções de manipulação de ficheiros descritas no [[#Menu Principal|menu principal]], é possível iniciar a aplicação com um ficheiro de texto especificado pela propriedade Java '''[[#Execução do Programa e Testes Automáticos|import]]'''.

Cada linha tem uma descrição distinta mas que segue o seguinte formato geral. É possível registar transportadoras, empresas, clientes e produtos, e definir as tarifas das transportadoras e as disponibilizações de produtos por parte das empresas. Assume-se que os campos de texto não podem conter o carácter ''':''' e que os preços são números inteiros. Não existem entradas mal-formadas.

O registo de transportadoras, e das tarifas que cada uma pratica, segue os formatos:
CARRIER:''nome''
RATE:''idTransportadora'':''modalidade'':''custo'':''dias''

As entradas '''RATE''' referem transportadoras já registadas em linhas anteriores. O registo de empresas e de clientes segue os formatos:
COMPANY:''nome''
CLIENT:''nome'':''email''
CLIENT:''nome'':''email'':''mecanismo''

O ''mecanismo'' é '''EMAIL''' ou '''WHATSAPP'''; se for omitido, assume-se '''EMAIL'''. Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:

Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:
NATIONAL:''nome'':''preçoBase'':''categoria'':''prazo''
IMPORTED:''nome'':''preçoBase'':''categoria'':''prazo'':''paisOrigem'':''taxa'':''prazoInternacional''

Note-se que o registo de um produto não indica qualquer empresa nem qualquer inventário: essas são propriedades da disponibilização, descrita por entradas próprias, em que ''unidades'' é o número de exemplares que a empresa tem disponíveis e ''factor'' o multiplicador (real) que aplica ao preço recomendado:
SUPPLY:''idEmpresa'':''idProduto'':''unidades'':''factor''

As entradas '''SUPPLY''' referem empresas e produtos já registados em linhas anteriores.

Um exemplo de conteúdo do ficheiro inicial é como se segue:
{{CollapsedCode|Exemplo de ficheiro de entrada textual|
<syntaxhighlight lang="text">
CARRIER:CTT
RATE:1:NORMAL:3:3
RATE:1:EXPRESSO:8:1
CARRIER:DHL
RATE:2:NORMAL:5:2
RATE:2:EXPRESSO:12:1
CARRIER:SEUR
RATE:3:EXPRESSO:10:1
COMPANY:Moageira Nacional
COMPANY:Importadora Atlantico
CLIENT:Obi-Wan Kenobi:obiwan@jedi.org
CLIENT:Ahsoka Tano:ahsoka@jedi.org:WHATSAPP
NATIONAL:Farinha:15:ALIMENTAR:3
IMPORTED:Telemovel:200:ELECTRONICA:3:China:30:5
NATIONAL:Camisa:45:VESTUARIO:2
SUPPLY:1:1:23:1.0
SUPPLY:2:1:150:0.9
SUPPLY:2:2:2:1.2
SUPPLY:1:3:4:1.1
</syntaxhighlight>
}}

A codificação dos ficheiros a ler é garantidamente [[wp:UTF-8|UTF-8]].

{{Suggestion|Os métodos '''String.split()''', para partir cadeias de caracteres, e '''String.trim()''', para remover espaços no início e no final, podem ser usados no processamento de cada linha.}}
{{Suggestion|Note-se que o programa nunca produz ficheiros com este formato (é apenas um formato para ficheiros de entrada).}}

= Execução do Programa e Testes Automáticos =

Usando os ficheiros '''test.import''', '''test.in''' e '''test.out''', é possível verificar automaticamente o resultado correcto do programa. Note-se que é necessária a definição apropriada da variável '''CLASSPATH''' (ou da opção equivalente '''-cp''' do comando '''java'''), para localizar as classes do programa, incluindo a que contém o método correspondente ao ponto de entrada da aplicação ('''erp.app.App.main'''). As propriedades são tratadas automaticamente pelo código de apoio.

java -Dimport=test.import -Din=test.in -Dout=test.outhyp erp.app.App

Assumindo que aqueles ficheiros estão no directório onde é dado o comando de execução, o programa produz o ficheiro de saída '''test.outhyp'''. Em caso de sucesso, os ficheiros das saídas esperada ('''test.out''') e obtida ('''test.outhyp''') devem ser iguais. A comparação pode ser feita com o comando:
diff -b test.out test.outhyp

Este comando não deve produzir qualquer resultado quando os ficheiros são iguais. Note-se, contudo, que este teste não garante o correcto funcionamento do código desenvolvido, apenas verificando alguns aspectos da sua funcionalidade.

= Notas de Implementação =

Tal como indicado acima, algumas classes fornecidas como [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|material de apoio]], são de uso obrigatório e não podem ser alteradas. Outras dessas classes são de uso obrigatório e têm de ser alteradas.

A serialização Java usa as classes da ''package'' [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/package-summary.html java.io], em particular, a interface [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/Serializable.html java.io. Serializable] e as classes de leitura [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/ObjectInputStream.html java.io.ObjectInputStream] e escrita [https://docs.oracle.com/en/java/javase/26/docs/api/java.base/java/io/ObjectOutputStream.html java.io.ObjectOutputStream] (entre outras).

[[category: Ensino]]
[[category:PO]]
[[category: Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T13:12:42Z

Root: /* Execução do Programa e Testes Automáticos */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

'''EM PREPARAÇÃO'''

'''ÉPOCA NORMAL'''

O objectivo do projecto é desenvolver um sistema de gestão de entregas rápidas de produtos (ERP — Express Retail Platform). O sistema deverá permitir, entre outras operações, (i) registar dados de empresas; (ii) registar dados de clientes; (iii) registar, gerir e pesquisar produtos; (iv) efectuar e gerir características de compras; (v) gerir as entregas correspondentes; e (vi) notificar os clientes sobre a situação das suas encomendas.

Neste texto, o tipo '''negrito''' indica um literal (i.e., é exactamente como apresentado); o símbolo ␣ indica um espaço; e o tipo ''itálico'' indica uma parte variável (i.e., uma descrição).

= Conceitos e Relações do Modelo =

Existem vários conceitos importantes neste contexto: [[#Empresas|empresas]], [[#Produtos|produtos]], [[#Clientes|clientes]], [[#Transportadoras|transportadoras]], [[#Cabaz de Compras|cabazes]], [[#Compras|compras]], [[#Divisão das Compras em Encomendas|encomendas]] e [[#Entregas|entregas]].

Os conceitos listados não são os únicos possíveis no modelo e as suas relações (assim como relações com outros conceitos não mencionados) podem depender das escolhas do projecto.

Os clientes e os produtos são independentes das empresas: existem por si e podem relacionar-se com várias empresas. Cada empresa, no entanto, mantém registo dos clientes com quem interage, dos produtos que disponibiliza, das compras feitas e das encomendas que expede.

Uma compra representa a aquisição de produtos por um cliente a uma empresa, e resulta de finalizar um [[#Cabaz de Compras|cabaz]]. Uma compra pode dar origem a uma ou mais encomendas, de acordo com a estratégia de divisão de encomendas utilizada.

Cada encomenda pode ser enviada através de uma determinada transportadora e pode incluir serviços adicionais que alteram o seu custo e/ou prazo de entrega.

== Produtos ==

O sistema mantém um registo global de produtos. Cada produto é identificado por um número de produto. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Todos os produtos têm: um nome/descrição (cadeia de caracteres não vazia); um preço base (número inteiro positivo); uma categoria; e um prazo de entrega base (número inteiro de dias).

O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O sistema utiliza o preço base para calcular o preço recomendado do produto. O preço recomendado representa o valor de referência do produto no sistema. O seu cálculo pode depender do tipo de produto e de outras informações disponíveis no sistema.

Cada produto tem uma categoria, de acordo com a sua natureza. Inicialmente, consideram-se as seguintes categorias: (i) alimentar; (ii) electrónica; e (iii) vestuário. Deve ser possível adicionar novas categorias com impacto mínimo na aplicação já desenvolvida.

O produto existe independentemente das empresas que o disponibilizam. Assim, o mesmo produto pode ser disponibilizado por várias empresas, sendo possível que cada uma pratique um preço de venda diferente.

A informação relativa à disponibilização de um produto por uma empresa não deve ser considerada parte das características intrínsecas do produto.

== Tipos de Produto ==

Todos os produtos considerados no sistema são fabricados, mas podem ter diferentes origens.

Inicialmente, consideram-se os seguintes tipos de produto:
* produto nacional;
* produto importado.

Um produto nacional possui apenas as propriedades gerais dos produtos.

Um produto importado possui, para além das propriedades gerais dos produtos:
* um país de origem (cadeia de caracteres não vazia);
* uma taxa alfandegária (número inteiro expressando uma percentagem);
* um prazo de transporte internacional (número inteiro de dias).

O preço recomendado é calculado de forma diferente consoante o tipo de produto.

Deve ser possível introduzir novos tipos de produto com impacto mínimo na implementação desenvolvida.

=== Produtos Nacionais ===

Para um produto nacional, o preço recomendado depende do preço base e do número total de unidades actualmente disponíveis desse produto nas empresas que o disponibilizam.

Se o número total de unidades disponíveis for:
* superior a 10000, o preço recomendado corresponde a 90% do preço base;
* inferior a 100, o preço recomendado corresponde a 130% do preço base;
* nos restantes casos, o preço recomendado corresponde ao preço base.

Por exemplo, considerando um produto nacional com preço base de 100 euros:
* Unidades disponíveis = 50 => Preço recomendado = 130 euros;
* Unidades disponíveis = 5000 => Preço recomendado = 100 euros;
* Unidades disponíveis = 12000 => Preço recomendado = 90 euros.

=== Produtos Importados ===

Para um produto importado, o preço recomendado corresponde ao preço base acrescido da taxa alfandegária.

Se a taxa alfandegária for '''t%''', o preço recomendado é calculado de acordo com:

'''preço base × (100 + t) / 100'''

Por exemplo, considerando um produto importado com preço base de 100 euros e uma taxa alfandegária de 20%, o preço recomendado será:

'''100 × (100 + 20) / 100 = 120 euros'''

O cálculo do preço recomendado deve ser realizado de forma polimórfica, de modo a que o código que utiliza produtos não tenha de conhecer explicitamente o tipo concreto de cada produto.

== Empresas ==

O sistema mantém um registo das empresas que operam na plataforma. Cada empresa é identificada por um número de empresa. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada empresa tem ainda um nome (cadeia de caracteres não vazia).

Uma empresa pode disponibilizar vários produtos e cada produto pode ser disponibilizado por várias empresas.

Para cada produto que disponibiliza, a empresa deve manter informação sobre:
* número de unidades disponíveis (valor inteiro);
* factor multiplicativo do preço recomendado (número positivo).

O número de unidades disponíveis e o factor multiplicativo podem ser diferentes para cada empresa que disponibiliza o mesmo produto.

O factor multiplicativo permite que uma empresa pratique um preço de venda diferente do preço recomendado pelo sistema. O preço de venda de um produto pela empresa é calculado multiplicando o preço recomendado do produto pelo factor multiplicativo definido pela empresa. Assim, duas empresas podem disponibilizar o mesmo produto a preços diferentes e com quantidades diferentes em stock.

Por exemplo, o produto P1, com um preço recomendado de 100 euros, pode ser disponibilizado pela empresa A com um preço de 90 euros, através de um factor multiplicativo de 0,9. A empresa B pode disponibilizar o mesmo produto com um preço de 120 euros, através de um factor multiplicativo de 1,2.

Deve ser possível adicionar outras propriedades às empresas sem impacto significativo no código já desenvolvido.

== Clientes ==

O sistema mantém um registo de clientes. Cada cliente é identificado por um número de cliente. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada cliente tem ainda informação sobre o seu nome e endereço de correio electrónico. Estes campos não podem ser vazios.

Assume-se que os clientes têm sempre dinheiro, i.e., uma compra nunca é recusada por falta de fundos.

== Compras ==

O sistema regista as compras efectuadas pelos clientes. Cada compra é identificada por um número de compra, atribuído automaticamente e incrementalmente. Uma compra é sempre feita por um único cliente a uma única empresa numa determinada data.

Uma compra é constituída por um conjunto de linhas (um "cabaz"). Cada linha corresponde a:
* um produto;
* uma quantidade (número de exemplares adquiridos desse produto);
* um preço unitário (o preço de venda do produto pela empresa no momento da compra);
* um preço total da linha (quantidade × preço unitário).

O preço unitário utilizado numa compra deve ser guardado na própria linha da compra. Alterações posteriores ao preço base, ao preço recomendado, ao factor multiplicativo da empresa, ou a qualquer outra propriedade utilizada no cálculo do preço, não devem alterar o valor de compras já efectuadas.

O preço total dos itens de uma compra é a soma dos preços totais das suas linhas. Uma compra pode dar origem a uma ou mais encomendas, de acordo com uma estratégia de divisão de encomendas.

A divisão de uma compra em várias encomendas pode ter impacto no custo total da compra.

== Cabaz de Compras ==

Antes de dar origem a uma compra, os produtos que um cliente pretende adquirir a uma empresa são acumulados num '''cabaz'''.

Cada cliente tem um cabaz por cada empresa em que compra. O cabaz é constituído por um conjunto de linhas; cada linha corresponde a um produto disponibilizado por essa empresa e a uma quantidade. Acrescentar ao cabaz um produto que já lá esteja acumula as quantidades.

O cabaz regista ainda as opções que serão aplicadas à compra:
* a [[#Divisão das Compras em Encomendas|estratégia de divisão em encomendas]]; * a [[#Transportadoras|transportadora]] e a [[#Transportadoras|modalidade de transporte]]; e
* o conjunto de [[#Serviços Adicionais|serviços adicionais]].

A transportadora, a modalidade e os serviços adicionais escolhidos aplicam-se a '''todas''' as encomendas resultantes da compra.

Enquanto não for finalizado, o cabaz não tem qualquer efeito no resto do sistema: em particular, não reserva nem consome inventário, e os preços apresentados são sempre os preços de venda praticados pela empresa '''nesse momento'''. Um cabaz faz parte do estado persistente da aplicação: pode ser abandonado e retomado mais tarde.

Ao '''finalizar''' o cabaz, e apenas nesse momento:
* os preços de venda são fixados nas linhas da compra;
* a compra é dividida em encomendas de acordo com a estratégia registada no cabaz;
* todas as encomendas recebem a modalidade de transporte e os serviços adicionais registados no cabaz;
* o inventário dos produtos na empresa é decrementado e o cliente é debitado;
* o cabaz fica vazio.

Um cabaz vazio não pode ser finalizado, nem o pode ser um cabaz em que ainda não tenham sido escolhidas transportadora e modalidade. Se, no momento de finalizar, a empresa já não tiver exemplares suficientes de algum dos produtos do cabaz (por exemplo, porque o inventário foi entretanto alterado), a operação falha sem qualquer efeito e o cabaz mantém-se intacto.

== Divisão das Compras em Encomendas ==

Cada encomenda tem um custo base de processamento e expedição, de '''5 euros'''. Assim, uma compra dividida em várias encomendas pode ter um custo superior ao de uma compra enviada numa única encomenda.

O custo base associado às encomendas corresponde ao número de encomendas multiplicado pelo custo base de uma encomenda.

A este custo podem acrescer os custos associados ao método de transporte seleccionado e aos serviços adicionais.

O custo total de uma compra corresponde, assim, ao custo dos produtos acrescido:
* do custo base das encomendas;
* dos custos adicionais das tarifas de transporte;
* dos custos dos serviços adicionais seleccionados.

A forma como uma compra é dividida em encomendas é determinada por uma estratégia de divisão de encomendas. Inicialmente, devem ser suportadas, pelo menos, as seguintes estratégias: encomenda única ('''UNICA''') e agrupamento por prazo de entrega ('''PRAZO''').

=== Encomenda única ===

Todos os produtos da compra são colocados numa única encomenda.

Neste caso, a compra origina uma única encomenda, independentemente dos prazos de entrega dos produtos.

=== Agrupamento por prazo de entrega ===

Os produtos são agrupados de acordo com os seus prazos de entrega.

Calcula-se a média dos prazos de entrega dos produtos das linhas da compra:
* todas as linhas cujo produto tem prazo menor ou igual à média são agrupadas numa única encomenda;
* cada linha cujo produto tem prazo estritamente maior do que a média é enviada separadamente, numa encomenda própria.

Por exemplo, considere-se uma compra com três linhas cujos produtos têm os prazos de entrega 3 (P1), 8 (P2) e 2 (P3). A média dos prazos é (3 + 8 + 2) / 3 ≈ 4,33. Logo, P1 e P3 (prazos ≤ 4,33) seguem juntos numa entrega e P2 (prazo > 4,33) segue numa outra encomenda:
* Encomenda A: {P1, P3} (prazo = 3)
* Encomenda B: {P2} (prazo = 8)

Uma estratégia de divisão que origina várias encomendas pode permitir que alguns produtos sejam entregues mais cedo, mas pode também resultar num custo superior devido ao custo associado a cada encomenda.

Deve ser possível introduzir novas estratégias de divisão de compras em encomendas com impacto mínimo na implementação desenvolvida.

== Transportadoras ==

O sistema mantém um registo das '''transportadoras''' que operam na plataforma. Cada transportadora é identificada por um número de transportadora. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada transportadora tem ainda um nome (cadeia de caracteres não vazia).

Cada encomenda é enviada através de uma transportadora, segundo uma '''modalidade de transporte'''. Inicialmente, devem ser suportadas, pelo menos, as seguintes modalidades: normal ('''NORMAL''') e expresso ('''EXPRESSO''').

Uma modalidade '''não''' define, por si só, qualquer custo ou prazo: é apenas o nome de um nível de serviço. Para cada modalidade que oferece, uma transportadora define uma '''tarifa''', constituída por:
* um custo adicional (número inteiro); e
* um tempo de transporte (número inteiro de dias).

Assim, a mesma modalidade pode custar e demorar valores diferentes consoante a transportadora.

Uma transportadora '''não tem de oferecer todas as modalidades''': oferece exactamente aquelas para as quais tenha uma tarifa definida. Pedir a uma transportadora uma modalidade que ela não oferece é um erro, e não uma escolha silenciosamente ignorada — ver [[#Definir modalidade de transporte|Definir modalidade de transporte]].

Entre os dois, '''a transportadora tem precedência sobre a modalidade''': como as modalidades disponíveis são as da transportadora, só se pode escolher uma modalidade depois de escolhida a transportadora, e mudar de transportadora anula a modalidade anteriormente escolhida (que passa a ser escolhida de novo, de entre as que a nova transportadora oferece).

Por exemplo:
{|
! style="background: #ebebeb;" | '''Transportadora'''
! style="background: #ebebeb;" | '''Modalidade'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo de transporte'''
|-
| CTT || '''NORMAL''' || 3 euros || 3 dias
|-
| CTT || '''EXPRESSO''' || 8 euros || 1 dia
|-
| DHL || '''NORMAL''' || 5 euros || 2 dias
|-
| DHL || '''EXPRESSO''' || 12 euros || 1 dia
|-
| SEUR || '''EXPRESSO''' || 10 euros || 1 dia
|}

No exemplo acima, a transportadora SEUR só oferece a modalidade expresso: não é possível enviar por SEUR em modalidade normal.

A transportadora e a modalidade são escolhidas no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda seja enviada por uma transportadora ou modalidade diferente.

A escolha da transportadora e da modalidade afecta tanto o custo como a data prevista de entrega da encomenda. Uma compra só pode ser finalizada depois de escolhidas ambas, e o par transportadora/modalidade de um cabaz é sempre um par que a transportadora oferece.

Deve ser possível introduzir novas modalidades de transporte com impacto mínimo na implementação desenvolvida. As transportadoras e as suas tarifas, por seu lado, fazem parte do estado da aplicação: são registadas pelo utilizador e não implicam qualquer alteração ao código.

== Serviços Adicionais ==

O cliente pode seleccionar serviços adicionais, podendo aumentar o custo de cada encomenda, assim como o tempo necessário para a sua preparação e entrega. Os serviços são escolhidos no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda tenha os seus próprios serviços.

Os serviços iniciais são os seguintes:
{|
! style="background: #ebebeb;" | '''Serviço'''
! style="background: #ebebeb;" | '''Chave'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo adicional'''
|-
| Embrulho || '''EMBRULHO''' || 2 euros || 1 dia
|-
| Cartão de oferta || '''CARTAO_OFERTA''' || 1 euro || 0 dias
|}

Os serviços adicionais podem ser combinados: uma encomenda pode incluir simultaneamente embrulho, cartão de oferta ou outro serviço adicional. O custo e o tempo adicionais de uma encomenda correspondem à soma dos contributos da modalidade de transporte e de todos os serviços seleccionados.

Deve ser possível introduzir novos serviços adicionais sem alterar o código das encomendas ou dos serviços já existentes.

== Entregas ==

Cada encomenda tem uma data prevista de entrega.
A data prevista de entrega é determinada considerando:
* a data da compra;
* os prazos de entrega dos produtos que constituem a encomenda;
* o tempo de transporte da tarifa da transportadora seleccionada;
* o tempo adicional introduzido pelos serviços seleccionados.

Para uma encomenda com vários produtos, o prazo dos produtos considerados para determinar a data prevista de entrega corresponde ao maior prazo de entrega dos seus produtos.

Não é necessário manter explicitamente um estado para representar se uma encomenda está ou não entregue. A situação da encomenda pode ser determinada a partir da data actual e da sua data prevista de entrega. Assim, uma encomenda é considerada entregue quando a data actual atinge ou ultrapassa a sua data prevista de entrega.

== Gestão de Tempo ==

A unidade de tempo do sistema é o dia. A data do sistema começa no dia 1 (um) e faz parte do estado persistente.

A data do sistema pode ser avançada. Sempre que a data é alterada, devem ser verificadas as encomendas existentes para determinar:
* quais as encomendas que serão entregues no dia seguinte;
* quais as encomendas cuja data prevista de entrega foi atingida ou ultrapassada.

Quando a data actual atinge ou ultrapassa a data prevista de entrega de uma encomenda, esta considera-se entregue.

A gestão do tempo deve ainda desencadear [[#Notificações|notificações]].

== Pesquisas ==

Para permitir que os clientes determinem a existência de um produto, deverá ser possível efectuar pesquisas.

As pesquisas consideram os campos relevantes dos vários produtos, por exemplo, nome, categoria, tipo de produto ou país de origem.

O termo de pesquisa deve ser comparado sem distinção entre letras maiúsculas e minúsculas.

O sistema deve suportar diferentes critérios de pesquisa. Por exemplo, uma pesquisa pode procurar produtos cujo nome contenha determinado termo ou produtos pertencentes a determinada categoria.

Deve ser possível introduzir novos métodos de pesquisa de produtos com impacto mínimo na implementação desenvolvida.

== Alterações de Inventário ==

O inventário de um produto numa empresa pode ser alterado através da especificação de um valor a somar ou subtrair ao número de exemplares disponíveis. Se a quantidade indicada for um valor positivo, aumenta-se o número de exemplares disponíveis.
Se a quantidade indicada for um valor negativo, decrementa-se o número de exemplares disponíveis, desde que o número de exemplares disponíveis não fique negativo.

Um produto não é removido do sistema quando o seu inventário numa empresa chega a zero.
Quando o inventário de um produto numa empresa chega a zero, o produto deixa de estar disponível nessa empresa, mas continua a existir no sistema e pode continuar a ser disponibilizado por outras empresas.
Se o inventário de um produto numa empresa passar de zero para um valor positivo, o produto volta a estar disponível nessa empresa.

O número total de unidades disponíveis de um produto corresponde à soma dos inventários desse produto em todas as empresas que o disponibilizam.

Esta informação é utilizada, nomeadamente, no cálculo do preço recomendado dos produtos nacionais.

== Notificações ==

O sistema deve notificar os clientes relativamente às suas encomendas.

Devem ser enviadas notificações em duas situações:
* um dia antes da data prevista de entrega, informando o cliente de que a encomenda será entregue no dia seguinte;
* no dia da entrega, informando o cliente de que a encomenda foi entregue.

Cada notificação deve ser enviada através do mecanismo de notificação seleccionado pelo cliente.
Inicialmente, devem ser suportados, pelo menos, os seguintes mecanismos:
* correio electrónico ('''EMAIL''');
* WhatsApp ('''WHATSAPP''').

Cada cliente pode escolher o mecanismo através do qual pretende receber notificações do sistema. O mecanismo de notificação pode variar de cliente para cliente. Por exemplo, um cliente pode receber notificações por correio electrónico, enquanto outro pode recebê-las através de WhatsApp.
Deve ser possível introduzir novos mecanismos de notificação sem necessidade de alterar o código dos clientes ou do sistema responsável por gerar as notificações.

Deve ser possível introduzir novos mecanismos de notificação com impacto mínimo na implementação desenvolvida.

As notificações devem ser enviadas pela ordem em que os acontecimentos ocorrem no sistema.

= Requisitos de Desenho =

A aplicação a desenvolver deve seguir o princípio de desenho aberto-fechado, por forma a aumentar a extensibilidade do seu código. Por exemplo, deve ser possível adicionar novos tipos de produto com um impacto mínimo no código já existente da aplicação.

Devem ser possíveis extensões ou alterações de funcionalidade com impacto mínimo no código já produzido para a aplicação. O objectivo é aumentar a flexibilidade da aplicação relativamente ao suporte de novas funções. Assim, deve ser possível:
* Adicionar novos tipos de produto (e.g., produtos digitais ou perecíveis), incluindo a respectiva regra de cálculo do preço recomendado; * Adicionar novas categorias de produto;
* Introduzir novas estratégias de divisão de compras em encomendas;
* Introduzir novas modalidades de transporte (os custos e prazos de cada uma são dados de cada transportadora, não código; nem todas as transportadoras têm de oferecer todas as modalidades);
* Introduzir novos serviços adicionais, sem alterar o código das encomendas nem o dos serviços já existentes;
* Introduzir novos mecanismos de notificação, sem alterar o código dos clientes nem o do sistema que gera as notificações;
* Introduzir novos critérios de discriminação/classificação dos clientes;
* Introduzir novos critérios de pesquisa de produtos.

= Funcionalidade da aplicação =

A aplicação permite manter informação sobre as entidades do modelo, permitindo, em particular, gerir empresas, produtos, clientes e compras. Possui ainda a capacidade de preservar o seu estado (não é possível manter várias versões do estado da aplicação em simultâneo).

Nenhuma entidade é removida pelas operações descritas neste enunciado (em particular, um produto cujo inventário numa empresa chegue a zero continua a existir no sistema). Ainda assim, a aplicação deve estar preparada para que a remoção de qualquer entidade possa vir a ser suportada.

No [[#Leitura de Dados a Partir de Ficheiros Textuais|início]], a aplicação está vazia, mas pode ser carregada uma base de dados textual com conceitos pré-definidos. Neste caso, a aplicação começará com um estado referente às entidades que foram carregadas no arranque da aplicação.

{{Suggestion|Note-se que não é necessário implementar de raiz a aplicação: já existem classes que representam e definem a interface geral da funcionalidade do ''core'' da aplicação, tal como é visível pelos comandos da aplicação.}}
{{CVSCode|A interface geral do ''core'' já está parcialmente implementada na classe '''erp.ErpManager''' e outras fornecidas (cujos nomes devem ser mantidos), devendo ser adaptadas onde necessário. É ainda necessário criar e implementar as restantes classes que suportam a operação da aplicação.}}

== Serialização ==

É possível guardar e recuperar o estado actual da aplicação, preservando toda a informação relacionada com o ERP e que foi descrita [[#Conceitos e Relações do Modelo|acima]].

Após a recuperação do estado, os identificadores atribuídos a novas entidades devem continuar a ser atribuídos incrementalmente a partir do último valor utilizado em cada caso.

= Interacção com o utilizador =

Descreve-se nesta secção a '''funcionalidade máxima''' da interface com o utilizador. Em geral, os comandos pedem toda a informação antes de procederem à sua validação (excepto onde indicado). Todos os menus têm automaticamente a opção '''Sair''' (fecha o menu).

As operações de pedido e apresentação de informação ao utilizador '''devem''' realizar-se através dos objectos ''form'' e ''display'', respectivamente, presentes em cada comando. As mensagens são produzidas pelos métodos das [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|bibliotecas de suporte]] ('''po-uilib''' e '''erp-app'''). As mensagens não podem ser usadas no núcleo da aplicação ('''erp-core'''). Além disso, não podem ser definidas novas. Potenciais omissões devem ser esclarecidas antes de qualquer implementação.

De um modo geral, sempre que no contexto de uma operação com o utilizador aconteça alguma excepção, então a operação não deve ter qualquer efeito no estado da aplicação, excepto em caso de indicação contrária na operação em causa. As excepções estão na package '''erp.app.exceptions''', excepto em caso de indicação contrária.

As excepções usadas na interacção (subclasses de '''pt.tecnico.uilib.menus.CommandException'''), excepto em caso de indicação contrária, são lançadas pelos comandos (subclasses de '''pt.tecnico.uilib.menus.Command''') e tratadas pelos menus (instâncias de subclasses de '''pt.tecnico.uilib.menus.Menu'''). Outras excepções não devem substituir as fornecidas nos casos descritos.

Nos pedidos e usos dos vários identificadores, podem ocorrer as seguintes excepções, caso o identificador indicado não corresponda a um objecto conhecido (excepto no processo de registo ou em caso de indicação contrária). Note-se que estas excepções não são utilizáveis no núcleo da aplicação.

{|
! style="background: #ebebeb;" | '''Tipo de dados'''
! style="background: #ebebeb;" | '''Classe'''
! style="background: #ebebeb;" | '''Pedido a apresentar'''
! style="background: #ebebeb;" | '''Excepção a lançar se desconhecido'''
|-
| Empresa
| '''Company'''
| '''erp.app.company.Prompt.companyId()'''
| '''erp.app.exceptions.UnknownCompanyKeyException'''
|-
| Produto
| '''Product'''
| '''erp.app.product.Prompt.productId()'''
| '''erp.app.exceptions.UnknownProductKeyException'''
|-
| Cliente
| '''Client'''
| '''erp.app.client.Prompt.clientId()'''
| '''erp.app.exceptions.UnknownClientKeyException'''
|-
| Transportadora
| '''Carrier'''
| '''erp.app.carrier.Prompt.carrierId()'''
| '''erp.app.exceptions.UnknownCarrierKeyException'''
|-
| Compra
| '''Purchase'''
| '''erp.app.purchase.Prompt.purchaseId()'''
| '''erp.app.exceptions.UnknownPurchaseKeyException'''
|}

Existe ainda um caso particular: sempre que uma operação se refira a um produto '''no contexto de uma empresa''' e essa empresa não disponibilize esse produto, deve ser lançada a excepção '''erp.app.exceptions.ProductNotSuppliedException''' (a empresa e o produto existem, mas não estão relacionados).

Alguns casos particulares podem usar pedidos específicos não apresentados nesta tabela.

Vários comandos pedem ao utilizador que escolha um valor de um conjunto fechado (tipo de produto, categoria, estratégia de divisão, modalidade de transporte, serviço adicional, mecanismo de notificação e critério de pesquisa). Estas escolhas '''devem''' ser pedidas através de campos de opção ('''Form.addOptionField()''' ou '''Form.requestOption()'''), sendo o conjunto de opções obtido do núcleo através da fachada. Desta forma, a introdução de uma nova estratégia, modalidade, serviço, mecanismo ou critério não implica qualquer alteração aos comandos.

{{CVSCode|Note-se que o programa principal e os comandos e menus, a seguir descritos, já estão parcial ou completamente implementados nas ''packages'' '''erp.app''', '''erp.app.main''', '''erp.app.company''', '''erp.app.product''', '''erp.app.client''', '''erp.app.purchase'''. Estas classes são de uso obrigatório e estão disponíveis no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|GIT]] (módulo '''erp-app''').}}

== Formatos de Apresentação ==

Os formatos usados pelos vários comandos são os seguintes. Todos os campos são separados por '''␣-␣'''.

{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma transportadora|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma tarifa|
''idTransportadora'' - ''modalidade'' - ''custo adicional'' - ''tempo de transporte''
}}

{{CollapsedCode|Formato de apresentação de um produto|
''id'' - ''tipo'' - ''nome'' - ''categoria'' - ''preço base'' - ''preço recomendado'' - ''prazo base'' - ''unidades totais'' - ''informação adicional''
}}

O ''tipo'' é '''NACIONAL''' ou '''IMPORTADO'''. As ''unidades totais'' correspondem à soma dos inventários do produto em todas as empresas que o disponibilizam. Para produtos nacionais não existe informação adicional; para produtos importados, a informação adicional corresponde ao país de origem, à taxa alfandegária e ao prazo de transporte internacional.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 173
2 - IMPORTADO - Telemovel - ELECTRONICA - 200 - 260 - 3 - 2 - China - 30 - 5
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 0
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação da disponibilização de um produto por uma empresa|
''idEmpresa'' - ''idProduto'' - ''unidades'' - ''factor'' - ''preço de venda''
}}

{{CollapsedCode|Exemplos de apresentação de disponibilizações|
<syntaxhighlight lang="text">
2 - 1 - 150 - 0.9 - 14
2 - 2 - 2 - 1.2 - 312
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''mecanismo de notificação'' - ''gasto total''
}}

O valor apresentado no fim corresponde ao total gasto pelo cliente em compras (um valor inteiro).

{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Ahsoka Tano - ahsoka@jedi.org - WHATSAPP - 0
1 - Obi-Wan Kenobi - obiwan@jedi.org - EMAIL - 124
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de uma compra|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
}}

{{CollapsedCode|Formato de apresentação (resumida) de uma encomenda|
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo'' - ''lista de identificadores de produtos''
}}

A ''descrição do transporte'' é o nome da transportadora e a modalidade seleccionadas, separados por '''/''', seguidos das chaves dos serviços adicionais seleccionados, separadas por '''+''' (por exemplo, '''DHL/ EXPRESSO+EMBRULHO+CARTAO_OFERTA'''). O ''custo'' de uma encomenda é o custo base de processamento acrescido do custo da modalidade e dos serviços.

{{CollapsedCode|Exemplos de apresentação de encomendas|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

== Menu Principal ==

As acções deste menu permitem gerir a salvaguarda do estado da aplicação e abrir submenus. A lista completa é a seguinte: [[#Salvaguarda do estado actual da aplicação|Abrir]], [[#Salvaguarda do estado actual da aplicação|Guardar]], [[#Mostrar data actual|Mostrar data actual]], [[#Avançar data actual|Avançar data actual]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Empresas]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Produtos]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Clientes]] e [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Compras]]. Inicialmente, a aplicação apenas tem informação sobre as entidades que foram carregadas no arranque.

{{CVSCode|As etiquetas das opções deste menu estão definidas na classe '''erp.app.main.Label'''. Todos os métodos correspondentes às mensagens de diálogo para este menu estão definidos na classe '''erp.app.main.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.main''', respectivamente: '''DoOpenFile''', '''DoSaveFile''', '''DoDisplayDate''', '''DoAdvanceDate''', '''DoOpenMenuCompanies''', '''DoOpenMenuProducts''', '''DoOpenMenuClients''', '''DoOpenMenuPurchases'''.}}

=== Salvaguarda do estado actual da aplicação ===

O conteúdo da aplicação (toda a informação detida pelo ERP actualmente em memória) pode ser guardado para posterior recuperação (via serialização Java: '''java.io.Serializable'''). Na leitura e escrita do estado da aplicação, devem ser tratadas as excepções associadas. A funcionalidade é a seguinte:

* '''Abrir''' -- Carrega os dados de uma sessão anterior a partir de um ficheiro previamente guardado (ficando este ficheiro associado à aplicação, para futuras operações de salvaguarda). Pede-se o nome do ficheiro a abrir ('''Prompt.openFile()'''). Caso ocorra um problema na abertura ou processamento do ficheiro, deve ser lançada a excepção '''FileOpenFailedException'''. A execução bem-sucedida desta opção substitui toda a informação da aplicação. Quando se abandona uma aplicação com modificações não guardadas (porque se abre outra e existem alterações não guardadas), deve perguntar-se ao utilizador se quer guardar a informação actual antes de a abandonar, através de '''Prompt.saveBeforeExit()''' (a resposta é obtida via '''Form.confirm()''').

* '''Guardar''' -- Guarda o estado actual da aplicação no ficheiro associado. Se não existir associação, pede-se o nome do ficheiro a utilizar, ficando a ele associado (para operações de salvaguarda subsequentes). Esta interacção realiza-se através do método '''Prompt.newSaveAs()'''. Não é executada nenhuma acção se não existirem alterações desde a última salvaguarda.

{{Suggestion|Note-se que a opção '''Abrir''' não permite a leitura de ficheiros de texto (estes apenas podem ser utilizados no início da aplicação).}}
{{Suggestion|A opção '''Sair''' nunca implica a salvaguarda do estado da aplicação, mesmo que existam alterações.}}

=== Mostrar data actual ===

A data actual do sistema é apresentada através da mensagem '''Message.currentDate()'''.

=== Avançar data actual ===

O número de dias a avançar é pedido através de '''Prompt.daysToAdvance()'''. O valor indicado deve ser positivo. Caso contrário, a operação não tem efeito.

Além da data, o sistema deve actualizar, caso seja necessário, outros aspectos que dela dependam, designadamente, a situação das entregas relativa às suas datas de chegada.

=== Gestão e consulta de dados da aplicação ===

* '''Menu de Gestão de Empresas''' -- Abre o menu de gestão de empresas e operações associadas.
* '''Menu de Gestão de Produtos''' -- Abre o menu de gestão de produtos e operações associadas.
* '''Menu de Gestão de Clientes''' -- Abre o menu de gestão de clientes e operações associadas.
* '''Menu de Gestão de Compras''' -- Abre o menu de gestão de compras e operações associadas.

== Menu de Gestão de Empresas ==

Este menu permite efectuar operações sobre a base de dados de empresas. A lista completa é a seguinte: [[#Registar empresa|Registar empresa]], [[#Mostrar empresa|Mostrar empresa]], [[#Mostrar empresas|Mostrar empresas]], [[#Mostrar produtos de uma empresa|Mostrar produtos de uma empresa]], [[#Mostrar clientes de uma empresa|Mostrar clientes de uma empresa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.company.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.company.Prompt''' e '''erp.app.company.Message'''.}}

=== Registar empresa ===

Pede o nome ('''Prompt.companyName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CompanyRegistrationFailedException'''.

Note-se que a atribuição do identificador da empresa é automática.

=== Mostrar empresa ===

É pedido o identificador da empresa, sendo apresentadas as informações sobre essa empresa, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

=== Mostrar empresas ===

Apresenta informações sobre todas as empresas, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar empresa|Mostrar empresa]].

=== Mostrar produtos de uma empresa ===

É pedido o identificador da empresa e apresentam-se os produtos que essa empresa vende, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar produto|Mostrar produto]].

=== Mostrar clientes de uma empresa ===

É pedido o identificador da empresa e apresentam-se os clientes que já interagiram com essa empresa, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar cliente|Mostrar cliente]].

== Menu de Gestão de Produtos ==

Este menu apresenta as operações disponíveis sobre produtos. A lista completa é a seguinte: [[#Mostrar produto|Mostrar produto]], [[#Mostrar produtos|Mostrar produtos]], [[#Alterar inventário de um produto|Alterar inventário de um produto]] e [[#Efectuar pesquisa|Efectuar pesquisa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.product.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.product.Prompt''' e '''erp.app.product.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.product''' (disponível no GIT), respectivamente: '''DoShowProduct''', '''DoShowProducts''', '''DoChangeProductInventory''', '''DoPerformSearch'''.}}

=== Mostrar produto ===

É pedido o identificador do produto. Se o produto existir, é apresentado de acordo com o seguinte formato. O formato genérico de apresentação de um produto é como se segue:
{{CollapsedCode|Formato de apresentação de produtos|
''id'' - ''stock'' - ''tipo'' - ''nome'' - ''preço'' - ''categoria'' - ''informação adicional''
}}

Para produtos fabricados, a informação adicional corresponde ao nome do fabricante e ao código de fabrico (separados pelo carácter ''';'''); para produtos importados, a informação adicional corresponde ao país de origem e à taxa alfandegária.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
3 - 20 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
4 - 2 - IMPORTADO - Telemóvel - 200 - ELECTRONICA - China - 30
5 - 0 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

=== Mostrar produtos ===

Apresenta informações sobre todos os produtos, ordenando-os pelos seus identificadores. O formato de apresentação é como descrito em [[#Mostrar produto|Mostrar produto]].

=== Alterar inventário de um produto ===

É pedido o identificador de um produto e uma quantidade ('''Prompt.amountToUpdate()''') e actualizado o número de exemplares disponíveis do produto indicado somando a quantidade indicada ao número de exemplares disponíveis. No caso de não ser possível actualizar o número de exemplares devido ao facto de a quantidade indicada ser inválida, então a operação não deve ter qualquer efeito e deve ser apresentada a mensagem '''Message.notEnoughInventory()'''.

=== Efectuar pesquisa ===

Esta opção realiza uma procura por termo (cadeia de caracteres), pedido através de '''Prompt.searchTerm()'''. Como resultado, deve ser apresentada uma lista dos produtos encontrados pela pesquisa, ordenados por ordem crescente do seu identificador, utilizando o formato descrito para [[#Mostrar produto|Mostrar produto]].

O termo de pesquisa deve ser comparado (sem distinção entre letras maiúsculas e minúsculas) com os campos relevantes de cada produto: o nome e a categoria. Só devem ser apresentados produtos que contenham o termo de pesquisa num dos campos relevantes. Caso não sejam encontrados produtos, não deve ser produzido qualquer resultado.

== Menu de Gestão de Clientes ==

Este menu permite efectuar operações sobre a base de dados de clientes. A lista completa é a seguinte: [[#Registar cliente|Registar cliente]], [[#Mostrar cliente|Mostrar cliente]], [[#Mostrar clientes|Mostrar clientes]], [[#Mostrar notificações do cliente|Mostrar notificações do cliente]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.client.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.client.Prompt''' e '''erp.app.client.Message'''.}}

=== Registar cliente ===

Pede o nome ('''Prompt.clientName()''') e o endereço de correio electrónico ('''Prompt.clientEMail()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''ClientRegistrationFailedException'''.

Note-se que a atribuição do identificador do cliente é automática e que clientes diferentes são registados em cada operação de registo.

=== Mostrar cliente ===

É pedido o identificador do cliente, sendo apresentadas as informações sobre esse cliente, de acordo com o seguinte formato. O valor apresentado após o email corresponde ao total gasto pelo cliente em compras (um valor inteiro).
{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''gasto total''
}}
{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Alberto Meireles - ameireles@mymail.com - 275
1 - Fernando Meireles - fmeireles@mymail.com - 0
</syntaxhighlight>
}}

=== Mostrar clientes ===

Apresenta informações sobre todos os clientes, ordenando-os lexicograficamente pelo nome. Caso existam clientes com o mesmo nome, devem ser ordenados por ordem crescente dos seus identificadores. O formato é o descrito em [[#Mostrar cliente|Mostrar cliente]].

=== Mostrar notificações do cliente ===

É pedido o identificador do cliente, sendo apresentadas as notificações para esse cliente, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação das notificações de um cliente|
DISPONIBILIDADE: ''descrição de produto disponível''
}}
{{CollapsedCode|Exemplos de notificações|
<syntaxhighlight lang="text">
DISPONIBILIDADE: 5 - 4 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

Note-se que a descrição é idêntica à que é realizada para mostrar cada produto. No entanto, a solução deve ser suficientemente flexível para permitir outros formatos de apresentação das notificações (sem impacto no código do domínio da aplicação).

== Menu de Gestão de Compras ==

Este menu apresenta as operações relacionadas com compras e entregas. A lista completa é a seguinte: [[#Efectuar compra|Efectuar compra]], [[#Mostrar compra|Mostrar compra]], [[#Mostrar compras|Mostrar compras]], [[#Mostrar entregas de uma compra|Mostrar entregas de uma compra]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.purchase.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.purchase.Prompt''' e '''erp.app.purchase.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.purchase''' (disponível no GIT), respectivamente: '''DoDoPurchase''', '''DoShowPurchase''', '''DoShowPurchases''', '''DoShowPurchaseDeliveries'''.}}

=== Efectuar compra ===

No processo de efectuar uma compra, o sistema pede, primeiro, a identificação do cliente; de seguida, a identificação da empresa a que a compra é feita; e, finalmente, para cada linha, o identificador do produto e a quantidade pretendida ('''Prompt.productId()''' e '''Prompt.amountToBuy()'''). O processo de adição de linhas termina de acordo com a interacção definida no comando.

Se não houver exemplares suficientes de um produto para satisfazer a quantidade pretendida, deve ser apresentada a mensagem '''Message.notEnoughInventory()''' e essa linha não é adicionada. Concluída a compra, o ''stock'' dos produtos é decrementado, a empresa passa a seguir o cliente e são determinadas as entregas correspondentes. A data limite de chegada de cada entrega é comunicada através da mensagem '''Message.deliveryDate()'''.

=== Mostrar compra ===

É pedido o identificador da compra. Na primeira linha apresenta-se a informação da compra; de seguida, apresentam-se as suas entregas '''em detalhe''' — cada entrega (identificador da compra e data de chegada) seguida da descrição completa de cada um dos seus produtos (o mesmo formato de [[#Mostrar produto|Mostrar produto]]). O formato é o seguinte:
{{CollapsedCode|Formato de apresentação de uma compra (com entregas em detalhe)|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''sobretaxa de entrega'' - ''preço total''
''idCompra'' - ''data de chegada''
''descrição de produto''
...
}}
{{CollapsedCode|Exemplos de apresentação de compras|
<syntaxhighlight lang="text">
7 - 3 - 1 - 4 - 90 - 9 - 99
7 - 7
1 - 18 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
3 - 2 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
7 - 12
2 - 1 - IMPORTADO - Telemovel - 200 - ELECTRONICA - China - 30
</syntaxhighlight>
}}

=== Mostrar compras ===

Apresenta informações sobre todas as compras, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar compra|Mostrar compra]].

=== Mostrar entregas de uma compra ===

É pedido o identificador da compra e são apresentadas as entregas correspondentes, ordenadas pela data de chegada e, em caso de empate, pelos identificadores dos produtos. Ao contrário de [[#Mostrar compra|Mostrar compra]] (que apresenta as entregas em detalhe), aqui cada entrega é apresentada '''de forma resumida''' (uma linha, apenas com os identificadores dos produtos), de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma entrega|
''idCompra'' - ''data de chegada'' - ''lista de identificadores de produtos''
}}
{{CollapsedCode|Exemplos de apresentação de entregas (compra do exemplo da secção Entregas)|
<syntaxhighlight lang="text">
7 - 7 - 1, 3
7 - 12 - 2
</syntaxhighlight>
}}

= Leitura de Dados a Partir de Ficheiros Textuais =

Além das opções de manipulação de ficheiros descritas no [[#Menu Principal|menu principal]], é possível iniciar a aplicação com um ficheiro de texto especificado pela propriedade Java '''[[#Execução do Programa e Testes Automáticos|import]]'''.

Cada linha tem uma descrição distinta mas que segue o seguinte formato geral. É possível registar transportadoras, empresas, clientes e produtos, e definir as tarifas das transportadoras e as disponibilizações de produtos por parte das empresas. Assume-se que os campos de texto não podem conter o carácter ''':''' e que os preços são números inteiros. Não existem entradas mal-formadas.

O registo de transportadoras, e das tarifas que cada uma pratica, segue os formatos:
CARRIER:''nome''
RATE:''idTransportadora'':''modalidade'':''custo'':''dias''

As entradas '''RATE''' referem transportadoras já registadas em linhas anteriores. O registo de empresas e de clientes segue os formatos:
COMPANY:''nome''
CLIENT:''nome'':''email''
CLIENT:''nome'':''email'':''mecanismo''

O ''mecanismo'' é '''EMAIL''' ou '''WHATSAPP'''; se for omitido, assume-se '''EMAIL'''. Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:

Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:
NATIONAL:''nome'':''preçoBase'':''categoria'':''prazo''
IMPORTED:''nome'':''preçoBase'':''categoria'':''prazo'':''paisOrigem'':''taxa'':''prazoInternacional''

Note-se que o registo de um produto não indica qualquer empresa nem qualquer inventário: essas são propriedades da disponibilização, descrita por entradas próprias, em que ''unidades'' é o número de exemplares que a empresa tem disponíveis e ''factor'' o multiplicador (real) que aplica ao preço recomendado:
SUPPLY:''idEmpresa'':''idProduto'':''unidades'':''factor''

As entradas '''SUPPLY''' referem empresas e produtos já registados em linhas anteriores.

Um exemplo de conteúdo do ficheiro inicial é como se segue:
{{CollapsedCode|Exemplo de ficheiro de entrada textual|
<syntaxhighlight lang="text">
CARRIER:CTT
RATE:1:NORMAL:3:3
RATE:1:EXPRESSO:8:1
CARRIER:DHL
RATE:2:NORMAL:5:2
RATE:2:EXPRESSO:12:1
CARRIER:SEUR
RATE:3:EXPRESSO:10:1
COMPANY:Moageira Nacional
COMPANY:Importadora Atlantico
CLIENT:Obi-Wan Kenobi:obiwan@jedi.org
CLIENT:Ahsoka Tano:ahsoka@jedi.org:WHATSAPP
NATIONAL:Farinha:15:ALIMENTAR:3
IMPORTED:Telemovel:200:ELECTRONICA:3:China:30:5
NATIONAL:Camisa:45:VESTUARIO:2
SUPPLY:1:1:23:1.0
SUPPLY:2:1:150:0.9
SUPPLY:2:2:2:1.2
SUPPLY:1:3:4:1.1
</syntaxhighlight>
}}

A codificação dos ficheiros a ler é garantidamente [[wp:UTF-8|UTF-8]].

{{Suggestion|Os métodos '''String.split()''', para partir cadeias de caracteres, e '''String.trim()''', para remover espaços no início e no final, podem ser usados no processamento de cada linha.}}
{{Suggestion|Note-se que o programa nunca produz ficheiros com este formato (é apenas um formato para ficheiros de entrada).}}

= Execução do Programa e Testes Automáticos =

Usando os ficheiros '''test.import''', '''test.in''' e '''test.out''', é possível verificar automaticamente o resultado correcto do programa. Note-se que é necessária a definição apropriada da variável '''CLASSPATH''' (ou da opção equivalente '''-cp''' do comando '''java'''), para localizar as classes do programa, incluindo a que contém o método correspondente ao ponto de entrada da aplicação ('''erp.app.App.main'''). As propriedades são tratadas automaticamente pelo código de apoio.

java -Dimport=test.import -Din=test.in -Dout=test.outhyp erp.app.App

Assumindo que aqueles ficheiros estão no directório onde é dado o comando de execução, o programa produz o ficheiro de saída '''test.outhyp'''. Em caso de sucesso, os ficheiros das saídas esperada ('''test.out''') e obtida ('''test.outhyp''') devem ser iguais. A comparação pode ser feita com o comando:
diff -b test.out test.outhyp

Este comando não deve produzir qualquer resultado quando os ficheiros são iguais. Note-se, contudo, que este teste não garante o correcto funcionamento do código desenvolvido, apenas verificando alguns aspectos da sua funcionalidade.

= Notas de Implementação =

Tal como indicado acima, algumas classes fornecidas como [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|material de apoio]], são de uso obrigatório e não podem ser alteradas. Outras dessas classes são de uso obrigatório e têm de ser alteradas.

A serialização Java usa as classes da ''package'' [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/package-summary.html java.io], em particular, a interface [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/Serializable.html java.io.Serializable] e as classes de leitura [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectInputStream.html java.io.ObjectInputStream] e escrita [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectOutputStream.html java.io.ObjectOutputStream] (entre outras).

[[category: Ensino]]
[[category:PO]]
[[category: Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T13:11:09Z

Root: /* Leitura de Dados a Partir de Ficheiros Textuais */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

'''EM PREPARAÇÃO'''

'''ÉPOCA NORMAL'''

O objectivo do projecto é desenvolver um sistema de gestão de entregas rápidas de produtos (ERP — Express Retail Platform). O sistema deverá permitir, entre outras operações, (i) registar dados de empresas; (ii) registar dados de clientes; (iii) registar, gerir e pesquisar produtos; (iv) efectuar e gerir características de compras; (v) gerir as entregas correspondentes; e (vi) notificar os clientes sobre a situação das suas encomendas.

Neste texto, o tipo '''negrito''' indica um literal (i.e., é exactamente como apresentado); o símbolo ␣ indica um espaço; e o tipo ''itálico'' indica uma parte variável (i.e., uma descrição).

= Conceitos e Relações do Modelo =

Existem vários conceitos importantes neste contexto: [[#Empresas|empresas]], [[#Produtos|produtos]], [[#Clientes|clientes]], [[#Transportadoras|transportadoras]], [[#Cabaz de Compras|cabazes]], [[#Compras|compras]], [[#Divisão das Compras em Encomendas|encomendas]] e [[#Entregas|entregas]].

Os conceitos listados não são os únicos possíveis no modelo e as suas relações (assim como relações com outros conceitos não mencionados) podem depender das escolhas do projecto.

Os clientes e os produtos são independentes das empresas: existem por si e podem relacionar-se com várias empresas. Cada empresa, no entanto, mantém registo dos clientes com quem interage, dos produtos que disponibiliza, das compras feitas e das encomendas que expede.

Uma compra representa a aquisição de produtos por um cliente a uma empresa, e resulta de finalizar um [[#Cabaz de Compras|cabaz]]. Uma compra pode dar origem a uma ou mais encomendas, de acordo com a estratégia de divisão de encomendas utilizada.

Cada encomenda pode ser enviada através de uma determinada transportadora e pode incluir serviços adicionais que alteram o seu custo e/ou prazo de entrega.

== Produtos ==

O sistema mantém um registo global de produtos. Cada produto é identificado por um número de produto. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Todos os produtos têm: um nome/descrição (cadeia de caracteres não vazia); um preço base (número inteiro positivo); uma categoria; e um prazo de entrega base (número inteiro de dias).

O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O sistema utiliza o preço base para calcular o preço recomendado do produto. O preço recomendado representa o valor de referência do produto no sistema. O seu cálculo pode depender do tipo de produto e de outras informações disponíveis no sistema.

Cada produto tem uma categoria, de acordo com a sua natureza. Inicialmente, consideram-se as seguintes categorias: (i) alimentar; (ii) electrónica; e (iii) vestuário. Deve ser possível adicionar novas categorias com impacto mínimo na aplicação já desenvolvida.

O produto existe independentemente das empresas que o disponibilizam. Assim, o mesmo produto pode ser disponibilizado por várias empresas, sendo possível que cada uma pratique um preço de venda diferente.

A informação relativa à disponibilização de um produto por uma empresa não deve ser considerada parte das características intrínsecas do produto.

== Tipos de Produto ==

Todos os produtos considerados no sistema são fabricados, mas podem ter diferentes origens.

Inicialmente, consideram-se os seguintes tipos de produto:
* produto nacional;
* produto importado.

Um produto nacional possui apenas as propriedades gerais dos produtos.

Um produto importado possui, para além das propriedades gerais dos produtos:
* um país de origem (cadeia de caracteres não vazia);
* uma taxa alfandegária (número inteiro expressando uma percentagem);
* um prazo de transporte internacional (número inteiro de dias).

O preço recomendado é calculado de forma diferente consoante o tipo de produto.

Deve ser possível introduzir novos tipos de produto com impacto mínimo na implementação desenvolvida.

=== Produtos Nacionais ===

Para um produto nacional, o preço recomendado depende do preço base e do número total de unidades actualmente disponíveis desse produto nas empresas que o disponibilizam.

Se o número total de unidades disponíveis for:
* superior a 10000, o preço recomendado corresponde a 90% do preço base;
* inferior a 100, o preço recomendado corresponde a 130% do preço base;
* nos restantes casos, o preço recomendado corresponde ao preço base.

Por exemplo, considerando um produto nacional com preço base de 100 euros:
* Unidades disponíveis = 50 => Preço recomendado = 130 euros;
* Unidades disponíveis = 5000 => Preço recomendado = 100 euros;
* Unidades disponíveis = 12000 => Preço recomendado = 90 euros.

=== Produtos Importados ===

Para um produto importado, o preço recomendado corresponde ao preço base acrescido da taxa alfandegária.

Se a taxa alfandegária for '''t%''', o preço recomendado é calculado de acordo com:

'''preço base × (100 + t) / 100'''

Por exemplo, considerando um produto importado com preço base de 100 euros e uma taxa alfandegária de 20%, o preço recomendado será:

'''100 × (100 + 20) / 100 = 120 euros'''

O cálculo do preço recomendado deve ser realizado de forma polimórfica, de modo a que o código que utiliza produtos não tenha de conhecer explicitamente o tipo concreto de cada produto.

== Empresas ==

O sistema mantém um registo das empresas que operam na plataforma. Cada empresa é identificada por um número de empresa. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada empresa tem ainda um nome (cadeia de caracteres não vazia).

Uma empresa pode disponibilizar vários produtos e cada produto pode ser disponibilizado por várias empresas.

Para cada produto que disponibiliza, a empresa deve manter informação sobre:
* número de unidades disponíveis (valor inteiro);
* factor multiplicativo do preço recomendado (número positivo).

O número de unidades disponíveis e o factor multiplicativo podem ser diferentes para cada empresa que disponibiliza o mesmo produto.

O factor multiplicativo permite que uma empresa pratique um preço de venda diferente do preço recomendado pelo sistema. O preço de venda de um produto pela empresa é calculado multiplicando o preço recomendado do produto pelo factor multiplicativo definido pela empresa. Assim, duas empresas podem disponibilizar o mesmo produto a preços diferentes e com quantidades diferentes em stock.

Por exemplo, o produto P1, com um preço recomendado de 100 euros, pode ser disponibilizado pela empresa A com um preço de 90 euros, através de um factor multiplicativo de 0,9. A empresa B pode disponibilizar o mesmo produto com um preço de 120 euros, através de um factor multiplicativo de 1,2.

Deve ser possível adicionar outras propriedades às empresas sem impacto significativo no código já desenvolvido.

== Clientes ==

O sistema mantém um registo de clientes. Cada cliente é identificado por um número de cliente. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada cliente tem ainda informação sobre o seu nome e endereço de correio electrónico. Estes campos não podem ser vazios.

Assume-se que os clientes têm sempre dinheiro, i.e., uma compra nunca é recusada por falta de fundos.

== Compras ==

O sistema regista as compras efectuadas pelos clientes. Cada compra é identificada por um número de compra, atribuído automaticamente e incrementalmente. Uma compra é sempre feita por um único cliente a uma única empresa numa determinada data.

Uma compra é constituída por um conjunto de linhas (um "cabaz"). Cada linha corresponde a:
* um produto;
* uma quantidade (número de exemplares adquiridos desse produto);
* um preço unitário (o preço de venda do produto pela empresa no momento da compra);
* um preço total da linha (quantidade × preço unitário).

O preço unitário utilizado numa compra deve ser guardado na própria linha da compra. Alterações posteriores ao preço base, ao preço recomendado, ao factor multiplicativo da empresa, ou a qualquer outra propriedade utilizada no cálculo do preço, não devem alterar o valor de compras já efectuadas.

O preço total dos itens de uma compra é a soma dos preços totais das suas linhas. Uma compra pode dar origem a uma ou mais encomendas, de acordo com uma estratégia de divisão de encomendas.

A divisão de uma compra em várias encomendas pode ter impacto no custo total da compra.

== Cabaz de Compras ==

Antes de dar origem a uma compra, os produtos que um cliente pretende adquirir a uma empresa são acumulados num '''cabaz'''.

Cada cliente tem um cabaz por cada empresa em que compra. O cabaz é constituído por um conjunto de linhas; cada linha corresponde a um produto disponibilizado por essa empresa e a uma quantidade. Acrescentar ao cabaz um produto que já lá esteja acumula as quantidades.

O cabaz regista ainda as opções que serão aplicadas à compra:
* a [[#Divisão das Compras em Encomendas|estratégia de divisão em encomendas]]; * a [[#Transportadoras|transportadora]] e a [[#Transportadoras|modalidade de transporte]]; e
* o conjunto de [[#Serviços Adicionais|serviços adicionais]].

A transportadora, a modalidade e os serviços adicionais escolhidos aplicam-se a '''todas''' as encomendas resultantes da compra.

Enquanto não for finalizado, o cabaz não tem qualquer efeito no resto do sistema: em particular, não reserva nem consome inventário, e os preços apresentados são sempre os preços de venda praticados pela empresa '''nesse momento'''. Um cabaz faz parte do estado persistente da aplicação: pode ser abandonado e retomado mais tarde.

Ao '''finalizar''' o cabaz, e apenas nesse momento:
* os preços de venda são fixados nas linhas da compra;
* a compra é dividida em encomendas de acordo com a estratégia registada no cabaz;
* todas as encomendas recebem a modalidade de transporte e os serviços adicionais registados no cabaz;
* o inventário dos produtos na empresa é decrementado e o cliente é debitado;
* o cabaz fica vazio.

Um cabaz vazio não pode ser finalizado, nem o pode ser um cabaz em que ainda não tenham sido escolhidas transportadora e modalidade. Se, no momento de finalizar, a empresa já não tiver exemplares suficientes de algum dos produtos do cabaz (por exemplo, porque o inventário foi entretanto alterado), a operação falha sem qualquer efeito e o cabaz mantém-se intacto.

== Divisão das Compras em Encomendas ==

Cada encomenda tem um custo base de processamento e expedição, de '''5 euros'''. Assim, uma compra dividida em várias encomendas pode ter um custo superior ao de uma compra enviada numa única encomenda.

O custo base associado às encomendas corresponde ao número de encomendas multiplicado pelo custo base de uma encomenda.

A este custo podem acrescer os custos associados ao método de transporte seleccionado e aos serviços adicionais.

O custo total de uma compra corresponde, assim, ao custo dos produtos acrescido:
* do custo base das encomendas;
* dos custos adicionais das tarifas de transporte;
* dos custos dos serviços adicionais seleccionados.

A forma como uma compra é dividida em encomendas é determinada por uma estratégia de divisão de encomendas. Inicialmente, devem ser suportadas, pelo menos, as seguintes estratégias: encomenda única ('''UNICA''') e agrupamento por prazo de entrega ('''PRAZO''').

=== Encomenda única ===

Todos os produtos da compra são colocados numa única encomenda.

Neste caso, a compra origina uma única encomenda, independentemente dos prazos de entrega dos produtos.

=== Agrupamento por prazo de entrega ===

Os produtos são agrupados de acordo com os seus prazos de entrega.

Calcula-se a média dos prazos de entrega dos produtos das linhas da compra:
* todas as linhas cujo produto tem prazo menor ou igual à média são agrupadas numa única encomenda;
* cada linha cujo produto tem prazo estritamente maior do que a média é enviada separadamente, numa encomenda própria.

Por exemplo, considere-se uma compra com três linhas cujos produtos têm os prazos de entrega 3 (P1), 8 (P2) e 2 (P3). A média dos prazos é (3 + 8 + 2) / 3 ≈ 4,33. Logo, P1 e P3 (prazos ≤ 4,33) seguem juntos numa entrega e P2 (prazo > 4,33) segue numa outra encomenda:
* Encomenda A: {P1, P3} (prazo = 3)
* Encomenda B: {P2} (prazo = 8)

Uma estratégia de divisão que origina várias encomendas pode permitir que alguns produtos sejam entregues mais cedo, mas pode também resultar num custo superior devido ao custo associado a cada encomenda.

Deve ser possível introduzir novas estratégias de divisão de compras em encomendas com impacto mínimo na implementação desenvolvida.

== Transportadoras ==

O sistema mantém um registo das '''transportadoras''' que operam na plataforma. Cada transportadora é identificada por um número de transportadora. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada transportadora tem ainda um nome (cadeia de caracteres não vazia).

Cada encomenda é enviada através de uma transportadora, segundo uma '''modalidade de transporte'''. Inicialmente, devem ser suportadas, pelo menos, as seguintes modalidades: normal ('''NORMAL''') e expresso ('''EXPRESSO''').

Uma modalidade '''não''' define, por si só, qualquer custo ou prazo: é apenas o nome de um nível de serviço. Para cada modalidade que oferece, uma transportadora define uma '''tarifa''', constituída por:
* um custo adicional (número inteiro); e
* um tempo de transporte (número inteiro de dias).

Assim, a mesma modalidade pode custar e demorar valores diferentes consoante a transportadora.

Uma transportadora '''não tem de oferecer todas as modalidades''': oferece exactamente aquelas para as quais tenha uma tarifa definida. Pedir a uma transportadora uma modalidade que ela não oferece é um erro, e não uma escolha silenciosamente ignorada — ver [[#Definir modalidade de transporte|Definir modalidade de transporte]].

Entre os dois, '''a transportadora tem precedência sobre a modalidade''': como as modalidades disponíveis são as da transportadora, só se pode escolher uma modalidade depois de escolhida a transportadora, e mudar de transportadora anula a modalidade anteriormente escolhida (que passa a ser escolhida de novo, de entre as que a nova transportadora oferece).

Por exemplo:
{|
! style="background: #ebebeb;" | '''Transportadora'''
! style="background: #ebebeb;" | '''Modalidade'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo de transporte'''
|-
| CTT || '''NORMAL''' || 3 euros || 3 dias
|-
| CTT || '''EXPRESSO''' || 8 euros || 1 dia
|-
| DHL || '''NORMAL''' || 5 euros || 2 dias
|-
| DHL || '''EXPRESSO''' || 12 euros || 1 dia
|-
| SEUR || '''EXPRESSO''' || 10 euros || 1 dia
|}

No exemplo acima, a transportadora SEUR só oferece a modalidade expresso: não é possível enviar por SEUR em modalidade normal.

A transportadora e a modalidade são escolhidas no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda seja enviada por uma transportadora ou modalidade diferente.

A escolha da transportadora e da modalidade afecta tanto o custo como a data prevista de entrega da encomenda. Uma compra só pode ser finalizada depois de escolhidas ambas, e o par transportadora/modalidade de um cabaz é sempre um par que a transportadora oferece.

Deve ser possível introduzir novas modalidades de transporte com impacto mínimo na implementação desenvolvida. As transportadoras e as suas tarifas, por seu lado, fazem parte do estado da aplicação: são registadas pelo utilizador e não implicam qualquer alteração ao código.

== Serviços Adicionais ==

O cliente pode seleccionar serviços adicionais, podendo aumentar o custo de cada encomenda, assim como o tempo necessário para a sua preparação e entrega. Os serviços são escolhidos no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda tenha os seus próprios serviços.

Os serviços iniciais são os seguintes:
{|
! style="background: #ebebeb;" | '''Serviço'''
! style="background: #ebebeb;" | '''Chave'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo adicional'''
|-
| Embrulho || '''EMBRULHO''' || 2 euros || 1 dia
|-
| Cartão de oferta || '''CARTAO_OFERTA''' || 1 euro || 0 dias
|}

Os serviços adicionais podem ser combinados: uma encomenda pode incluir simultaneamente embrulho, cartão de oferta ou outro serviço adicional. O custo e o tempo adicionais de uma encomenda correspondem à soma dos contributos da modalidade de transporte e de todos os serviços seleccionados.

Deve ser possível introduzir novos serviços adicionais sem alterar o código das encomendas ou dos serviços já existentes.

== Entregas ==

Cada encomenda tem uma data prevista de entrega.
A data prevista de entrega é determinada considerando:
* a data da compra;
* os prazos de entrega dos produtos que constituem a encomenda;
* o tempo de transporte da tarifa da transportadora seleccionada;
* o tempo adicional introduzido pelos serviços seleccionados.

Para uma encomenda com vários produtos, o prazo dos produtos considerados para determinar a data prevista de entrega corresponde ao maior prazo de entrega dos seus produtos.

Não é necessário manter explicitamente um estado para representar se uma encomenda está ou não entregue. A situação da encomenda pode ser determinada a partir da data actual e da sua data prevista de entrega. Assim, uma encomenda é considerada entregue quando a data actual atinge ou ultrapassa a sua data prevista de entrega.

== Gestão de Tempo ==

A unidade de tempo do sistema é o dia. A data do sistema começa no dia 1 (um) e faz parte do estado persistente.

A data do sistema pode ser avançada. Sempre que a data é alterada, devem ser verificadas as encomendas existentes para determinar:
* quais as encomendas que serão entregues no dia seguinte;
* quais as encomendas cuja data prevista de entrega foi atingida ou ultrapassada.

Quando a data actual atinge ou ultrapassa a data prevista de entrega de uma encomenda, esta considera-se entregue.

A gestão do tempo deve ainda desencadear [[#Notificações|notificações]].

== Pesquisas ==

Para permitir que os clientes determinem a existência de um produto, deverá ser possível efectuar pesquisas.

As pesquisas consideram os campos relevantes dos vários produtos, por exemplo, nome, categoria, tipo de produto ou país de origem.

O termo de pesquisa deve ser comparado sem distinção entre letras maiúsculas e minúsculas.

O sistema deve suportar diferentes critérios de pesquisa. Por exemplo, uma pesquisa pode procurar produtos cujo nome contenha determinado termo ou produtos pertencentes a determinada categoria.

Deve ser possível introduzir novos métodos de pesquisa de produtos com impacto mínimo na implementação desenvolvida.

== Alterações de Inventário ==

O inventário de um produto numa empresa pode ser alterado através da especificação de um valor a somar ou subtrair ao número de exemplares disponíveis. Se a quantidade indicada for um valor positivo, aumenta-se o número de exemplares disponíveis.
Se a quantidade indicada for um valor negativo, decrementa-se o número de exemplares disponíveis, desde que o número de exemplares disponíveis não fique negativo.

Um produto não é removido do sistema quando o seu inventário numa empresa chega a zero.
Quando o inventário de um produto numa empresa chega a zero, o produto deixa de estar disponível nessa empresa, mas continua a existir no sistema e pode continuar a ser disponibilizado por outras empresas.
Se o inventário de um produto numa empresa passar de zero para um valor positivo, o produto volta a estar disponível nessa empresa.

O número total de unidades disponíveis de um produto corresponde à soma dos inventários desse produto em todas as empresas que o disponibilizam.

Esta informação é utilizada, nomeadamente, no cálculo do preço recomendado dos produtos nacionais.

== Notificações ==

O sistema deve notificar os clientes relativamente às suas encomendas.

Devem ser enviadas notificações em duas situações:
* um dia antes da data prevista de entrega, informando o cliente de que a encomenda será entregue no dia seguinte;
* no dia da entrega, informando o cliente de que a encomenda foi entregue.

Cada notificação deve ser enviada através do mecanismo de notificação seleccionado pelo cliente.
Inicialmente, devem ser suportados, pelo menos, os seguintes mecanismos:
* correio electrónico ('''EMAIL''');
* WhatsApp ('''WHATSAPP''').

Cada cliente pode escolher o mecanismo através do qual pretende receber notificações do sistema. O mecanismo de notificação pode variar de cliente para cliente. Por exemplo, um cliente pode receber notificações por correio electrónico, enquanto outro pode recebê-las através de WhatsApp.
Deve ser possível introduzir novos mecanismos de notificação sem necessidade de alterar o código dos clientes ou do sistema responsável por gerar as notificações.

Deve ser possível introduzir novos mecanismos de notificação com impacto mínimo na implementação desenvolvida.

As notificações devem ser enviadas pela ordem em que os acontecimentos ocorrem no sistema.

= Requisitos de Desenho =

A aplicação a desenvolver deve seguir o princípio de desenho aberto-fechado, por forma a aumentar a extensibilidade do seu código. Por exemplo, deve ser possível adicionar novos tipos de produto com um impacto mínimo no código já existente da aplicação.

Devem ser possíveis extensões ou alterações de funcionalidade com impacto mínimo no código já produzido para a aplicação. O objectivo é aumentar a flexibilidade da aplicação relativamente ao suporte de novas funções. Assim, deve ser possível:
* Adicionar novos tipos de produto (e.g., produtos digitais ou perecíveis), incluindo a respectiva regra de cálculo do preço recomendado; * Adicionar novas categorias de produto;
* Introduzir novas estratégias de divisão de compras em encomendas;
* Introduzir novas modalidades de transporte (os custos e prazos de cada uma são dados de cada transportadora, não código; nem todas as transportadoras têm de oferecer todas as modalidades);
* Introduzir novos serviços adicionais, sem alterar o código das encomendas nem o dos serviços já existentes;
* Introduzir novos mecanismos de notificação, sem alterar o código dos clientes nem o do sistema que gera as notificações;
* Introduzir novos critérios de discriminação/classificação dos clientes;
* Introduzir novos critérios de pesquisa de produtos.

= Funcionalidade da aplicação =

A aplicação permite manter informação sobre as entidades do modelo, permitindo, em particular, gerir empresas, produtos, clientes e compras. Possui ainda a capacidade de preservar o seu estado (não é possível manter várias versões do estado da aplicação em simultâneo).

Nenhuma entidade é removida pelas operações descritas neste enunciado (em particular, um produto cujo inventário numa empresa chegue a zero continua a existir no sistema). Ainda assim, a aplicação deve estar preparada para que a remoção de qualquer entidade possa vir a ser suportada.

No [[#Leitura de Dados a Partir de Ficheiros Textuais|início]], a aplicação está vazia, mas pode ser carregada uma base de dados textual com conceitos pré-definidos. Neste caso, a aplicação começará com um estado referente às entidades que foram carregadas no arranque da aplicação.

{{Suggestion|Note-se que não é necessário implementar de raiz a aplicação: já existem classes que representam e definem a interface geral da funcionalidade do ''core'' da aplicação, tal como é visível pelos comandos da aplicação.}}
{{CVSCode|A interface geral do ''core'' já está parcialmente implementada na classe '''erp.ErpManager''' e outras fornecidas (cujos nomes devem ser mantidos), devendo ser adaptadas onde necessário. É ainda necessário criar e implementar as restantes classes que suportam a operação da aplicação.}}

== Serialização ==

É possível guardar e recuperar o estado actual da aplicação, preservando toda a informação relacionada com o ERP e que foi descrita [[#Conceitos e Relações do Modelo|acima]].

Após a recuperação do estado, os identificadores atribuídos a novas entidades devem continuar a ser atribuídos incrementalmente a partir do último valor utilizado em cada caso.

= Interacção com o utilizador =

Descreve-se nesta secção a '''funcionalidade máxima''' da interface com o utilizador. Em geral, os comandos pedem toda a informação antes de procederem à sua validação (excepto onde indicado). Todos os menus têm automaticamente a opção '''Sair''' (fecha o menu).

As operações de pedido e apresentação de informação ao utilizador '''devem''' realizar-se através dos objectos ''form'' e ''display'', respectivamente, presentes em cada comando. As mensagens são produzidas pelos métodos das [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|bibliotecas de suporte]] ('''po-uilib''' e '''erp-app'''). As mensagens não podem ser usadas no núcleo da aplicação ('''erp-core'''). Além disso, não podem ser definidas novas. Potenciais omissões devem ser esclarecidas antes de qualquer implementação.

De um modo geral, sempre que no contexto de uma operação com o utilizador aconteça alguma excepção, então a operação não deve ter qualquer efeito no estado da aplicação, excepto em caso de indicação contrária na operação em causa. As excepções estão na package '''erp.app.exceptions''', excepto em caso de indicação contrária.

As excepções usadas na interacção (subclasses de '''pt.tecnico.uilib.menus.CommandException'''), excepto em caso de indicação contrária, são lançadas pelos comandos (subclasses de '''pt.tecnico.uilib.menus.Command''') e tratadas pelos menus (instâncias de subclasses de '''pt.tecnico.uilib.menus.Menu'''). Outras excepções não devem substituir as fornecidas nos casos descritos.

Nos pedidos e usos dos vários identificadores, podem ocorrer as seguintes excepções, caso o identificador indicado não corresponda a um objecto conhecido (excepto no processo de registo ou em caso de indicação contrária). Note-se que estas excepções não são utilizáveis no núcleo da aplicação.

{|
! style="background: #ebebeb;" | '''Tipo de dados'''
! style="background: #ebebeb;" | '''Classe'''
! style="background: #ebebeb;" | '''Pedido a apresentar'''
! style="background: #ebebeb;" | '''Excepção a lançar se desconhecido'''
|-
| Empresa
| '''Company'''
| '''erp.app.company.Prompt.companyId()'''
| '''erp.app.exceptions.UnknownCompanyKeyException'''
|-
| Produto
| '''Product'''
| '''erp.app.product.Prompt.productId()'''
| '''erp.app.exceptions.UnknownProductKeyException'''
|-
| Cliente
| '''Client'''
| '''erp.app.client.Prompt.clientId()'''
| '''erp.app.exceptions.UnknownClientKeyException'''
|-
| Transportadora
| '''Carrier'''
| '''erp.app.carrier.Prompt.carrierId()'''
| '''erp.app.exceptions.UnknownCarrierKeyException'''
|-
| Compra
| '''Purchase'''
| '''erp.app.purchase.Prompt.purchaseId()'''
| '''erp.app.exceptions.UnknownPurchaseKeyException'''
|}

Existe ainda um caso particular: sempre que uma operação se refira a um produto '''no contexto de uma empresa''' e essa empresa não disponibilize esse produto, deve ser lançada a excepção '''erp.app.exceptions.ProductNotSuppliedException''' (a empresa e o produto existem, mas não estão relacionados).

Alguns casos particulares podem usar pedidos específicos não apresentados nesta tabela.

Vários comandos pedem ao utilizador que escolha um valor de um conjunto fechado (tipo de produto, categoria, estratégia de divisão, modalidade de transporte, serviço adicional, mecanismo de notificação e critério de pesquisa). Estas escolhas '''devem''' ser pedidas através de campos de opção ('''Form.addOptionField()''' ou '''Form.requestOption()'''), sendo o conjunto de opções obtido do núcleo através da fachada. Desta forma, a introdução de uma nova estratégia, modalidade, serviço, mecanismo ou critério não implica qualquer alteração aos comandos.

{{CVSCode|Note-se que o programa principal e os comandos e menus, a seguir descritos, já estão parcial ou completamente implementados nas ''packages'' '''erp.app''', '''erp.app.main''', '''erp.app.company''', '''erp.app.product''', '''erp.app.client''', '''erp.app.purchase'''. Estas classes são de uso obrigatório e estão disponíveis no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|GIT]] (módulo '''erp-app''').}}

== Formatos de Apresentação ==

Os formatos usados pelos vários comandos são os seguintes. Todos os campos são separados por '''␣-␣'''.

{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma transportadora|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma tarifa|
''idTransportadora'' - ''modalidade'' - ''custo adicional'' - ''tempo de transporte''
}}

{{CollapsedCode|Formato de apresentação de um produto|
''id'' - ''tipo'' - ''nome'' - ''categoria'' - ''preço base'' - ''preço recomendado'' - ''prazo base'' - ''unidades totais'' - ''informação adicional''
}}

O ''tipo'' é '''NACIONAL''' ou '''IMPORTADO'''. As ''unidades totais'' correspondem à soma dos inventários do produto em todas as empresas que o disponibilizam. Para produtos nacionais não existe informação adicional; para produtos importados, a informação adicional corresponde ao país de origem, à taxa alfandegária e ao prazo de transporte internacional.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 173
2 - IMPORTADO - Telemovel - ELECTRONICA - 200 - 260 - 3 - 2 - China - 30 - 5
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 0
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação da disponibilização de um produto por uma empresa|
''idEmpresa'' - ''idProduto'' - ''unidades'' - ''factor'' - ''preço de venda''
}}

{{CollapsedCode|Exemplos de apresentação de disponibilizações|
<syntaxhighlight lang="text">
2 - 1 - 150 - 0.9 - 14
2 - 2 - 2 - 1.2 - 312
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''mecanismo de notificação'' - ''gasto total''
}}

O valor apresentado no fim corresponde ao total gasto pelo cliente em compras (um valor inteiro).

{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Ahsoka Tano - ahsoka@jedi.org - WHATSAPP - 0
1 - Obi-Wan Kenobi - obiwan@jedi.org - EMAIL - 124
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de uma compra|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
}}

{{CollapsedCode|Formato de apresentação (resumida) de uma encomenda|
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo'' - ''lista de identificadores de produtos''
}}

A ''descrição do transporte'' é o nome da transportadora e a modalidade seleccionadas, separados por '''/''', seguidos das chaves dos serviços adicionais seleccionados, separadas por '''+''' (por exemplo, '''DHL/ EXPRESSO+EMBRULHO+CARTAO_OFERTA'''). O ''custo'' de uma encomenda é o custo base de processamento acrescido do custo da modalidade e dos serviços.

{{CollapsedCode|Exemplos de apresentação de encomendas|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

== Menu Principal ==

As acções deste menu permitem gerir a salvaguarda do estado da aplicação e abrir submenus. A lista completa é a seguinte: [[#Salvaguarda do estado actual da aplicação|Abrir]], [[#Salvaguarda do estado actual da aplicação|Guardar]], [[#Mostrar data actual|Mostrar data actual]], [[#Avançar data actual|Avançar data actual]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Empresas]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Produtos]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Clientes]] e [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Compras]]. Inicialmente, a aplicação apenas tem informação sobre as entidades que foram carregadas no arranque.

{{CVSCode|As etiquetas das opções deste menu estão definidas na classe '''erp.app.main.Label'''. Todos os métodos correspondentes às mensagens de diálogo para este menu estão definidos na classe '''erp.app.main.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.main''', respectivamente: '''DoOpenFile''', '''DoSaveFile''', '''DoDisplayDate''', '''DoAdvanceDate''', '''DoOpenMenuCompanies''', '''DoOpenMenuProducts''', '''DoOpenMenuClients''', '''DoOpenMenuPurchases'''.}}

=== Salvaguarda do estado actual da aplicação ===

O conteúdo da aplicação (toda a informação detida pelo ERP actualmente em memória) pode ser guardado para posterior recuperação (via serialização Java: '''java.io.Serializable'''). Na leitura e escrita do estado da aplicação, devem ser tratadas as excepções associadas. A funcionalidade é a seguinte:

* '''Abrir''' -- Carrega os dados de uma sessão anterior a partir de um ficheiro previamente guardado (ficando este ficheiro associado à aplicação, para futuras operações de salvaguarda). Pede-se o nome do ficheiro a abrir ('''Prompt.openFile()'''). Caso ocorra um problema na abertura ou processamento do ficheiro, deve ser lançada a excepção '''FileOpenFailedException'''. A execução bem-sucedida desta opção substitui toda a informação da aplicação. Quando se abandona uma aplicação com modificações não guardadas (porque se abre outra e existem alterações não guardadas), deve perguntar-se ao utilizador se quer guardar a informação actual antes de a abandonar, através de '''Prompt.saveBeforeExit()''' (a resposta é obtida via '''Form.confirm()''').

* '''Guardar''' -- Guarda o estado actual da aplicação no ficheiro associado. Se não existir associação, pede-se o nome do ficheiro a utilizar, ficando a ele associado (para operações de salvaguarda subsequentes). Esta interacção realiza-se através do método '''Prompt.newSaveAs()'''. Não é executada nenhuma acção se não existirem alterações desde a última salvaguarda.

{{Suggestion|Note-se que a opção '''Abrir''' não permite a leitura de ficheiros de texto (estes apenas podem ser utilizados no início da aplicação).}}
{{Suggestion|A opção '''Sair''' nunca implica a salvaguarda do estado da aplicação, mesmo que existam alterações.}}

=== Mostrar data actual ===

A data actual do sistema é apresentada através da mensagem '''Message.currentDate()'''.

=== Avançar data actual ===

O número de dias a avançar é pedido através de '''Prompt.daysToAdvance()'''. O valor indicado deve ser positivo. Caso contrário, a operação não tem efeito.

Além da data, o sistema deve actualizar, caso seja necessário, outros aspectos que dela dependam, designadamente, a situação das entregas relativa às suas datas de chegada.

=== Gestão e consulta de dados da aplicação ===

* '''Menu de Gestão de Empresas''' -- Abre o menu de gestão de empresas e operações associadas.
* '''Menu de Gestão de Produtos''' -- Abre o menu de gestão de produtos e operações associadas.
* '''Menu de Gestão de Clientes''' -- Abre o menu de gestão de clientes e operações associadas.
* '''Menu de Gestão de Compras''' -- Abre o menu de gestão de compras e operações associadas.

== Menu de Gestão de Empresas ==

Este menu permite efectuar operações sobre a base de dados de empresas. A lista completa é a seguinte: [[#Registar empresa|Registar empresa]], [[#Mostrar empresa|Mostrar empresa]], [[#Mostrar empresas|Mostrar empresas]], [[#Mostrar produtos de uma empresa|Mostrar produtos de uma empresa]], [[#Mostrar clientes de uma empresa|Mostrar clientes de uma empresa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.company.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.company.Prompt''' e '''erp.app.company.Message'''.}}

=== Registar empresa ===

Pede o nome ('''Prompt.companyName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CompanyRegistrationFailedException'''.

Note-se que a atribuição do identificador da empresa é automática.

=== Mostrar empresa ===

É pedido o identificador da empresa, sendo apresentadas as informações sobre essa empresa, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

=== Mostrar empresas ===

Apresenta informações sobre todas as empresas, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar empresa|Mostrar empresa]].

=== Mostrar produtos de uma empresa ===

É pedido o identificador da empresa e apresentam-se os produtos que essa empresa vende, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar produto|Mostrar produto]].

=== Mostrar clientes de uma empresa ===

É pedido o identificador da empresa e apresentam-se os clientes que já interagiram com essa empresa, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar cliente|Mostrar cliente]].

== Menu de Gestão de Produtos ==

Este menu apresenta as operações disponíveis sobre produtos. A lista completa é a seguinte: [[#Mostrar produto|Mostrar produto]], [[#Mostrar produtos|Mostrar produtos]], [[#Alterar inventário de um produto|Alterar inventário de um produto]] e [[#Efectuar pesquisa|Efectuar pesquisa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.product.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.product.Prompt''' e '''erp.app.product.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.product''' (disponível no GIT), respectivamente: '''DoShowProduct''', '''DoShowProducts''', '''DoChangeProductInventory''', '''DoPerformSearch'''.}}

=== Mostrar produto ===

É pedido o identificador do produto. Se o produto existir, é apresentado de acordo com o seguinte formato. O formato genérico de apresentação de um produto é como se segue:
{{CollapsedCode|Formato de apresentação de produtos|
''id'' - ''stock'' - ''tipo'' - ''nome'' - ''preço'' - ''categoria'' - ''informação adicional''
}}

Para produtos fabricados, a informação adicional corresponde ao nome do fabricante e ao código de fabrico (separados pelo carácter ''';'''); para produtos importados, a informação adicional corresponde ao país de origem e à taxa alfandegária.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
3 - 20 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
4 - 2 - IMPORTADO - Telemóvel - 200 - ELECTRONICA - China - 30
5 - 0 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

=== Mostrar produtos ===

Apresenta informações sobre todos os produtos, ordenando-os pelos seus identificadores. O formato de apresentação é como descrito em [[#Mostrar produto|Mostrar produto]].

=== Alterar inventário de um produto ===

É pedido o identificador de um produto e uma quantidade ('''Prompt.amountToUpdate()''') e actualizado o número de exemplares disponíveis do produto indicado somando a quantidade indicada ao número de exemplares disponíveis. No caso de não ser possível actualizar o número de exemplares devido ao facto de a quantidade indicada ser inválida, então a operação não deve ter qualquer efeito e deve ser apresentada a mensagem '''Message.notEnoughInventory()'''.

=== Efectuar pesquisa ===

Esta opção realiza uma procura por termo (cadeia de caracteres), pedido através de '''Prompt.searchTerm()'''. Como resultado, deve ser apresentada uma lista dos produtos encontrados pela pesquisa, ordenados por ordem crescente do seu identificador, utilizando o formato descrito para [[#Mostrar produto|Mostrar produto]].

O termo de pesquisa deve ser comparado (sem distinção entre letras maiúsculas e minúsculas) com os campos relevantes de cada produto: o nome e a categoria. Só devem ser apresentados produtos que contenham o termo de pesquisa num dos campos relevantes. Caso não sejam encontrados produtos, não deve ser produzido qualquer resultado.

== Menu de Gestão de Clientes ==

Este menu permite efectuar operações sobre a base de dados de clientes. A lista completa é a seguinte: [[#Registar cliente|Registar cliente]], [[#Mostrar cliente|Mostrar cliente]], [[#Mostrar clientes|Mostrar clientes]], [[#Mostrar notificações do cliente|Mostrar notificações do cliente]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.client.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.client.Prompt''' e '''erp.app.client.Message'''.}}

=== Registar cliente ===

Pede o nome ('''Prompt.clientName()''') e o endereço de correio electrónico ('''Prompt.clientEMail()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''ClientRegistrationFailedException'''.

Note-se que a atribuição do identificador do cliente é automática e que clientes diferentes são registados em cada operação de registo.

=== Mostrar cliente ===

É pedido o identificador do cliente, sendo apresentadas as informações sobre esse cliente, de acordo com o seguinte formato. O valor apresentado após o email corresponde ao total gasto pelo cliente em compras (um valor inteiro).
{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''gasto total''
}}
{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Alberto Meireles - ameireles@mymail.com - 275
1 - Fernando Meireles - fmeireles@mymail.com - 0
</syntaxhighlight>
}}

=== Mostrar clientes ===

Apresenta informações sobre todos os clientes, ordenando-os lexicograficamente pelo nome. Caso existam clientes com o mesmo nome, devem ser ordenados por ordem crescente dos seus identificadores. O formato é o descrito em [[#Mostrar cliente|Mostrar cliente]].

=== Mostrar notificações do cliente ===

É pedido o identificador do cliente, sendo apresentadas as notificações para esse cliente, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação das notificações de um cliente|
DISPONIBILIDADE: ''descrição de produto disponível''
}}
{{CollapsedCode|Exemplos de notificações|
<syntaxhighlight lang="text">
DISPONIBILIDADE: 5 - 4 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

Note-se que a descrição é idêntica à que é realizada para mostrar cada produto. No entanto, a solução deve ser suficientemente flexível para permitir outros formatos de apresentação das notificações (sem impacto no código do domínio da aplicação).

== Menu de Gestão de Compras ==

Este menu apresenta as operações relacionadas com compras e entregas. A lista completa é a seguinte: [[#Efectuar compra|Efectuar compra]], [[#Mostrar compra|Mostrar compra]], [[#Mostrar compras|Mostrar compras]], [[#Mostrar entregas de uma compra|Mostrar entregas de uma compra]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.purchase.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.purchase.Prompt''' e '''erp.app.purchase.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.purchase''' (disponível no GIT), respectivamente: '''DoDoPurchase''', '''DoShowPurchase''', '''DoShowPurchases''', '''DoShowPurchaseDeliveries'''.}}

=== Efectuar compra ===

No processo de efectuar uma compra, o sistema pede, primeiro, a identificação do cliente; de seguida, a identificação da empresa a que a compra é feita; e, finalmente, para cada linha, o identificador do produto e a quantidade pretendida ('''Prompt.productId()''' e '''Prompt.amountToBuy()'''). O processo de adição de linhas termina de acordo com a interacção definida no comando.

Se não houver exemplares suficientes de um produto para satisfazer a quantidade pretendida, deve ser apresentada a mensagem '''Message.notEnoughInventory()''' e essa linha não é adicionada. Concluída a compra, o ''stock'' dos produtos é decrementado, a empresa passa a seguir o cliente e são determinadas as entregas correspondentes. A data limite de chegada de cada entrega é comunicada através da mensagem '''Message.deliveryDate()'''.

=== Mostrar compra ===

É pedido o identificador da compra. Na primeira linha apresenta-se a informação da compra; de seguida, apresentam-se as suas entregas '''em detalhe''' — cada entrega (identificador da compra e data de chegada) seguida da descrição completa de cada um dos seus produtos (o mesmo formato de [[#Mostrar produto|Mostrar produto]]). O formato é o seguinte:
{{CollapsedCode|Formato de apresentação de uma compra (com entregas em detalhe)|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''sobretaxa de entrega'' - ''preço total''
''idCompra'' - ''data de chegada''
''descrição de produto''
...
}}
{{CollapsedCode|Exemplos de apresentação de compras|
<syntaxhighlight lang="text">
7 - 3 - 1 - 4 - 90 - 9 - 99
7 - 7
1 - 18 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
3 - 2 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
7 - 12
2 - 1 - IMPORTADO - Telemovel - 200 - ELECTRONICA - China - 30
</syntaxhighlight>
}}

=== Mostrar compras ===

Apresenta informações sobre todas as compras, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar compra|Mostrar compra]].

=== Mostrar entregas de uma compra ===

É pedido o identificador da compra e são apresentadas as entregas correspondentes, ordenadas pela data de chegada e, em caso de empate, pelos identificadores dos produtos. Ao contrário de [[#Mostrar compra|Mostrar compra]] (que apresenta as entregas em detalhe), aqui cada entrega é apresentada '''de forma resumida''' (uma linha, apenas com os identificadores dos produtos), de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma entrega|
''idCompra'' - ''data de chegada'' - ''lista de identificadores de produtos''
}}
{{CollapsedCode|Exemplos de apresentação de entregas (compra do exemplo da secção Entregas)|
<syntaxhighlight lang="text">
7 - 7 - 1, 3
7 - 12 - 2
</syntaxhighlight>
}}

= Leitura de Dados a Partir de Ficheiros Textuais =

Além das opções de manipulação de ficheiros descritas no [[#Menu Principal|menu principal]], é possível iniciar a aplicação com um ficheiro de texto especificado pela propriedade Java '''[[#Execução do Programa e Testes Automáticos|import]]'''.

Cada linha tem uma descrição distinta mas que segue o seguinte formato geral. É possível registar transportadoras, empresas, clientes e produtos, e definir as tarifas das transportadoras e as disponibilizações de produtos por parte das empresas. Assume-se que os campos de texto não podem conter o carácter ''':''' e que os preços são números inteiros. Não existem entradas mal-formadas.

O registo de transportadoras, e das tarifas que cada uma pratica, segue os formatos:
CARRIER:''nome''
RATE:''idTransportadora'':''modalidade'':''custo'':''dias''

As entradas '''RATE''' referem transportadoras já registadas em linhas anteriores. O registo de empresas e de clientes segue os formatos:
COMPANY:''nome''
CLIENT:''nome'':''email''
CLIENT:''nome'':''email'':''mecanismo''

O ''mecanismo'' é '''EMAIL''' ou '''WHATSAPP'''; se for omitido, assume-se '''EMAIL'''. Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:

Os produtos são registados no registo global, respectivamente para produtos nacionais e importados:
NATIONAL:''nome'':''preçoBase'':''categoria'':''prazo''
IMPORTED:''nome'':''preçoBase'':''categoria'':''prazo'':''paisOrigem'':''taxa'':''prazoInternacional''

Note-se que o registo de um produto não indica qualquer empresa nem qualquer inventário: essas são propriedades da disponibilização, descrita por entradas próprias, em que ''unidades'' é o número de exemplares que a empresa tem disponíveis e ''factor'' o multiplicador (real) que aplica ao preço recomendado:
SUPPLY:''idEmpresa'':''idProduto'':''unidades'':''factor''

As entradas '''SUPPLY''' referem empresas e produtos já registados em linhas anteriores.

Um exemplo de conteúdo do ficheiro inicial é como se segue:
{{CollapsedCode|Exemplo de ficheiro de entrada textual|
<syntaxhighlight lang="text">
CARRIER:CTT
RATE:1:NORMAL:3:3
RATE:1:EXPRESSO:8:1
CARRIER:DHL
RATE:2:NORMAL:5:2
RATE:2:EXPRESSO:12:1
CARRIER:SEUR
RATE:3:EXPRESSO:10:1
COMPANY:Moageira Nacional
COMPANY:Importadora Atlantico
CLIENT:Obi-Wan Kenobi:obiwan@jedi.org
CLIENT:Ahsoka Tano:ahsoka@jedi.org:WHATSAPP
NATIONAL:Farinha:15:ALIMENTAR:3
IMPORTED:Telemovel:200:ELECTRONICA:3:China:30:5
NATIONAL:Camisa:45:VESTUARIO:2
SUPPLY:1:1:23:1.0
SUPPLY:2:1:150:0.9
SUPPLY:2:2:2:1.2
SUPPLY:1:3:4:1.1
</syntaxhighlight>
}}

A codificação dos ficheiros a ler é garantidamente [[wp:UTF-8|UTF-8]].

{{Suggestion|Os métodos '''String.split()''', para partir cadeias de caracteres, e '''String.trim()''', para remover espaços no início e no final, podem ser usados no processamento de cada linha.}}
{{Suggestion|Note-se que o programa nunca produz ficheiros com este formato (é apenas um formato para ficheiros de entrada).}}

= Execução do Programa e Testes Automáticos =

Usando os ficheiros '''test.import''', '''test.in''' e '''test.out''', é possível verificar automaticamente o resultado correcto do programa. Note-se que é necessária a definição apropriada da variável '''CLASSPATH''' (ou da opção equivalente '''-cp''' do comando '''java'''), para localizar as classes do programa, incluindo a que contém o método correspondente ao ponto de entrada da aplicação ('''erp.app.App.main'''). As propriedades são tratadas automaticamente pelo código de apoio.

java -Dimport=test.import -Din=test.in -Dout=test.outhyp erp.app.App

Assumindo que aqueles ficheiros estão no directório onde é dado o comando de execução, o programa produz o ficheiro de saída '''test.outhyp'''. Em caso de sucesso, os ficheiros das saídas esperada ('''test.out''') e obtida ('''test.outhyp''') devem ser iguais. A comparação pode ser feita com o comando:

diff -b test.out test.outhyp

Este comando não deve produzir qualquer resultado quando os ficheiros são iguais. Note-se, contudo, que este teste não garante o correcto funcionamento do código desenvolvido, apenas verificando alguns aspectos da sua funcionalidade.

= Notas de Implementação =

Tal como indicado acima, algumas classes fornecidas como [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|material de apoio]], são de uso obrigatório e não podem ser alteradas. Outras dessas classes são de uso obrigatório e têm de ser alteradas.

A serialização Java usa as classes da ''package'' [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/package-summary.html java.io], em particular, a interface [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/Serializable.html java.io.Serializable] e as classes de leitura [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectInputStream.html java.io.ObjectInputStream] e escrita [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectOutputStream.html java.io.ObjectOutputStream] (entre outras).

[[category: Ensino]]
[[category:PO]]
[[category: Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T13:05:58Z

Root: /* Interacção com o utilizador */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

'''EM PREPARAÇÃO'''

'''ÉPOCA NORMAL'''

O objectivo do projecto é desenvolver um sistema de gestão de entregas rápidas de produtos (ERP — Express Retail Platform). O sistema deverá permitir, entre outras operações, (i) registar dados de empresas; (ii) registar dados de clientes; (iii) registar, gerir e pesquisar produtos; (iv) efectuar e gerir características de compras; (v) gerir as entregas correspondentes; e (vi) notificar os clientes sobre a situação das suas encomendas.

Neste texto, o tipo '''negrito''' indica um literal (i.e., é exactamente como apresentado); o símbolo ␣ indica um espaço; e o tipo ''itálico'' indica uma parte variável (i.e., uma descrição).

= Conceitos e Relações do Modelo =

Existem vários conceitos importantes neste contexto: [[#Empresas|empresas]], [[#Produtos|produtos]], [[#Clientes|clientes]], [[#Transportadoras|transportadoras]], [[#Cabaz de Compras|cabazes]], [[#Compras|compras]], [[#Divisão das Compras em Encomendas|encomendas]] e [[#Entregas|entregas]].

Os conceitos listados não são os únicos possíveis no modelo e as suas relações (assim como relações com outros conceitos não mencionados) podem depender das escolhas do projecto.

Os clientes e os produtos são independentes das empresas: existem por si e podem relacionar-se com várias empresas. Cada empresa, no entanto, mantém registo dos clientes com quem interage, dos produtos que disponibiliza, das compras feitas e das encomendas que expede.

Uma compra representa a aquisição de produtos por um cliente a uma empresa, e resulta de finalizar um [[#Cabaz de Compras|cabaz]]. Uma compra pode dar origem a uma ou mais encomendas, de acordo com a estratégia de divisão de encomendas utilizada.

Cada encomenda pode ser enviada através de uma determinada transportadora e pode incluir serviços adicionais que alteram o seu custo e/ou prazo de entrega.

== Produtos ==

O sistema mantém um registo global de produtos. Cada produto é identificado por um número de produto. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Todos os produtos têm: um nome/descrição (cadeia de caracteres não vazia); um preço base (número inteiro positivo); uma categoria; e um prazo de entrega base (número inteiro de dias).

O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O sistema utiliza o preço base para calcular o preço recomendado do produto. O preço recomendado representa o valor de referência do produto no sistema. O seu cálculo pode depender do tipo de produto e de outras informações disponíveis no sistema.

Cada produto tem uma categoria, de acordo com a sua natureza. Inicialmente, consideram-se as seguintes categorias: (i) alimentar; (ii) electrónica; e (iii) vestuário. Deve ser possível adicionar novas categorias com impacto mínimo na aplicação já desenvolvida.

O produto existe independentemente das empresas que o disponibilizam. Assim, o mesmo produto pode ser disponibilizado por várias empresas, sendo possível que cada uma pratique um preço de venda diferente.

A informação relativa à disponibilização de um produto por uma empresa não deve ser considerada parte das características intrínsecas do produto.

== Tipos de Produto ==

Todos os produtos considerados no sistema são fabricados, mas podem ter diferentes origens.

Inicialmente, consideram-se os seguintes tipos de produto:
* produto nacional;
* produto importado.

Um produto nacional possui apenas as propriedades gerais dos produtos.

Um produto importado possui, para além das propriedades gerais dos produtos:
* um país de origem (cadeia de caracteres não vazia);
* uma taxa alfandegária (número inteiro expressando uma percentagem);
* um prazo de transporte internacional (número inteiro de dias).

O preço recomendado é calculado de forma diferente consoante o tipo de produto.

Deve ser possível introduzir novos tipos de produto com impacto mínimo na implementação desenvolvida.

=== Produtos Nacionais ===

Para um produto nacional, o preço recomendado depende do preço base e do número total de unidades actualmente disponíveis desse produto nas empresas que o disponibilizam.

Se o número total de unidades disponíveis for:
* superior a 10000, o preço recomendado corresponde a 90% do preço base;
* inferior a 100, o preço recomendado corresponde a 130% do preço base;
* nos restantes casos, o preço recomendado corresponde ao preço base.

Por exemplo, considerando um produto nacional com preço base de 100 euros:
* Unidades disponíveis = 50 => Preço recomendado = 130 euros;
* Unidades disponíveis = 5000 => Preço recomendado = 100 euros;
* Unidades disponíveis = 12000 => Preço recomendado = 90 euros.

=== Produtos Importados ===

Para um produto importado, o preço recomendado corresponde ao preço base acrescido da taxa alfandegária.

Se a taxa alfandegária for '''t%''', o preço recomendado é calculado de acordo com:

'''preço base × (100 + t) / 100'''

Por exemplo, considerando um produto importado com preço base de 100 euros e uma taxa alfandegária de 20%, o preço recomendado será:

'''100 × (100 + 20) / 100 = 120 euros'''

O cálculo do preço recomendado deve ser realizado de forma polimórfica, de modo a que o código que utiliza produtos não tenha de conhecer explicitamente o tipo concreto de cada produto.

== Empresas ==

O sistema mantém um registo das empresas que operam na plataforma. Cada empresa é identificada por um número de empresa. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada empresa tem ainda um nome (cadeia de caracteres não vazia).

Uma empresa pode disponibilizar vários produtos e cada produto pode ser disponibilizado por várias empresas.

Para cada produto que disponibiliza, a empresa deve manter informação sobre:
* número de unidades disponíveis (valor inteiro);
* factor multiplicativo do preço recomendado (número positivo).

O número de unidades disponíveis e o factor multiplicativo podem ser diferentes para cada empresa que disponibiliza o mesmo produto.

O factor multiplicativo permite que uma empresa pratique um preço de venda diferente do preço recomendado pelo sistema. O preço de venda de um produto pela empresa é calculado multiplicando o preço recomendado do produto pelo factor multiplicativo definido pela empresa. Assim, duas empresas podem disponibilizar o mesmo produto a preços diferentes e com quantidades diferentes em stock.

Por exemplo, o produto P1, com um preço recomendado de 100 euros, pode ser disponibilizado pela empresa A com um preço de 90 euros, através de um factor multiplicativo de 0,9. A empresa B pode disponibilizar o mesmo produto com um preço de 120 euros, através de um factor multiplicativo de 1,2.

Deve ser possível adicionar outras propriedades às empresas sem impacto significativo no código já desenvolvido.

== Clientes ==

O sistema mantém um registo de clientes. Cada cliente é identificado por um número de cliente. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada cliente tem ainda informação sobre o seu nome e endereço de correio electrónico. Estes campos não podem ser vazios.

Assume-se que os clientes têm sempre dinheiro, i.e., uma compra nunca é recusada por falta de fundos.

== Compras ==

O sistema regista as compras efectuadas pelos clientes. Cada compra é identificada por um número de compra, atribuído automaticamente e incrementalmente. Uma compra é sempre feita por um único cliente a uma única empresa numa determinada data.

Uma compra é constituída por um conjunto de linhas (um "cabaz"). Cada linha corresponde a:
* um produto;
* uma quantidade (número de exemplares adquiridos desse produto);
* um preço unitário (o preço de venda do produto pela empresa no momento da compra);
* um preço total da linha (quantidade × preço unitário).

O preço unitário utilizado numa compra deve ser guardado na própria linha da compra. Alterações posteriores ao preço base, ao preço recomendado, ao factor multiplicativo da empresa, ou a qualquer outra propriedade utilizada no cálculo do preço, não devem alterar o valor de compras já efectuadas.

O preço total dos itens de uma compra é a soma dos preços totais das suas linhas. Uma compra pode dar origem a uma ou mais encomendas, de acordo com uma estratégia de divisão de encomendas.

A divisão de uma compra em várias encomendas pode ter impacto no custo total da compra.

== Cabaz de Compras ==

Antes de dar origem a uma compra, os produtos que um cliente pretende adquirir a uma empresa são acumulados num '''cabaz'''.

Cada cliente tem um cabaz por cada empresa em que compra. O cabaz é constituído por um conjunto de linhas; cada linha corresponde a um produto disponibilizado por essa empresa e a uma quantidade. Acrescentar ao cabaz um produto que já lá esteja acumula as quantidades.

O cabaz regista ainda as opções que serão aplicadas à compra:
* a [[#Divisão das Compras em Encomendas|estratégia de divisão em encomendas]]; * a [[#Transportadoras|transportadora]] e a [[#Transportadoras|modalidade de transporte]]; e
* o conjunto de [[#Serviços Adicionais|serviços adicionais]].

A transportadora, a modalidade e os serviços adicionais escolhidos aplicam-se a '''todas''' as encomendas resultantes da compra.

Enquanto não for finalizado, o cabaz não tem qualquer efeito no resto do sistema: em particular, não reserva nem consome inventário, e os preços apresentados são sempre os preços de venda praticados pela empresa '''nesse momento'''. Um cabaz faz parte do estado persistente da aplicação: pode ser abandonado e retomado mais tarde.

Ao '''finalizar''' o cabaz, e apenas nesse momento:
* os preços de venda são fixados nas linhas da compra;
* a compra é dividida em encomendas de acordo com a estratégia registada no cabaz;
* todas as encomendas recebem a modalidade de transporte e os serviços adicionais registados no cabaz;
* o inventário dos produtos na empresa é decrementado e o cliente é debitado;
* o cabaz fica vazio.

Um cabaz vazio não pode ser finalizado, nem o pode ser um cabaz em que ainda não tenham sido escolhidas transportadora e modalidade. Se, no momento de finalizar, a empresa já não tiver exemplares suficientes de algum dos produtos do cabaz (por exemplo, porque o inventário foi entretanto alterado), a operação falha sem qualquer efeito e o cabaz mantém-se intacto.

== Divisão das Compras em Encomendas ==

Cada encomenda tem um custo base de processamento e expedição, de '''5 euros'''. Assim, uma compra dividida em várias encomendas pode ter um custo superior ao de uma compra enviada numa única encomenda.

O custo base associado às encomendas corresponde ao número de encomendas multiplicado pelo custo base de uma encomenda.

A este custo podem acrescer os custos associados ao método de transporte seleccionado e aos serviços adicionais.

O custo total de uma compra corresponde, assim, ao custo dos produtos acrescido:
* do custo base das encomendas;
* dos custos adicionais das tarifas de transporte;
* dos custos dos serviços adicionais seleccionados.

A forma como uma compra é dividida em encomendas é determinada por uma estratégia de divisão de encomendas. Inicialmente, devem ser suportadas, pelo menos, as seguintes estratégias: encomenda única ('''UNICA''') e agrupamento por prazo de entrega ('''PRAZO''').

=== Encomenda única ===

Todos os produtos da compra são colocados numa única encomenda.

Neste caso, a compra origina uma única encomenda, independentemente dos prazos de entrega dos produtos.

=== Agrupamento por prazo de entrega ===

Os produtos são agrupados de acordo com os seus prazos de entrega.

Calcula-se a média dos prazos de entrega dos produtos das linhas da compra:
* todas as linhas cujo produto tem prazo menor ou igual à média são agrupadas numa única encomenda;
* cada linha cujo produto tem prazo estritamente maior do que a média é enviada separadamente, numa encomenda própria.

Por exemplo, considere-se uma compra com três linhas cujos produtos têm os prazos de entrega 3 (P1), 8 (P2) e 2 (P3). A média dos prazos é (3 + 8 + 2) / 3 ≈ 4,33. Logo, P1 e P3 (prazos ≤ 4,33) seguem juntos numa entrega e P2 (prazo > 4,33) segue numa outra encomenda:
* Encomenda A: {P1, P3} (prazo = 3)
* Encomenda B: {P2} (prazo = 8)

Uma estratégia de divisão que origina várias encomendas pode permitir que alguns produtos sejam entregues mais cedo, mas pode também resultar num custo superior devido ao custo associado a cada encomenda.

Deve ser possível introduzir novas estratégias de divisão de compras em encomendas com impacto mínimo na implementação desenvolvida.

== Transportadoras ==

O sistema mantém um registo das '''transportadoras''' que operam na plataforma. Cada transportadora é identificada por um número de transportadora. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada transportadora tem ainda um nome (cadeia de caracteres não vazia).

Cada encomenda é enviada através de uma transportadora, segundo uma '''modalidade de transporte'''. Inicialmente, devem ser suportadas, pelo menos, as seguintes modalidades: normal ('''NORMAL''') e expresso ('''EXPRESSO''').

Uma modalidade '''não''' define, por si só, qualquer custo ou prazo: é apenas o nome de um nível de serviço. Para cada modalidade que oferece, uma transportadora define uma '''tarifa''', constituída por:
* um custo adicional (número inteiro); e
* um tempo de transporte (número inteiro de dias).

Assim, a mesma modalidade pode custar e demorar valores diferentes consoante a transportadora.

Uma transportadora '''não tem de oferecer todas as modalidades''': oferece exactamente aquelas para as quais tenha uma tarifa definida. Pedir a uma transportadora uma modalidade que ela não oferece é um erro, e não uma escolha silenciosamente ignorada — ver [[#Definir modalidade de transporte|Definir modalidade de transporte]].

Entre os dois, '''a transportadora tem precedência sobre a modalidade''': como as modalidades disponíveis são as da transportadora, só se pode escolher uma modalidade depois de escolhida a transportadora, e mudar de transportadora anula a modalidade anteriormente escolhida (que passa a ser escolhida de novo, de entre as que a nova transportadora oferece).

Por exemplo:
{|
! style="background: #ebebeb;" | '''Transportadora'''
! style="background: #ebebeb;" | '''Modalidade'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo de transporte'''
|-
| CTT || '''NORMAL''' || 3 euros || 3 dias
|-
| CTT || '''EXPRESSO''' || 8 euros || 1 dia
|-
| DHL || '''NORMAL''' || 5 euros || 2 dias
|-
| DHL || '''EXPRESSO''' || 12 euros || 1 dia
|-
| SEUR || '''EXPRESSO''' || 10 euros || 1 dia
|}

No exemplo acima, a transportadora SEUR só oferece a modalidade expresso: não é possível enviar por SEUR em modalidade normal.

A transportadora e a modalidade são escolhidas no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda seja enviada por uma transportadora ou modalidade diferente.

A escolha da transportadora e da modalidade afecta tanto o custo como a data prevista de entrega da encomenda. Uma compra só pode ser finalizada depois de escolhidas ambas, e o par transportadora/modalidade de um cabaz é sempre um par que a transportadora oferece.

Deve ser possível introduzir novas modalidades de transporte com impacto mínimo na implementação desenvolvida. As transportadoras e as suas tarifas, por seu lado, fazem parte do estado da aplicação: são registadas pelo utilizador e não implicam qualquer alteração ao código.

== Serviços Adicionais ==

O cliente pode seleccionar serviços adicionais, podendo aumentar o custo de cada encomenda, assim como o tempo necessário para a sua preparação e entrega. Os serviços são escolhidos no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda tenha os seus próprios serviços.

Os serviços iniciais são os seguintes:
{|
! style="background: #ebebeb;" | '''Serviço'''
! style="background: #ebebeb;" | '''Chave'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo adicional'''
|-
| Embrulho || '''EMBRULHO''' || 2 euros || 1 dia
|-
| Cartão de oferta || '''CARTAO_OFERTA''' || 1 euro || 0 dias
|}

Os serviços adicionais podem ser combinados: uma encomenda pode incluir simultaneamente embrulho, cartão de oferta ou outro serviço adicional. O custo e o tempo adicionais de uma encomenda correspondem à soma dos contributos da modalidade de transporte e de todos os serviços seleccionados.

Deve ser possível introduzir novos serviços adicionais sem alterar o código das encomendas ou dos serviços já existentes.

== Entregas ==

Cada encomenda tem uma data prevista de entrega.
A data prevista de entrega é determinada considerando:
* a data da compra;
* os prazos de entrega dos produtos que constituem a encomenda;
* o tempo de transporte da tarifa da transportadora seleccionada;
* o tempo adicional introduzido pelos serviços seleccionados.

Para uma encomenda com vários produtos, o prazo dos produtos considerados para determinar a data prevista de entrega corresponde ao maior prazo de entrega dos seus produtos.

Não é necessário manter explicitamente um estado para representar se uma encomenda está ou não entregue. A situação da encomenda pode ser determinada a partir da data actual e da sua data prevista de entrega. Assim, uma encomenda é considerada entregue quando a data actual atinge ou ultrapassa a sua data prevista de entrega.

== Gestão de Tempo ==

A unidade de tempo do sistema é o dia. A data do sistema começa no dia 1 (um) e faz parte do estado persistente.

A data do sistema pode ser avançada. Sempre que a data é alterada, devem ser verificadas as encomendas existentes para determinar:
* quais as encomendas que serão entregues no dia seguinte;
* quais as encomendas cuja data prevista de entrega foi atingida ou ultrapassada.

Quando a data actual atinge ou ultrapassa a data prevista de entrega de uma encomenda, esta considera-se entregue.

A gestão do tempo deve ainda desencadear [[#Notificações|notificações]].

== Pesquisas ==

Para permitir que os clientes determinem a existência de um produto, deverá ser possível efectuar pesquisas.

As pesquisas consideram os campos relevantes dos vários produtos, por exemplo, nome, categoria, tipo de produto ou país de origem.

O termo de pesquisa deve ser comparado sem distinção entre letras maiúsculas e minúsculas.

O sistema deve suportar diferentes critérios de pesquisa. Por exemplo, uma pesquisa pode procurar produtos cujo nome contenha determinado termo ou produtos pertencentes a determinada categoria.

Deve ser possível introduzir novos métodos de pesquisa de produtos com impacto mínimo na implementação desenvolvida.

== Alterações de Inventário ==

O inventário de um produto numa empresa pode ser alterado através da especificação de um valor a somar ou subtrair ao número de exemplares disponíveis. Se a quantidade indicada for um valor positivo, aumenta-se o número de exemplares disponíveis.
Se a quantidade indicada for um valor negativo, decrementa-se o número de exemplares disponíveis, desde que o número de exemplares disponíveis não fique negativo.

Um produto não é removido do sistema quando o seu inventário numa empresa chega a zero.
Quando o inventário de um produto numa empresa chega a zero, o produto deixa de estar disponível nessa empresa, mas continua a existir no sistema e pode continuar a ser disponibilizado por outras empresas.
Se o inventário de um produto numa empresa passar de zero para um valor positivo, o produto volta a estar disponível nessa empresa.

O número total de unidades disponíveis de um produto corresponde à soma dos inventários desse produto em todas as empresas que o disponibilizam.

Esta informação é utilizada, nomeadamente, no cálculo do preço recomendado dos produtos nacionais.

== Notificações ==

O sistema deve notificar os clientes relativamente às suas encomendas.

Devem ser enviadas notificações em duas situações:
* um dia antes da data prevista de entrega, informando o cliente de que a encomenda será entregue no dia seguinte;
* no dia da entrega, informando o cliente de que a encomenda foi entregue.

Cada notificação deve ser enviada através do mecanismo de notificação seleccionado pelo cliente.
Inicialmente, devem ser suportados, pelo menos, os seguintes mecanismos:
* correio electrónico ('''EMAIL''');
* WhatsApp ('''WHATSAPP''').

Cada cliente pode escolher o mecanismo através do qual pretende receber notificações do sistema. O mecanismo de notificação pode variar de cliente para cliente. Por exemplo, um cliente pode receber notificações por correio electrónico, enquanto outro pode recebê-las através de WhatsApp.
Deve ser possível introduzir novos mecanismos de notificação sem necessidade de alterar o código dos clientes ou do sistema responsável por gerar as notificações.

Deve ser possível introduzir novos mecanismos de notificação com impacto mínimo na implementação desenvolvida.

As notificações devem ser enviadas pela ordem em que os acontecimentos ocorrem no sistema.

= Requisitos de Desenho =

A aplicação a desenvolver deve seguir o princípio de desenho aberto-fechado, por forma a aumentar a extensibilidade do seu código. Por exemplo, deve ser possível adicionar novos tipos de produto com um impacto mínimo no código já existente da aplicação.

Devem ser possíveis extensões ou alterações de funcionalidade com impacto mínimo no código já produzido para a aplicação. O objectivo é aumentar a flexibilidade da aplicação relativamente ao suporte de novas funções. Assim, deve ser possível:
* Adicionar novos tipos de produto (e.g., produtos digitais ou perecíveis), incluindo a respectiva regra de cálculo do preço recomendado; * Adicionar novas categorias de produto;
* Introduzir novas estratégias de divisão de compras em encomendas;
* Introduzir novas modalidades de transporte (os custos e prazos de cada uma são dados de cada transportadora, não código; nem todas as transportadoras têm de oferecer todas as modalidades);
* Introduzir novos serviços adicionais, sem alterar o código das encomendas nem o dos serviços já existentes;
* Introduzir novos mecanismos de notificação, sem alterar o código dos clientes nem o do sistema que gera as notificações;
* Introduzir novos critérios de discriminação/classificação dos clientes;
* Introduzir novos critérios de pesquisa de produtos.

= Funcionalidade da aplicação =

A aplicação permite manter informação sobre as entidades do modelo, permitindo, em particular, gerir empresas, produtos, clientes e compras. Possui ainda a capacidade de preservar o seu estado (não é possível manter várias versões do estado da aplicação em simultâneo).

Nenhuma entidade é removida pelas operações descritas neste enunciado (em particular, um produto cujo inventário numa empresa chegue a zero continua a existir no sistema). Ainda assim, a aplicação deve estar preparada para que a remoção de qualquer entidade possa vir a ser suportada.

No [[#Leitura de Dados a Partir de Ficheiros Textuais|início]], a aplicação está vazia, mas pode ser carregada uma base de dados textual com conceitos pré-definidos. Neste caso, a aplicação começará com um estado referente às entidades que foram carregadas no arranque da aplicação.

{{Suggestion|Note-se que não é necessário implementar de raiz a aplicação: já existem classes que representam e definem a interface geral da funcionalidade do ''core'' da aplicação, tal como é visível pelos comandos da aplicação.}}
{{CVSCode|A interface geral do ''core'' já está parcialmente implementada na classe '''erp.ErpManager''' e outras fornecidas (cujos nomes devem ser mantidos), devendo ser adaptadas onde necessário. É ainda necessário criar e implementar as restantes classes que suportam a operação da aplicação.}}

== Serialização ==

É possível guardar e recuperar o estado actual da aplicação, preservando toda a informação relacionada com o ERP e que foi descrita [[#Conceitos e Relações do Modelo|acima]].

Após a recuperação do estado, os identificadores atribuídos a novas entidades devem continuar a ser atribuídos incrementalmente a partir do último valor utilizado em cada caso.

= Interacção com o utilizador =

Descreve-se nesta secção a '''funcionalidade máxima''' da interface com o utilizador. Em geral, os comandos pedem toda a informação antes de procederem à sua validação (excepto onde indicado). Todos os menus têm automaticamente a opção '''Sair''' (fecha o menu).

As operações de pedido e apresentação de informação ao utilizador '''devem''' realizar-se através dos objectos ''form'' e ''display'', respectivamente, presentes em cada comando. As mensagens são produzidas pelos métodos das [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|bibliotecas de suporte]] ('''po-uilib''' e '''erp-app'''). As mensagens não podem ser usadas no núcleo da aplicação ('''erp-core'''). Além disso, não podem ser definidas novas. Potenciais omissões devem ser esclarecidas antes de qualquer implementação.

De um modo geral, sempre que no contexto de uma operação com o utilizador aconteça alguma excepção, então a operação não deve ter qualquer efeito no estado da aplicação, excepto em caso de indicação contrária na operação em causa. As excepções estão na package '''erp.app.exceptions''', excepto em caso de indicação contrária.

As excepções usadas na interacção (subclasses de '''pt.tecnico.uilib.menus.CommandException'''), excepto em caso de indicação contrária, são lançadas pelos comandos (subclasses de '''pt.tecnico.uilib.menus.Command''') e tratadas pelos menus (instâncias de subclasses de '''pt.tecnico.uilib.menus.Menu'''). Outras excepções não devem substituir as fornecidas nos casos descritos.

Nos pedidos e usos dos vários identificadores, podem ocorrer as seguintes excepções, caso o identificador indicado não corresponda a um objecto conhecido (excepto no processo de registo ou em caso de indicação contrária). Note-se que estas excepções não são utilizáveis no núcleo da aplicação.

{|
! style="background: #ebebeb;" | '''Tipo de dados'''
! style="background: #ebebeb;" | '''Classe'''
! style="background: #ebebeb;" | '''Pedido a apresentar'''
! style="background: #ebebeb;" | '''Excepção a lançar se desconhecido'''
|-
| Empresa
| '''Company'''
| '''erp.app.company.Prompt.companyId()'''
| '''erp.app.exceptions.UnknownCompanyKeyException'''
|-
| Produto
| '''Product'''
| '''erp.app.product.Prompt.productId()'''
| '''erp.app.exceptions.UnknownProductKeyException'''
|-
| Cliente
| '''Client'''
| '''erp.app.client.Prompt.clientId()'''
| '''erp.app.exceptions.UnknownClientKeyException'''
|-
| Transportadora
| '''Carrier'''
| '''erp.app.carrier.Prompt.carrierId()'''
| '''erp.app.exceptions.UnknownCarrierKeyException'''
|-
| Compra
| '''Purchase'''
| '''erp.app.purchase.Prompt.purchaseId()'''
| '''erp.app.exceptions.UnknownPurchaseKeyException'''
|}

Existe ainda um caso particular: sempre que uma operação se refira a um produto '''no contexto de uma empresa''' e essa empresa não disponibilize esse produto, deve ser lançada a excepção '''erp.app.exceptions.ProductNotSuppliedException''' (a empresa e o produto existem, mas não estão relacionados).

Alguns casos particulares podem usar pedidos específicos não apresentados nesta tabela.

Vários comandos pedem ao utilizador que escolha um valor de um conjunto fechado (tipo de produto, categoria, estratégia de divisão, modalidade de transporte, serviço adicional, mecanismo de notificação e critério de pesquisa). Estas escolhas '''devem''' ser pedidas através de campos de opção ('''Form.addOptionField()''' ou '''Form.requestOption()'''), sendo o conjunto de opções obtido do núcleo através da fachada. Desta forma, a introdução de uma nova estratégia, modalidade, serviço, mecanismo ou critério não implica qualquer alteração aos comandos.

{{CVSCode|Note-se que o programa principal e os comandos e menus, a seguir descritos, já estão parcial ou completamente implementados nas ''packages'' '''erp.app''', '''erp.app.main''', '''erp.app.company''', '''erp.app.product''', '''erp.app.client''', '''erp.app.purchase'''. Estas classes são de uso obrigatório e estão disponíveis no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|GIT]] (módulo '''erp-app''').}}

== Formatos de Apresentação ==

Os formatos usados pelos vários comandos são os seguintes. Todos os campos são separados por '''␣-␣'''.

{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma transportadora|
''id'' - ''nome''
}}

{{CollapsedCode|Formato de apresentação de uma tarifa|
''idTransportadora'' - ''modalidade'' - ''custo adicional'' - ''tempo de transporte''
}}

{{CollapsedCode|Formato de apresentação de um produto|
''id'' - ''tipo'' - ''nome'' - ''categoria'' - ''preço base'' - ''preço recomendado'' - ''prazo base'' - ''unidades totais'' - ''informação adicional''
}}

O ''tipo'' é '''NACIONAL''' ou '''IMPORTADO'''. As ''unidades totais'' correspondem à soma dos inventários do produto em todas as empresas que o disponibilizam. Para produtos nacionais não existe informação adicional; para produtos importados, a informação adicional corresponde ao país de origem, à taxa alfandegária e ao prazo de transporte internacional.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
1 - NACIONAL - Farinha - ALIMENTAR - 15 - 15 - 3 - 173
2 - IMPORTADO - Telemovel - ELECTRONICA - 200 - 260 - 3 - 2 - China - 30 - 5
3 - NACIONAL - Camisa - VESTUARIO - 45 - 58 - 2 - 0
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação da disponibilização de um produto por uma empresa|
''idEmpresa'' - ''idProduto'' - ''unidades'' - ''factor'' - ''preço de venda''
}}

{{CollapsedCode|Exemplos de apresentação de disponibilizações|
<syntaxhighlight lang="text">
2 - 1 - 150 - 0.9 - 14
2 - 2 - 2 - 1.2 - 312
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''mecanismo de notificação'' - ''gasto total''
}}

O valor apresentado no fim corresponde ao total gasto pelo cliente em compras (um valor inteiro).

{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Ahsoka Tano - ahsoka@jedi.org - WHATSAPP - 0
1 - Obi-Wan Kenobi - obiwan@jedi.org - EMAIL - 124
</syntaxhighlight>
}}

{{CollapsedCode|Formato de apresentação de uma compra|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''custo das encomendas'' - ''custo total''
}}

{{CollapsedCode|Formato de apresentação (resumida) de uma encomenda|
''idCompra'' - ''descrição do transporte'' - ''data prevista de entrega'' - ''custo'' - ''lista de identificadores de produtos''
}}

A ''descrição do transporte'' é o nome da transportadora e a modalidade seleccionadas, separados por '''/''', seguidos das chaves dos serviços adicionais seleccionados, separadas por '''+''' (por exemplo, '''DHL/ EXPRESSO+EMBRULHO+CARTAO_OFERTA'''). O ''custo'' de uma encomenda é o custo base de processamento acrescido do custo da modalidade e dos serviços.

{{CollapsedCode|Exemplos de apresentação de encomendas|
<syntaxhighlight lang="text">
1 - CTT/EXPRESSO+EMBRULHO - 5 - 15 - 3
1 - CTT/EXPRESSO+EMBRULHO - 6 - 15 - 1
</syntaxhighlight>
}}

== Menu Principal ==

As acções deste menu permitem gerir a salvaguarda do estado da aplicação e abrir submenus. A lista completa é a seguinte: [[#Salvaguarda do estado actual da aplicação|Abrir]], [[#Salvaguarda do estado actual da aplicação|Guardar]], [[#Mostrar data actual|Mostrar data actual]], [[#Avançar data actual|Avançar data actual]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Empresas]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Produtos]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Clientes]] e [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Compras]]. Inicialmente, a aplicação apenas tem informação sobre as entidades que foram carregadas no arranque.

{{CVSCode|As etiquetas das opções deste menu estão definidas na classe '''erp.app.main.Label'''. Todos os métodos correspondentes às mensagens de diálogo para este menu estão definidos na classe '''erp.app.main.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.main''', respectivamente: '''DoOpenFile''', '''DoSaveFile''', '''DoDisplayDate''', '''DoAdvanceDate''', '''DoOpenMenuCompanies''', '''DoOpenMenuProducts''', '''DoOpenMenuClients''', '''DoOpenMenuPurchases'''.}}

=== Salvaguarda do estado actual da aplicação ===

O conteúdo da aplicação (toda a informação detida pelo ERP actualmente em memória) pode ser guardado para posterior recuperação (via serialização Java: '''java.io.Serializable'''). Na leitura e escrita do estado da aplicação, devem ser tratadas as excepções associadas. A funcionalidade é a seguinte:

* '''Abrir''' -- Carrega os dados de uma sessão anterior a partir de um ficheiro previamente guardado (ficando este ficheiro associado à aplicação, para futuras operações de salvaguarda). Pede-se o nome do ficheiro a abrir ('''Prompt.openFile()'''). Caso ocorra um problema na abertura ou processamento do ficheiro, deve ser lançada a excepção '''FileOpenFailedException'''. A execução bem-sucedida desta opção substitui toda a informação da aplicação. Quando se abandona uma aplicação com modificações não guardadas (porque se abre outra e existem alterações não guardadas), deve perguntar-se ao utilizador se quer guardar a informação actual antes de a abandonar, através de '''Prompt.saveBeforeExit()''' (a resposta é obtida via '''Form.confirm()''').

* '''Guardar''' -- Guarda o estado actual da aplicação no ficheiro associado. Se não existir associação, pede-se o nome do ficheiro a utilizar, ficando a ele associado (para operações de salvaguarda subsequentes). Esta interacção realiza-se através do método '''Prompt.newSaveAs()'''. Não é executada nenhuma acção se não existirem alterações desde a última salvaguarda.

{{Suggestion|Note-se que a opção '''Abrir''' não permite a leitura de ficheiros de texto (estes apenas podem ser utilizados no início da aplicação).}}
{{Suggestion|A opção '''Sair''' nunca implica a salvaguarda do estado da aplicação, mesmo que existam alterações.}}

=== Mostrar data actual ===

A data actual do sistema é apresentada através da mensagem '''Message.currentDate()'''.

=== Avançar data actual ===

O número de dias a avançar é pedido através de '''Prompt.daysToAdvance()'''. O valor indicado deve ser positivo. Caso contrário, a operação não tem efeito.

Além da data, o sistema deve actualizar, caso seja necessário, outros aspectos que dela dependam, designadamente, a situação das entregas relativa às suas datas de chegada.

=== Gestão e consulta de dados da aplicação ===

* '''Menu de Gestão de Empresas''' -- Abre o menu de gestão de empresas e operações associadas.
* '''Menu de Gestão de Produtos''' -- Abre o menu de gestão de produtos e operações associadas.
* '''Menu de Gestão de Clientes''' -- Abre o menu de gestão de clientes e operações associadas.
* '''Menu de Gestão de Compras''' -- Abre o menu de gestão de compras e operações associadas.

== Menu de Gestão de Empresas ==

Este menu permite efectuar operações sobre a base de dados de empresas. A lista completa é a seguinte: [[#Registar empresa|Registar empresa]], [[#Mostrar empresa|Mostrar empresa]], [[#Mostrar empresas|Mostrar empresas]], [[#Mostrar produtos de uma empresa|Mostrar produtos de uma empresa]], [[#Mostrar clientes de uma empresa|Mostrar clientes de uma empresa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.company.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.company.Prompt''' e '''erp.app.company.Message'''.}}

=== Registar empresa ===

Pede o nome ('''Prompt.companyName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CompanyRegistrationFailedException'''.

Note-se que a atribuição do identificador da empresa é automática.

=== Mostrar empresa ===

É pedido o identificador da empresa, sendo apresentadas as informações sobre essa empresa, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

=== Mostrar empresas ===

Apresenta informações sobre todas as empresas, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar empresa|Mostrar empresa]].

=== Mostrar produtos de uma empresa ===

É pedido o identificador da empresa e apresentam-se os produtos que essa empresa vende, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar produto|Mostrar produto]].

=== Mostrar clientes de uma empresa ===

É pedido o identificador da empresa e apresentam-se os clientes que já interagiram com essa empresa, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar cliente|Mostrar cliente]].

== Menu de Gestão de Produtos ==

Este menu apresenta as operações disponíveis sobre produtos. A lista completa é a seguinte: [[#Mostrar produto|Mostrar produto]], [[#Mostrar produtos|Mostrar produtos]], [[#Alterar inventário de um produto|Alterar inventário de um produto]] e [[#Efectuar pesquisa|Efectuar pesquisa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.product.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.product.Prompt''' e '''erp.app.product.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.product''' (disponível no GIT), respectivamente: '''DoShowProduct''', '''DoShowProducts''', '''DoChangeProductInventory''', '''DoPerformSearch'''.}}

=== Mostrar produto ===

É pedido o identificador do produto. Se o produto existir, é apresentado de acordo com o seguinte formato. O formato genérico de apresentação de um produto é como se segue:
{{CollapsedCode|Formato de apresentação de produtos|
''id'' - ''stock'' - ''tipo'' - ''nome'' - ''preço'' - ''categoria'' - ''informação adicional''
}}

Para produtos fabricados, a informação adicional corresponde ao nome do fabricante e ao código de fabrico (separados pelo carácter ''';'''); para produtos importados, a informação adicional corresponde ao país de origem e à taxa alfandegária.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
3 - 20 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
4 - 2 - IMPORTADO - Telemóvel - 200 - ELECTRONICA - China - 30
5 - 0 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

=== Mostrar produtos ===

Apresenta informações sobre todos os produtos, ordenando-os pelos seus identificadores. O formato de apresentação é como descrito em [[#Mostrar produto|Mostrar produto]].

=== Alterar inventário de um produto ===

É pedido o identificador de um produto e uma quantidade ('''Prompt.amountToUpdate()''') e actualizado o número de exemplares disponíveis do produto indicado somando a quantidade indicada ao número de exemplares disponíveis. No caso de não ser possível actualizar o número de exemplares devido ao facto de a quantidade indicada ser inválida, então a operação não deve ter qualquer efeito e deve ser apresentada a mensagem '''Message.notEnoughInventory()'''.

=== Efectuar pesquisa ===

Esta opção realiza uma procura por termo (cadeia de caracteres), pedido através de '''Prompt.searchTerm()'''. Como resultado, deve ser apresentada uma lista dos produtos encontrados pela pesquisa, ordenados por ordem crescente do seu identificador, utilizando o formato descrito para [[#Mostrar produto|Mostrar produto]].

O termo de pesquisa deve ser comparado (sem distinção entre letras maiúsculas e minúsculas) com os campos relevantes de cada produto: o nome e a categoria. Só devem ser apresentados produtos que contenham o termo de pesquisa num dos campos relevantes. Caso não sejam encontrados produtos, não deve ser produzido qualquer resultado.

== Menu de Gestão de Clientes ==

Este menu permite efectuar operações sobre a base de dados de clientes. A lista completa é a seguinte: [[#Registar cliente|Registar cliente]], [[#Mostrar cliente|Mostrar cliente]], [[#Mostrar clientes|Mostrar clientes]], [[#Mostrar notificações do cliente|Mostrar notificações do cliente]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.client.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.client.Prompt''' e '''erp.app.client.Message'''.}}

=== Registar cliente ===

Pede o nome ('''Prompt.clientName()''') e o endereço de correio electrónico ('''Prompt.clientEMail()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''ClientRegistrationFailedException'''.

Note-se que a atribuição do identificador do cliente é automática e que clientes diferentes são registados em cada operação de registo.

=== Mostrar cliente ===

É pedido o identificador do cliente, sendo apresentadas as informações sobre esse cliente, de acordo com o seguinte formato. O valor apresentado após o email corresponde ao total gasto pelo cliente em compras (um valor inteiro).
{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''gasto total''
}}
{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Alberto Meireles - ameireles@mymail.com - 275
1 - Fernando Meireles - fmeireles@mymail.com - 0
</syntaxhighlight>
}}

=== Mostrar clientes ===

Apresenta informações sobre todos os clientes, ordenando-os lexicograficamente pelo nome. Caso existam clientes com o mesmo nome, devem ser ordenados por ordem crescente dos seus identificadores. O formato é o descrito em [[#Mostrar cliente|Mostrar cliente]].

=== Mostrar notificações do cliente ===

É pedido o identificador do cliente, sendo apresentadas as notificações para esse cliente, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação das notificações de um cliente|
DISPONIBILIDADE: ''descrição de produto disponível''
}}
{{CollapsedCode|Exemplos de notificações|
<syntaxhighlight lang="text">
DISPONIBILIDADE: 5 - 4 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

Note-se que a descrição é idêntica à que é realizada para mostrar cada produto. No entanto, a solução deve ser suficientemente flexível para permitir outros formatos de apresentação das notificações (sem impacto no código do domínio da aplicação).

== Menu de Gestão de Compras ==

Este menu apresenta as operações relacionadas com compras e entregas. A lista completa é a seguinte: [[#Efectuar compra|Efectuar compra]], [[#Mostrar compra|Mostrar compra]], [[#Mostrar compras|Mostrar compras]], [[#Mostrar entregas de uma compra|Mostrar entregas de uma compra]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.purchase.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.purchase.Prompt''' e '''erp.app.purchase.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.purchase''' (disponível no GIT), respectivamente: '''DoDoPurchase''', '''DoShowPurchase''', '''DoShowPurchases''', '''DoShowPurchaseDeliveries'''.}}

=== Efectuar compra ===

No processo de efectuar uma compra, o sistema pede, primeiro, a identificação do cliente; de seguida, a identificação da empresa a que a compra é feita; e, finalmente, para cada linha, o identificador do produto e a quantidade pretendida ('''Prompt.productId()''' e '''Prompt.amountToBuy()'''). O processo de adição de linhas termina de acordo com a interacção definida no comando.

Se não houver exemplares suficientes de um produto para satisfazer a quantidade pretendida, deve ser apresentada a mensagem '''Message.notEnoughInventory()''' e essa linha não é adicionada. Concluída a compra, o ''stock'' dos produtos é decrementado, a empresa passa a seguir o cliente e são determinadas as entregas correspondentes. A data limite de chegada de cada entrega é comunicada através da mensagem '''Message.deliveryDate()'''.

=== Mostrar compra ===

É pedido o identificador da compra. Na primeira linha apresenta-se a informação da compra; de seguida, apresentam-se as suas entregas '''em detalhe''' — cada entrega (identificador da compra e data de chegada) seguida da descrição completa de cada um dos seus produtos (o mesmo formato de [[#Mostrar produto|Mostrar produto]]). O formato é o seguinte:
{{CollapsedCode|Formato de apresentação de uma compra (com entregas em detalhe)|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''sobretaxa de entrega'' - ''preço total''
''idCompra'' - ''data de chegada''
''descrição de produto''
...
}}
{{CollapsedCode|Exemplos de apresentação de compras|
<syntaxhighlight lang="text">
7 - 3 - 1 - 4 - 90 - 9 - 99
7 - 7
1 - 18 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
3 - 2 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
7 - 12
2 - 1 - IMPORTADO - Telemovel - 200 - ELECTRONICA - China - 30
</syntaxhighlight>
}}

=== Mostrar compras ===

Apresenta informações sobre todas as compras, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar compra|Mostrar compra]].

=== Mostrar entregas de uma compra ===

É pedido o identificador da compra e são apresentadas as entregas correspondentes, ordenadas pela data de chegada e, em caso de empate, pelos identificadores dos produtos. Ao contrário de [[#Mostrar compra|Mostrar compra]] (que apresenta as entregas em detalhe), aqui cada entrega é apresentada '''de forma resumida''' (uma linha, apenas com os identificadores dos produtos), de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma entrega|
''idCompra'' - ''data de chegada'' - ''lista de identificadores de produtos''
}}
{{CollapsedCode|Exemplos de apresentação de entregas (compra do exemplo da secção Entregas)|
<syntaxhighlight lang="text">
7 - 7 - 1, 3
7 - 12 - 2
</syntaxhighlight>
}}

= Leitura de Dados a Partir de Ficheiros Textuais =

Além das opções de manipulação de ficheiros descritas no [[#Menu Principal|menu principal]], é possível iniciar a aplicação com um ficheiro de texto especificado pela propriedade Java '''[[#Execução do Programa e Testes Automáticos|import]]'''.

Cada linha tem uma descrição distinta mas que segue o seguinte formato geral. É possível registar empresas, clientes e produtos, e definir os produtos que cada empresa vende. Assume-se que os campos de texto não podem conter o carácter ''':''' e que os preços são números inteiros. Não existem entradas mal-formadas.

Os produtos têm o formato descrito abaixo, respectivamente, para produtos fabricados e importados. O campo ''stock'' indica o número de exemplares disponíveis do produto.

MANUFACTURED:''idEmpresa'':''nome'':''preço'':''categoria'':''prazo'':''stock'':''fabricante'':''codigo''
IMPORTED:''idEmpresa'':''nome'':''preço'':''categoria'':''prazo'':''stock'':''paisOrigem'':''taxa''

O registo de empresas e de clientes segue os formatos:

COMPANY:''nome''
CLIENT:''nome'':''email''

Um exemplo de conteúdo do ficheiro inicial é como se segue:

{{CollapsedCode|Exemplo de ficheiro de entrada textual|
<syntaxhighlight lang="text">
COMPANY:Moageira Nacional
COMPANY:Importadora Atlantico
CLIENT:Obi-Wan Kenobi:obiwan@jedi.org
MANUFACTURED:1:Farinha:15:ALIMENTAR:3:23:Moageira Nacional:F-0091
IMPORTED:2:Telemovel:200:ELECTRONICA:8:2:China:30
MANUFACTURED:1:Camisa:45:VESTUARIO:2:4:Confeccoes Sul:C-1120
</syntaxhighlight>
}}
A codificação dos ficheiros a ler é garantidamente [[wp:UTF-8|UTF-8]].

{{Suggestion|Os métodos '''String.split()''', para partir cadeias de caracteres, e '''String.trim()''', para remover espaços no início e no final, podem ser usados no processamento de cada linha.}}
{{Suggestion|Note-se que o programa nunca produz ficheiros com este formato (é apenas um formato para ficheiros de entrada).}}

= Execução do Programa e Testes Automáticos =

Usando os ficheiros '''test.import''', '''test.in''' e '''test.out''', é possível verificar automaticamente o resultado correcto do programa. Note-se que é necessária a definição apropriada da variável '''CLASSPATH''' (ou da opção equivalente '''-cp''' do comando '''java'''), para localizar as classes do programa, incluindo a que contém o método correspondente ao ponto de entrada da aplicação ('''erp.app.App.main'''). As propriedades são tratadas automaticamente pelo código de apoio.

java -Dimport=test.import -Din=test.in -Dout=test.outhyp erp.app.App

Assumindo que aqueles ficheiros estão no directório onde é dado o comando de execução, o programa produz o ficheiro de saída '''test.outhyp'''. Em caso de sucesso, os ficheiros das saídas esperada ('''test.out''') e obtida ('''test.outhyp''') devem ser iguais. A comparação pode ser feita com o comando:

diff -b test.out test.outhyp

Este comando não deve produzir qualquer resultado quando os ficheiros são iguais. Note-se, contudo, que este teste não garante o correcto funcionamento do código desenvolvido, apenas verificando alguns aspectos da sua funcionalidade.

= Notas de Implementação =

Tal como indicado acima, algumas classes fornecidas como [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|material de apoio]], são de uso obrigatório e não podem ser alteradas. Outras dessas classes são de uso obrigatório e têm de ser alteradas.

A serialização Java usa as classes da ''package'' [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/package-summary.html java.io], em particular, a interface [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/Serializable.html java.io.Serializable] e as classes de leitura [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectInputStream.html java.io.ObjectInputStream] e escrita [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectOutputStream.html java.io.ObjectOutputStream] (entre outras).

[[category: Ensino]]
[[category:PO]]
[[category: Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T12:50:37Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

'''EM PREPARAÇÃO'''

'''ÉPOCA NORMAL'''

O objectivo do projecto é desenvolver um sistema de gestão de entregas rápidas de produtos (ERP — Express Retail Platform). O sistema deverá permitir, entre outras operações, (i) registar dados de empresas; (ii) registar dados de clientes; (iii) registar, gerir e pesquisar produtos; (iv) efectuar e gerir características de compras; (v) gerir as entregas correspondentes; e (vi) notificar os clientes sobre a situação das suas encomendas.

Neste texto, o tipo '''negrito''' indica um literal (i.e., é exactamente como apresentado); o símbolo ␣ indica um espaço; e o tipo ''itálico'' indica uma parte variável (i.e., uma descrição).

= Conceitos e Relações do Modelo =

Existem vários conceitos importantes neste contexto: [[#Empresas|empresas]], [[#Produtos|produtos]], [[#Clientes|clientes]], [[#Transportadoras|transportadoras]], [[#Cabaz de Compras|cabazes]], [[#Compras|compras]], [[#Divisão das Compras em Encomendas|encomendas]] e [[#Entregas|entregas]].

Os conceitos listados não são os únicos possíveis no modelo e as suas relações (assim como relações com outros conceitos não mencionados) podem depender das escolhas do projecto.

Os clientes e os produtos são independentes das empresas: existem por si e podem relacionar-se com várias empresas. Cada empresa, no entanto, mantém registo dos clientes com quem interage, dos produtos que disponibiliza, das compras feitas e das encomendas que expede.

Uma compra representa a aquisição de produtos por um cliente a uma empresa, e resulta de finalizar um [[#Cabaz de Compras|cabaz]]. Uma compra pode dar origem a uma ou mais encomendas, de acordo com a estratégia de divisão de encomendas utilizada.

Cada encomenda pode ser enviada através de uma determinada transportadora e pode incluir serviços adicionais que alteram o seu custo e/ou prazo de entrega.

== Produtos ==

O sistema mantém um registo global de produtos. Cada produto é identificado por um número de produto. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Todos os produtos têm: um nome/descrição (cadeia de caracteres não vazia); um preço base (número inteiro positivo); uma categoria; e um prazo de entrega base (número inteiro de dias).

O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.
O sistema utiliza o preço base para calcular o preço recomendado do produto. O preço recomendado representa o valor de referência do produto no sistema. O seu cálculo pode depender do tipo de produto e de outras informações disponíveis no sistema.

Cada produto tem uma categoria, de acordo com a sua natureza. Inicialmente, consideram-se as seguintes categorias: (i) alimentar; (ii) electrónica; e (iii) vestuário. Deve ser possível adicionar novas categorias com impacto mínimo na aplicação já desenvolvida.

O produto existe independentemente das empresas que o disponibilizam. Assim, o mesmo produto pode ser disponibilizado por várias empresas, sendo possível que cada uma pratique um preço de venda diferente.

A informação relativa à disponibilização de um produto por uma empresa não deve ser considerada parte das características intrínsecas do produto.

== Tipos de Produto ==

Todos os produtos considerados no sistema são fabricados, mas podem ter diferentes origens.

Inicialmente, consideram-se os seguintes tipos de produto:
* produto nacional;
* produto importado.

Um produto nacional possui apenas as propriedades gerais dos produtos.

Um produto importado possui, para além das propriedades gerais dos produtos:
* um país de origem (cadeia de caracteres não vazia);
* uma taxa alfandegária (número inteiro expressando uma percentagem);
* um prazo de transporte internacional (número inteiro de dias).

O preço recomendado é calculado de forma diferente consoante o tipo de produto.

Deve ser possível introduzir novos tipos de produto com impacto mínimo na implementação desenvolvida.

=== Produtos Nacionais ===

Para um produto nacional, o preço recomendado depende do preço base e do número total de unidades actualmente disponíveis desse produto nas empresas que o disponibilizam.

Se o número total de unidades disponíveis for:
* superior a 10000, o preço recomendado corresponde a 90% do preço base;
* inferior a 100, o preço recomendado corresponde a 130% do preço base;
* nos restantes casos, o preço recomendado corresponde ao preço base.

Por exemplo, considerando um produto nacional com preço base de 100 euros:
* Unidades disponíveis = 50 => Preço recomendado = 130 euros;
* Unidades disponíveis = 5000 => Preço recomendado = 100 euros;
* Unidades disponíveis = 12000 => Preço recomendado = 90 euros.

=== Produtos Importados ===

Para um produto importado, o preço recomendado corresponde ao preço base acrescido da taxa alfandegária.

Se a taxa alfandegária for '''t%''', o preço recomendado é calculado de acordo com:

'''preço base × (100 + t) / 100'''

Por exemplo, considerando um produto importado com preço base de 100 euros e uma taxa alfandegária de 20%, o preço recomendado será:

'''100 × (100 + 20) / 100 = 120 euros'''

O cálculo do preço recomendado deve ser realizado de forma polimórfica, de modo a que o código que utiliza produtos não tenha de conhecer explicitamente o tipo concreto de cada produto.

== Empresas ==

O sistema mantém um registo das empresas que operam na plataforma. Cada empresa é identificada por um número de empresa. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada empresa tem ainda um nome (cadeia de caracteres não vazia).

Uma empresa pode disponibilizar vários produtos e cada produto pode ser disponibilizado por várias empresas.

Para cada produto que disponibiliza, a empresa deve manter informação sobre:
* número de unidades disponíveis (valor inteiro);
* factor multiplicativo do preço recomendado (número positivo).

O número de unidades disponíveis e o factor multiplicativo podem ser diferentes para cada empresa que disponibiliza o mesmo produto.

O factor multiplicativo permite que uma empresa pratique um preço de venda diferente do preço recomendado pelo sistema. O preço de venda de um produto pela empresa é calculado multiplicando o preço recomendado do produto pelo factor multiplicativo definido pela empresa. Assim, duas empresas podem disponibilizar o mesmo produto a preços diferentes e com quantidades diferentes em stock.

Por exemplo, o produto P1, com um preço recomendado de 100 euros, pode ser disponibilizado pela empresa A com um preço de 90 euros, através de um factor multiplicativo de 0,9. A empresa B pode disponibilizar o mesmo produto com um preço de 120 euros, através de um factor multiplicativo de 1,2.

Deve ser possível adicionar outras propriedades às empresas sem impacto significativo no código já desenvolvido.

== Clientes ==

O sistema mantém um registo de clientes. Cada cliente é identificado por um número de cliente. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada cliente tem ainda informação sobre o seu nome e endereço de correio electrónico. Estes campos não podem ser vazios.

Assume-se que os clientes têm sempre dinheiro, i.e., uma compra nunca é recusada por falta de fundos.

== Compras ==

O sistema regista as compras efectuadas pelos clientes. Cada compra é identificada por um número de compra, atribuído automaticamente e incrementalmente. Uma compra é sempre feita por um único cliente a uma única empresa numa determinada data.

Uma compra é constituída por um conjunto de linhas (um "cabaz"). Cada linha corresponde a:
* um produto;
* uma quantidade (número de exemplares adquiridos desse produto);
* um preço unitário (o preço de venda do produto pela empresa no momento da compra);
* um preço total da linha (quantidade × preço unitário).

O preço unitário utilizado numa compra deve ser guardado na própria linha da compra. Alterações posteriores ao preço base, ao preço recomendado, ao factor multiplicativo da empresa, ou a qualquer outra propriedade utilizada no cálculo do preço, não devem alterar o valor de compras já efectuadas.

O preço total dos itens de uma compra é a soma dos preços totais das suas linhas. Uma compra pode dar origem a uma ou mais encomendas, de acordo com uma estratégia de divisão de encomendas.

A divisão de uma compra em várias encomendas pode ter impacto no custo total da compra.

== Cabaz de Compras ==

Antes de dar origem a uma compra, os produtos que um cliente pretende adquirir a uma empresa são acumulados num '''cabaz'''.

Cada cliente tem um cabaz por cada empresa em que compra. O cabaz é constituído por um conjunto de linhas; cada linha corresponde a um produto disponibilizado por essa empresa e a uma quantidade. Acrescentar ao cabaz um produto que já lá esteja acumula as quantidades.

O cabaz regista ainda as opções que serão aplicadas à compra:
* a [[#Divisão das Compras em Encomendas|estratégia de divisão em encomendas]]; * a [[#Transportadoras|transportadora]] e a [[#Transportadoras|modalidade de transporte]]; e
* o conjunto de [[#Serviços Adicionais|serviços adicionais]].

A transportadora, a modalidade e os serviços adicionais escolhidos aplicam-se a '''todas''' as encomendas resultantes da compra.

Enquanto não for finalizado, o cabaz não tem qualquer efeito no resto do sistema: em particular, não reserva nem consome inventário, e os preços apresentados são sempre os preços de venda praticados pela empresa '''nesse momento'''. Um cabaz faz parte do estado persistente da aplicação: pode ser abandonado e retomado mais tarde.

Ao '''finalizar''' o cabaz, e apenas nesse momento:
* os preços de venda são fixados nas linhas da compra;
* a compra é dividida em encomendas de acordo com a estratégia registada no cabaz;
* todas as encomendas recebem a modalidade de transporte e os serviços adicionais registados no cabaz;
* o inventário dos produtos na empresa é decrementado e o cliente é debitado;
* o cabaz fica vazio.

Um cabaz vazio não pode ser finalizado, nem o pode ser um cabaz em que ainda não tenham sido escolhidas transportadora e modalidade. Se, no momento de finalizar, a empresa já não tiver exemplares suficientes de algum dos produtos do cabaz (por exemplo, porque o inventário foi entretanto alterado), a operação falha sem qualquer efeito e o cabaz mantém-se intacto.

== Divisão das Compras em Encomendas ==

Cada encomenda tem um custo base de processamento e expedição, de '''5 euros'''. Assim, uma compra dividida em várias encomendas pode ter um custo superior ao de uma compra enviada numa única encomenda.

O custo base associado às encomendas corresponde ao número de encomendas multiplicado pelo custo base de uma encomenda.

A este custo podem acrescer os custos associados ao método de transporte seleccionado e aos serviços adicionais.

O custo total de uma compra corresponde, assim, ao custo dos produtos acrescido:
* do custo base das encomendas;
* dos custos adicionais das tarifas de transporte;
* dos custos dos serviços adicionais seleccionados.

A forma como uma compra é dividida em encomendas é determinada por uma estratégia de divisão de encomendas. Inicialmente, devem ser suportadas, pelo menos, as seguintes estratégias: encomenda única ('''UNICA''') e agrupamento por prazo de entrega ('''PRAZO''').

=== Encomenda única ===

Todos os produtos da compra são colocados numa única encomenda.

Neste caso, a compra origina uma única encomenda, independentemente dos prazos de entrega dos produtos.

=== Agrupamento por prazo de entrega ===

Os produtos são agrupados de acordo com os seus prazos de entrega.

Calcula-se a média dos prazos de entrega dos produtos das linhas da compra:
* todas as linhas cujo produto tem prazo menor ou igual à média são agrupadas numa única encomenda;
* cada linha cujo produto tem prazo estritamente maior do que a média é enviada separadamente, numa encomenda própria.

Por exemplo, considere-se uma compra com três linhas cujos produtos têm os prazos de entrega 3 (P1), 8 (P2) e 2 (P3). A média dos prazos é (3 + 8 + 2) / 3 ≈ 4,33. Logo, P1 e P3 (prazos ≤ 4,33) seguem juntos numa entrega e P2 (prazo > 4,33) segue numa outra encomenda:
* Encomenda A: {P1, P3} (prazo = 3)
* Encomenda B: {P2} (prazo = 8)

Uma estratégia de divisão que origina várias encomendas pode permitir que alguns produtos sejam entregues mais cedo, mas pode também resultar num custo superior devido ao custo associado a cada encomenda.

Deve ser possível introduzir novas estratégias de divisão de compras em encomendas com impacto mínimo na implementação desenvolvida.

== Transportadoras ==

O sistema mantém um registo das '''transportadoras''' que operam na plataforma. Cada transportadora é identificada por um número de transportadora. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada transportadora tem ainda um nome (cadeia de caracteres não vazia).

Cada encomenda é enviada através de uma transportadora, segundo uma '''modalidade de transporte'''. Inicialmente, devem ser suportadas, pelo menos, as seguintes modalidades: normal ('''NORMAL''') e expresso ('''EXPRESSO''').

Uma modalidade '''não''' define, por si só, qualquer custo ou prazo: é apenas o nome de um nível de serviço. Para cada modalidade que oferece, uma transportadora define uma '''tarifa''', constituída por:
* um custo adicional (número inteiro); e
* um tempo de transporte (número inteiro de dias).

Assim, a mesma modalidade pode custar e demorar valores diferentes consoante a transportadora.

Uma transportadora '''não tem de oferecer todas as modalidades''': oferece exactamente aquelas para as quais tenha uma tarifa definida. Pedir a uma transportadora uma modalidade que ela não oferece é um erro, e não uma escolha silenciosamente ignorada — ver [[#Definir modalidade de transporte|Definir modalidade de transporte]].

Entre os dois, '''a transportadora tem precedência sobre a modalidade''': como as modalidades disponíveis são as da transportadora, só se pode escolher uma modalidade depois de escolhida a transportadora, e mudar de transportadora anula a modalidade anteriormente escolhida (que passa a ser escolhida de novo, de entre as que a nova transportadora oferece).

Por exemplo:
{|
! style="background: #ebebeb;" | '''Transportadora'''
! style="background: #ebebeb;" | '''Modalidade'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo de transporte'''
|-
| CTT || '''NORMAL''' || 3 euros || 3 dias
|-
| CTT || '''EXPRESSO''' || 8 euros || 1 dia
|-
| DHL || '''NORMAL''' || 5 euros || 2 dias
|-
| DHL || '''EXPRESSO''' || 12 euros || 1 dia
|-
| SEUR || '''EXPRESSO''' || 10 euros || 1 dia
|}

No exemplo acima, a transportadora SEUR só oferece a modalidade expresso: não é possível enviar por SEUR em modalidade normal.

A transportadora e a modalidade são escolhidas no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda seja enviada por uma transportadora ou modalidade diferente.

A escolha da transportadora e da modalidade afecta tanto o custo como a data prevista de entrega da encomenda. Uma compra só pode ser finalizada depois de escolhidas ambas, e o par transportadora/modalidade de um cabaz é sempre um par que a transportadora oferece.

Deve ser possível introduzir novas modalidades de transporte com impacto mínimo na implementação desenvolvida. As transportadoras e as suas tarifas, por seu lado, fazem parte do estado da aplicação: são registadas pelo utilizador e não implicam qualquer alteração ao código.

== Serviços Adicionais ==

O cliente pode seleccionar serviços adicionais, podendo aumentar o custo de cada encomenda, assim como o tempo necessário para a sua preparação e entrega. Os serviços são escolhidos no [[#Cabaz de Compras|cabaz]] e aplicam-se a todas as encomendas da compra; o modelo deve, no entanto, permitir que cada encomenda tenha os seus próprios serviços.

Os serviços iniciais são os seguintes:
{|
! style="background: #ebebeb;" | '''Serviço'''
! style="background: #ebebeb;" | '''Chave'''
! style="background: #ebebeb;" | '''Custo adicional'''
! style="background: #ebebeb;" | '''Tempo adicional'''
|-
| Embrulho || '''EMBRULHO''' || 2 euros || 1 dia
|-
| Cartão de oferta || '''CARTAO_OFERTA''' || 1 euro || 0 dias
|}

Os serviços adicionais podem ser combinados: uma encomenda pode incluir simultaneamente embrulho, cartão de oferta ou outro serviço adicional. O custo e o tempo adicionais de uma encomenda correspondem à soma dos contributos da modalidade de transporte e de todos os serviços seleccionados.

Deve ser possível introduzir novos serviços adicionais sem alterar o código das encomendas ou dos serviços já existentes.

== Entregas ==

Cada encomenda tem uma data prevista de entrega.
A data prevista de entrega é determinada considerando:
* a data da compra;
* os prazos de entrega dos produtos que constituem a encomenda;
* o tempo de transporte da tarifa da transportadora seleccionada;
* o tempo adicional introduzido pelos serviços seleccionados.

Para uma encomenda com vários produtos, o prazo dos produtos considerados para determinar a data prevista de entrega corresponde ao maior prazo de entrega dos seus produtos.

Não é necessário manter explicitamente um estado para representar se uma encomenda está ou não entregue. A situação da encomenda pode ser determinada a partir da data actual e da sua data prevista de entrega. Assim, uma encomenda é considerada entregue quando a data actual atinge ou ultrapassa a sua data prevista de entrega.

== Gestão de Tempo ==

A unidade de tempo do sistema é o dia. A data do sistema começa no dia 1 (um) e faz parte do estado persistente.

A data do sistema pode ser avançada. Sempre que a data é alterada, devem ser verificadas as encomendas existentes para determinar:
* quais as encomendas que serão entregues no dia seguinte;
* quais as encomendas cuja data prevista de entrega foi atingida ou ultrapassada.

Quando a data actual atinge ou ultrapassa a data prevista de entrega de uma encomenda, esta considera-se entregue.

A gestão do tempo deve ainda desencadear [[#Notificações|notificações]].

== Pesquisas ==

Para permitir que os clientes determinem a existência de um produto, deverá ser possível efectuar pesquisas.

As pesquisas consideram os campos relevantes dos vários produtos, por exemplo, nome, categoria, tipo de produto ou país de origem.

O termo de pesquisa deve ser comparado sem distinção entre letras maiúsculas e minúsculas.

O sistema deve suportar diferentes critérios de pesquisa. Por exemplo, uma pesquisa pode procurar produtos cujo nome contenha determinado termo ou produtos pertencentes a determinada categoria.

Deve ser possível introduzir novos métodos de pesquisa de produtos com impacto mínimo na implementação desenvolvida.

== Alterações de Inventário ==

O inventário de um produto numa empresa pode ser alterado através da especificação de um valor a somar ou subtrair ao número de exemplares disponíveis. Se a quantidade indicada for um valor positivo, aumenta-se o número de exemplares disponíveis.
Se a quantidade indicada for um valor negativo, decrementa-se o número de exemplares disponíveis, desde que o número de exemplares disponíveis não fique negativo.

Um produto não é removido do sistema quando o seu inventário numa empresa chega a zero.
Quando o inventário de um produto numa empresa chega a zero, o produto deixa de estar disponível nessa empresa, mas continua a existir no sistema e pode continuar a ser disponibilizado por outras empresas.
Se o inventário de um produto numa empresa passar de zero para um valor positivo, o produto volta a estar disponível nessa empresa.

O número total de unidades disponíveis de um produto corresponde à soma dos inventários desse produto em todas as empresas que o disponibilizam.

Esta informação é utilizada, nomeadamente, no cálculo do preço recomendado dos produtos nacionais.

== Notificações ==

O sistema deve notificar os clientes relativamente às suas encomendas.

Devem ser enviadas notificações em duas situações:
* um dia antes da data prevista de entrega, informando o cliente de que a encomenda será entregue no dia seguinte;
* no dia da entrega, informando o cliente de que a encomenda foi entregue.

Cada notificação deve ser enviada através do mecanismo de notificação seleccionado pelo cliente.
Inicialmente, devem ser suportados, pelo menos, os seguintes mecanismos:
* correio electrónico ('''EMAIL''');
* WhatsApp ('''WHATSAPP''').

Cada cliente pode escolher o mecanismo através do qual pretende receber notificações do sistema. O mecanismo de notificação pode variar de cliente para cliente. Por exemplo, um cliente pode receber notificações por correio electrónico, enquanto outro pode recebê-las através de WhatsApp.
Deve ser possível introduzir novos mecanismos de notificação sem necessidade de alterar o código dos clientes ou do sistema responsável por gerar as notificações.

Deve ser possível introduzir novos mecanismos de notificação com impacto mínimo na implementação desenvolvida.

As notificações devem ser enviadas pela ordem em que os acontecimentos ocorrem no sistema.

= Requisitos de Desenho =

A aplicação a desenvolver deve seguir o princípio de desenho aberto-fechado, por forma a aumentar a extensibilidade do seu código. Por exemplo, deve ser possível adicionar novos tipos de produto com um impacto mínimo no código já existente da aplicação.

Devem ser possíveis extensões ou alterações de funcionalidade com impacto mínimo no código já produzido para a aplicação. O objectivo é aumentar a flexibilidade da aplicação relativamente ao suporte de novas funções. Assim, deve ser possível:
* Adicionar novos tipos de produto (e.g., produtos digitais ou perecíveis), incluindo a respectiva regra de cálculo do preço recomendado; * Adicionar novas categorias de produto;
* Introduzir novas estratégias de divisão de compras em encomendas;
* Introduzir novas modalidades de transporte (os custos e prazos de cada uma são dados de cada transportadora, não código; nem todas as transportadoras têm de oferecer todas as modalidades);
* Introduzir novos serviços adicionais, sem alterar o código das encomendas nem o dos serviços já existentes;
* Introduzir novos mecanismos de notificação, sem alterar o código dos clientes nem o do sistema que gera as notificações;
* Introduzir novos critérios de discriminação/classificação dos clientes;
* Introduzir novos critérios de pesquisa de produtos.

= Funcionalidade da aplicação =

A aplicação permite manter informação sobre as entidades do modelo, permitindo, em particular, gerir empresas, produtos, clientes e compras. Possui ainda a capacidade de preservar o seu estado (não é possível manter várias versões do estado da aplicação em simultâneo).

Nenhuma entidade é removida pelas operações descritas neste enunciado (em particular, um produto cujo inventário numa empresa chegue a zero continua a existir no sistema). Ainda assim, a aplicação deve estar preparada para que a remoção de qualquer entidade possa vir a ser suportada.

No [[#Leitura de Dados a Partir de Ficheiros Textuais|início]], a aplicação está vazia, mas pode ser carregada uma base de dados textual com conceitos pré-definidos. Neste caso, a aplicação começará com um estado referente às entidades que foram carregadas no arranque da aplicação.

{{Suggestion|Note-se que não é necessário implementar de raiz a aplicação: já existem classes que representam e definem a interface geral da funcionalidade do ''core'' da aplicação, tal como é visível pelos comandos da aplicação.}}
{{CVSCode|A interface geral do ''core'' já está parcialmente implementada na classe '''erp.ErpManager''' e outras fornecidas (cujos nomes devem ser mantidos), devendo ser adaptadas onde necessário. É ainda necessário criar e implementar as restantes classes que suportam a operação da aplicação.}}

== Serialização ==

É possível guardar e recuperar o estado actual da aplicação, preservando toda a informação relacionada com o ERP e que foi descrita [[#Conceitos e Relações do Modelo|acima]].

Após a recuperação do estado, os identificadores atribuídos a novas entidades devem continuar a ser atribuídos incrementalmente a partir do último valor utilizado em cada caso.

= Interacção com o utilizador =

Descreve-se nesta secção a '''funcionalidade máxima''' da interface com o utilizador. Em geral, os comandos pedem toda a informação antes de procederem à sua validação (excepto onde indicado). Todos os menus têm automaticamente a opção '''Sair''' (fecha o menu).

As operações de pedido e apresentação de informação ao utilizador '''devem''' realizar-se através dos objectos ''form'' e ''display'', respectivamente, presentes em cada comando. As mensagens são produzidas pelos métodos das [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|bibliotecas de suporte]] ('''po-uilib''' e '''erp-app'''). As mensagens não podem ser usadas no núcleo da aplicação ('''erp-core'''). Além disso, não podem ser definidas novas. Potenciais omissões devem ser esclarecidas antes de qualquer implementação.

De um modo geral, sempre que no contexto de uma operação com o utilizador aconteça alguma excepção, então a operação não deve ter qualquer efeito no estado da aplicação, excepto em caso de indicação contrária na operação em causa. As excepções estão na package '''erp.app.exceptions''', excepto em caso de indicação contrária.

As excepções usadas na interacção (subclasses de '''pt.tecnico.uilib.menus.CommandException'''), excepto em caso de indicação contrária, são lançadas pelos comandos (subclasses de '''pt.tecnico.uilib.menus.Command''') e tratadas pelos menus (instâncias de subclasses de '''pt.tecnico.uilib.menus.Menu'''). Outras excepções não devem substituir as fornecidas nos casos descritos.

Nos pedidos e usos dos vários identificadores, podem ocorrer as seguintes excepções, caso o identificador indicado não corresponda a um objecto conhecido (excepto no processo de registo ou em caso de indicação contrária). Note-se que estas excepções não são utilizáveis no núcleo da aplicação.
{|
! style="background: #ebebeb;" | '''Tipo de dados'''
! style="background: #ebebeb;" | '''Classe'''
! style="background: #ebebeb;" | '''Pedido a apresentar'''
! style="background: #ebebeb;" | '''Excepção a lançar se desconhecido'''
|-
| Empresa
| '''Company'''
| '''erp.app.company.Prompt.companyId()'''
| '''erp.app.exceptions.UnknownCompanyKeyException'''
|-
| Produto
| '''Product'''
| '''erp.app.product.Prompt.productId()'''
| '''erp.app.exceptions.UnknownProductKeyException'''
|-
| Cliente
| '''Client'''
| '''erp.app.client.Prompt.clientId()'''
| '''erp.app.exceptions.UnknownClientKeyException'''
|-
| Compra
| '''Purchase'''
| '''erp.app.purchase.Prompt.purchaseId()'''
| '''erp.app.exceptions.UnknownPurchaseKeyException'''
|}

Alguns casos particulares podem usar pedidos específicos não apresentados nesta tabela.

{{CVSCode|Note-se que o programa principal e os comandos e menus, a seguir descritos, já estão parcial ou completamente implementados nas ''packages'' '''erp.app''', '''erp.app.main''', '''erp.app.company''', '''erp.app.product''', '''erp.app.client''', '''erp.app.purchase'''. Estas classes são de uso obrigatório e estão disponíveis no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|GIT]] (módulo '''erp-app''').}}

== Menu Principal ==

As acções deste menu permitem gerir a salvaguarda do estado da aplicação e abrir submenus. A lista completa é a seguinte: [[#Salvaguarda do estado actual da aplicação|Abrir]], [[#Salvaguarda do estado actual da aplicação|Guardar]], [[#Mostrar data actual|Mostrar data actual]], [[#Avançar data actual|Avançar data actual]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Empresas]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Produtos]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Clientes]] e [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Compras]]. Inicialmente, a aplicação apenas tem informação sobre as entidades que foram carregadas no arranque.

{{CVSCode|As etiquetas das opções deste menu estão definidas na classe '''erp.app.main.Label'''. Todos os métodos correspondentes às mensagens de diálogo para este menu estão definidos na classe '''erp.app.main.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.main''', respectivamente: '''DoOpenFile''', '''DoSaveFile''', '''DoDisplayDate''', '''DoAdvanceDate''', '''DoOpenMenuCompanies''', '''DoOpenMenuProducts''', '''DoOpenMenuClients''', '''DoOpenMenuPurchases'''.}}

=== Salvaguarda do estado actual da aplicação ===

O conteúdo da aplicação (toda a informação detida pelo ERP actualmente em memória) pode ser guardado para posterior recuperação (via serialização Java: '''java.io.Serializable'''). Na leitura e escrita do estado da aplicação, devem ser tratadas as excepções associadas. A funcionalidade é a seguinte:

* '''Abrir''' -- Carrega os dados de uma sessão anterior a partir de um ficheiro previamente guardado (ficando este ficheiro associado à aplicação, para futuras operações de salvaguarda). Pede-se o nome do ficheiro a abrir ('''Prompt.openFile()'''). Caso ocorra um problema na abertura ou processamento do ficheiro, deve ser lançada a excepção '''FileOpenFailedException'''. A execução bem-sucedida desta opção substitui toda a informação da aplicação. Quando se abandona uma aplicação com modificações não guardadas (porque se abre outra e existem alterações não guardadas), deve perguntar-se ao utilizador se quer guardar a informação actual antes de a abandonar, através de '''Prompt.saveBeforeExit()''' (a resposta é obtida via '''Form.confirm()''').

* '''Guardar''' -- Guarda o estado actual da aplicação no ficheiro associado. Se não existir associação, pede-se o nome do ficheiro a utilizar, ficando a ele associado (para operações de salvaguarda subsequentes). Esta interacção realiza-se através do método '''Prompt.newSaveAs()'''. Não é executada nenhuma acção se não existirem alterações desde a última salvaguarda.

{{Suggestion|Note-se que a opção '''Abrir''' não permite a leitura de ficheiros de texto (estes apenas podem ser utilizados no início da aplicação).}}
{{Suggestion|A opção '''Sair''' nunca implica a salvaguarda do estado da aplicação, mesmo que existam alterações.}}

=== Mostrar data actual ===

A data actual do sistema é apresentada através da mensagem '''Message.currentDate()'''.

=== Avançar data actual ===

O número de dias a avançar é pedido através de '''Prompt.daysToAdvance()'''. O valor indicado deve ser positivo. Caso contrário, a operação não tem efeito.

Além da data, o sistema deve actualizar, caso seja necessário, outros aspectos que dela dependam, designadamente, a situação das entregas relativa às suas datas de chegada.

=== Gestão e consulta de dados da aplicação ===

* '''Menu de Gestão de Empresas''' -- Abre o menu de gestão de empresas e operações associadas.
* '''Menu de Gestão de Produtos''' -- Abre o menu de gestão de produtos e operações associadas.
* '''Menu de Gestão de Clientes''' -- Abre o menu de gestão de clientes e operações associadas.
* '''Menu de Gestão de Compras''' -- Abre o menu de gestão de compras e operações associadas.

== Menu de Gestão de Empresas ==

Este menu permite efectuar operações sobre a base de dados de empresas. A lista completa é a seguinte: [[#Registar empresa|Registar empresa]], [[#Mostrar empresa|Mostrar empresa]], [[#Mostrar empresas|Mostrar empresas]], [[#Mostrar produtos de uma empresa|Mostrar produtos de uma empresa]], [[#Mostrar clientes de uma empresa|Mostrar clientes de uma empresa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.company.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.company.Prompt''' e '''erp.app.company.Message'''.}}

=== Registar empresa ===

Pede o nome ('''Prompt.companyName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CompanyRegistrationFailedException'''.

Note-se que a atribuição do identificador da empresa é automática.

=== Mostrar empresa ===

É pedido o identificador da empresa, sendo apresentadas as informações sobre essa empresa, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

=== Mostrar empresas ===

Apresenta informações sobre todas as empresas, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar empresa|Mostrar empresa]].

=== Mostrar produtos de uma empresa ===

É pedido o identificador da empresa e apresentam-se os produtos que essa empresa vende, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar produto|Mostrar produto]].

=== Mostrar clientes de uma empresa ===

É pedido o identificador da empresa e apresentam-se os clientes que já interagiram com essa empresa, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar cliente|Mostrar cliente]].

== Menu de Gestão de Produtos ==

Este menu apresenta as operações disponíveis sobre produtos. A lista completa é a seguinte: [[#Mostrar produto|Mostrar produto]], [[#Mostrar produtos|Mostrar produtos]], [[#Alterar inventário de um produto|Alterar inventário de um produto]] e [[#Efectuar pesquisa|Efectuar pesquisa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.product.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.product.Prompt''' e '''erp.app.product.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.product''' (disponível no GIT), respectivamente: '''DoShowProduct''', '''DoShowProducts''', '''DoChangeProductInventory''', '''DoPerformSearch'''.}}

=== Mostrar produto ===

É pedido o identificador do produto. Se o produto existir, é apresentado de acordo com o seguinte formato. O formato genérico de apresentação de um produto é como se segue:
{{CollapsedCode|Formato de apresentação de produtos|
''id'' - ''stock'' - ''tipo'' - ''nome'' - ''preço'' - ''categoria'' - ''informação adicional''
}}

Para produtos fabricados, a informação adicional corresponde ao nome do fabricante e ao código de fabrico (separados pelo carácter ''';'''); para produtos importados, a informação adicional corresponde ao país de origem e à taxa alfandegária.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
3 - 20 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
4 - 2 - IMPORTADO - Telemóvel - 200 - ELECTRONICA - China - 30
5 - 0 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

=== Mostrar produtos ===

Apresenta informações sobre todos os produtos, ordenando-os pelos seus identificadores. O formato de apresentação é como descrito em [[#Mostrar produto|Mostrar produto]].

=== Alterar inventário de um produto ===

É pedido o identificador de um produto e uma quantidade ('''Prompt.amountToUpdate()''') e actualizado o número de exemplares disponíveis do produto indicado somando a quantidade indicada ao número de exemplares disponíveis. No caso de não ser possível actualizar o número de exemplares devido ao facto de a quantidade indicada ser inválida, então a operação não deve ter qualquer efeito e deve ser apresentada a mensagem '''Message.notEnoughInventory()'''.

=== Efectuar pesquisa ===

Esta opção realiza uma procura por termo (cadeia de caracteres), pedido através de '''Prompt.searchTerm()'''. Como resultado, deve ser apresentada uma lista dos produtos encontrados pela pesquisa, ordenados por ordem crescente do seu identificador, utilizando o formato descrito para [[#Mostrar produto|Mostrar produto]].

O termo de pesquisa deve ser comparado (sem distinção entre letras maiúsculas e minúsculas) com os campos relevantes de cada produto: o nome e a categoria. Só devem ser apresentados produtos que contenham o termo de pesquisa num dos campos relevantes. Caso não sejam encontrados produtos, não deve ser produzido qualquer resultado.

== Menu de Gestão de Clientes ==

Este menu permite efectuar operações sobre a base de dados de clientes. A lista completa é a seguinte: [[#Registar cliente|Registar cliente]], [[#Mostrar cliente|Mostrar cliente]], [[#Mostrar clientes|Mostrar clientes]], [[#Mostrar notificações do cliente|Mostrar notificações do cliente]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.client.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.client.Prompt''' e '''erp.app.client.Message'''.}}

=== Registar cliente ===

Pede o nome ('''Prompt.clientName()''') e o endereço de correio electrónico ('''Prompt.clientEMail()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''ClientRegistrationFailedException'''.

Note-se que a atribuição do identificador do cliente é automática e que clientes diferentes são registados em cada operação de registo.

=== Mostrar cliente ===

É pedido o identificador do cliente, sendo apresentadas as informações sobre esse cliente, de acordo com o seguinte formato. O valor apresentado após o email corresponde ao total gasto pelo cliente em compras (um valor inteiro).
{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''gasto total''
}}
{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Alberto Meireles - ameireles@mymail.com - 275
1 - Fernando Meireles - fmeireles@mymail.com - 0
</syntaxhighlight>
}}

=== Mostrar clientes ===

Apresenta informações sobre todos os clientes, ordenando-os lexicograficamente pelo nome. Caso existam clientes com o mesmo nome, devem ser ordenados por ordem crescente dos seus identificadores. O formato é o descrito em [[#Mostrar cliente|Mostrar cliente]].

=== Mostrar notificações do cliente ===

É pedido o identificador do cliente, sendo apresentadas as notificações para esse cliente, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação das notificações de um cliente|
DISPONIBILIDADE: ''descrição de produto disponível''
}}
{{CollapsedCode|Exemplos de notificações|
<syntaxhighlight lang="text">
DISPONIBILIDADE: 5 - 4 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

Note-se que a descrição é idêntica à que é realizada para mostrar cada produto. No entanto, a solução deve ser suficientemente flexível para permitir outros formatos de apresentação das notificações (sem impacto no código do domínio da aplicação).

== Menu de Gestão de Compras ==

Este menu apresenta as operações relacionadas com compras e entregas. A lista completa é a seguinte: [[#Efectuar compra|Efectuar compra]], [[#Mostrar compra|Mostrar compra]], [[#Mostrar compras|Mostrar compras]], [[#Mostrar entregas de uma compra|Mostrar entregas de uma compra]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.purchase.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.purchase.Prompt''' e '''erp.app.purchase.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.purchase''' (disponível no GIT), respectivamente: '''DoDoPurchase''', '''DoShowPurchase''', '''DoShowPurchases''', '''DoShowPurchaseDeliveries'''.}}

=== Efectuar compra ===

No processo de efectuar uma compra, o sistema pede, primeiro, a identificação do cliente; de seguida, a identificação da empresa a que a compra é feita; e, finalmente, para cada linha, o identificador do produto e a quantidade pretendida ('''Prompt.productId()''' e '''Prompt.amountToBuy()'''). O processo de adição de linhas termina de acordo com a interacção definida no comando.

Se não houver exemplares suficientes de um produto para satisfazer a quantidade pretendida, deve ser apresentada a mensagem '''Message.notEnoughInventory()''' e essa linha não é adicionada. Concluída a compra, o ''stock'' dos produtos é decrementado, a empresa passa a seguir o cliente e são determinadas as entregas correspondentes. A data limite de chegada de cada entrega é comunicada através da mensagem '''Message.deliveryDate()'''.

=== Mostrar compra ===

É pedido o identificador da compra. Na primeira linha apresenta-se a informação da compra; de seguida, apresentam-se as suas entregas '''em detalhe''' — cada entrega (identificador da compra e data de chegada) seguida da descrição completa de cada um dos seus produtos (o mesmo formato de [[#Mostrar produto|Mostrar produto]]). O formato é o seguinte:
{{CollapsedCode|Formato de apresentação de uma compra (com entregas em detalhe)|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''sobretaxa de entrega'' - ''preço total''
''idCompra'' - ''data de chegada''
''descrição de produto''
...
}}
{{CollapsedCode|Exemplos de apresentação de compras|
<syntaxhighlight lang="text">
7 - 3 - 1 - 4 - 90 - 9 - 99
7 - 7
1 - 18 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
3 - 2 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
7 - 12
2 - 1 - IMPORTADO - Telemovel - 200 - ELECTRONICA - China - 30
</syntaxhighlight>
}}

=== Mostrar compras ===

Apresenta informações sobre todas as compras, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar compra|Mostrar compra]].

=== Mostrar entregas de uma compra ===

É pedido o identificador da compra e são apresentadas as entregas correspondentes, ordenadas pela data de chegada e, em caso de empate, pelos identificadores dos produtos. Ao contrário de [[#Mostrar compra|Mostrar compra]] (que apresenta as entregas em detalhe), aqui cada entrega é apresentada '''de forma resumida''' (uma linha, apenas com os identificadores dos produtos), de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma entrega|
''idCompra'' - ''data de chegada'' - ''lista de identificadores de produtos''
}}
{{CollapsedCode|Exemplos de apresentação de entregas (compra do exemplo da secção Entregas)|
<syntaxhighlight lang="text">
7 - 7 - 1, 3
7 - 12 - 2
</syntaxhighlight>
}}

= Leitura de Dados a Partir de Ficheiros Textuais =

Além das opções de manipulação de ficheiros descritas no [[#Menu Principal|menu principal]], é possível iniciar a aplicação com um ficheiro de texto especificado pela propriedade Java '''[[#Execução do Programa e Testes Automáticos|import]]'''.

Cada linha tem uma descrição distinta mas que segue o seguinte formato geral. É possível registar empresas, clientes e produtos, e definir os produtos que cada empresa vende. Assume-se que os campos de texto não podem conter o carácter ''':''' e que os preços são números inteiros. Não existem entradas mal-formadas.

Os produtos têm o formato descrito abaixo, respectivamente, para produtos fabricados e importados. O campo ''stock'' indica o número de exemplares disponíveis do produto.

MANUFACTURED:''idEmpresa'':''nome'':''preço'':''categoria'':''prazo'':''stock'':''fabricante'':''codigo''
IMPORTED:''idEmpresa'':''nome'':''preço'':''categoria'':''prazo'':''stock'':''paisOrigem'':''taxa''

O registo de empresas e de clientes segue os formatos:

COMPANY:''nome''
CLIENT:''nome'':''email''

Um exemplo de conteúdo do ficheiro inicial é como se segue:

{{CollapsedCode|Exemplo de ficheiro de entrada textual|
<syntaxhighlight lang="text">
COMPANY:Moageira Nacional
COMPANY:Importadora Atlantico
CLIENT:Obi-Wan Kenobi:obiwan@jedi.org
MANUFACTURED:1:Farinha:15:ALIMENTAR:3:23:Moageira Nacional:F-0091
IMPORTED:2:Telemovel:200:ELECTRONICA:8:2:China:30
MANUFACTURED:1:Camisa:45:VESTUARIO:2:4:Confeccoes Sul:C-1120
</syntaxhighlight>
}}
A codificação dos ficheiros a ler é garantidamente [[wp:UTF-8|UTF-8]].

{{Suggestion|Os métodos '''String.split()''', para partir cadeias de caracteres, e '''String.trim()''', para remover espaços no início e no final, podem ser usados no processamento de cada linha.}}
{{Suggestion|Note-se que o programa nunca produz ficheiros com este formato (é apenas um formato para ficheiros de entrada).}}

= Execução do Programa e Testes Automáticos =

Usando os ficheiros '''test.import''', '''test.in''' e '''test.out''', é possível verificar automaticamente o resultado correcto do programa. Note-se que é necessária a definição apropriada da variável '''CLASSPATH''' (ou da opção equivalente '''-cp''' do comando '''java'''), para localizar as classes do programa, incluindo a que contém o método correspondente ao ponto de entrada da aplicação ('''erp.app.App.main'''). As propriedades são tratadas automaticamente pelo código de apoio.

java -Dimport=test.import -Din=test.in -Dout=test.outhyp erp.app.App

Assumindo que aqueles ficheiros estão no directório onde é dado o comando de execução, o programa produz o ficheiro de saída '''test.outhyp'''. Em caso de sucesso, os ficheiros das saídas esperada ('''test.out''') e obtida ('''test.outhyp''') devem ser iguais. A comparação pode ser feita com o comando:

diff -b test.out test.outhyp

Este comando não deve produzir qualquer resultado quando os ficheiros são iguais. Note-se, contudo, que este teste não garante o correcto funcionamento do código desenvolvido, apenas verificando alguns aspectos da sua funcionalidade.

= Notas de Implementação =

Tal como indicado acima, algumas classes fornecidas como [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|material de apoio]], são de uso obrigatório e não podem ser alteradas. Outras dessas classes são de uso obrigatório e têm de ser alteradas.

A serialização Java usa as classes da ''package'' [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/package-summary.html java.io], em particular, a interface [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/Serializable.html java.io.Serializable] e as classes de leitura [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectInputStream.html java.io.ObjectInputStream] e escrita [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectOutputStream.html java.io.ObjectOutputStream] (entre outras).

[[category: Ensino]]
[[category:PO]]
[[category: Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T09:52:38Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

'''EM PREPARAÇÃO'''

'''ÉPOCA NORMAL'''

O objectivo do projecto é desenvolver um sistema de gestão de entregas rápidas de produtos (ERP — Express Retail Platform). O sistema deverá permitir, entre outras operações, (i) registar dados de empresas; (ii) registar dados de clientes; (iii) registar, gerir e pesquisar produtos; (iv) efectuar e gerir características de compras; (v) gerir as entregas correspondentes; e (vi) notificar os clientes sobre a situação das suas encomendas.

Neste texto, o tipo '''negrito''' indica um literal (i.e., é exactamente como apresentado); o símbolo ␣ indica um espaço; e o tipo ''itálico'' indica uma parte variável (i.e., uma descrição).

= Conceitos e Relações do Modelo =

Existem vários conceitos importantes neste contexto: [[#Empresas|empresas]], [[#Produtos|produtos]], [[#Clientes|clientes]], [[#Compras|compras]] e [[#Encomendas|encomendas]], e [[#Entregas|entregas]].

Os conceitos listados não são os únicos possíveis no modelo e as suas relações (assim como relações com outros conceitos não mencionados) podem depender das escolhas do projecto.

Os clientes e os produtos são independentes das empresas: existem por si e podem relacionar-se com várias empresas. Cada empresa, no entanto, mantém registo dos clientes com quem interage, dos produtos que disponibiliza, das compras feitas e das encomendas que expede.

Uma compra representa a aquisição de produtos por um cliente a uma empresa. Uma compra pode dar origem a uma ou mais encomendas, de acordo com a estratégia de divisão de encomendas utilizada.

Cada encomenda pode ser enviada através de uma determinada transportadora e pode incluir serviços adicionais que alteram o seu custo e/ou prazo de entrega.

== Produtos ==

O sistema mantém um registo global de produtos. Cada produto é identificado por um número de produto. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Todos os produtos têm: um nome/descrição (cadeia de caracteres não vazia); um preço base (número inteiro positivo); uma categoria; e um prazo de entrega base (número inteiro de dias).

O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.

O sistema utiliza o preço base para calcular o preço recomendado do produto. O preço recomendado representa o valor de referência do produto no sistema. O seu cálculo pode depender do tipo de produto e de outras informações disponíveis no sistema.

Cada produto tem uma categoria, de acordo com a sua natureza. Inicialmente, consideram-se as seguintes categorias: (i) alimentar; (ii) electrónica; e (iii) vestuário. Deve ser possível adicionar novas categorias com impacto mínimo na aplicação já desenvolvida.

O produto existe independentemente das empresas que o disponibilizam. Assim, o mesmo produto pode ser disponibilizado por várias empresas, sendo possível que cada uma pratique um preço de venda diferente.

A informação relativa à disponibilização de um produto por uma empresa não deve ser considerada parte das características intrínsecas do produto.

== Tipos de Produto ==

Todos os produtos considerados no sistema são fabricados, mas podem ter diferentes origens.

Inicialmente, consideram-se os seguintes tipos de produto:
* produto nacional;
* produto importado.

Um produto nacional possui apenas as propriedades gerais dos produtos.

Um produto importado possui, para além das propriedades gerais dos produtos:
* um país de origem (cadeia de caracteres não vazia);
* uma taxa alfandegária (número inteiro expressando uma percentagem);
* um prazo de transporte internacional (número inteiro de dias).

O preço recomendado é calculado de forma diferente consoante o tipo de produto.

Deve ser possível introduzir novos tipos de produto com impacto mínimo na implementação desenvolvida.

=== Produtos Nacionais ===

Para um produto nacional, o preço recomendado depende do preço base e do número total de unidades actualmente disponíveis desse produto nas empresas que o disponibilizam.

Se o número total de unidades disponíveis for:
* superior a 10000, o preço recomendado corresponde a 90% do preço base;
* inferior a 100, o preço recomendado corresponde a 130% do preço base;
* nos restantes casos, o preço recomendado corresponde ao preço base.

Por exemplo, considerando um produto nacional com preço base de 100 euros:
* Unidades disponíveis = 50 => Preço recomendado = 130 euros;
* Unidades disponíveis = 5000 => Preço recomendado = 100 euros;
* Unidades disponíveis = 12000 => Preço recomendado = 90 euros.

=== Produtos Importados ===

Para um produto importado, o preço recomendado corresponde ao preço base acrescido da taxa alfandegária.

Se a taxa alfandegária for '''t%''', o preço recomendado é calculado de acordo com:

'''preço base × (100 + t) / 100'''

Por exemplo, considerando um produto importado com preço base de 100 euros e uma taxa alfandegária de 20%, o preço recomendado será:

'''100 × (100 + 20) / 100 = 120 euros'''

O cálculo do preço recomendado deve ser realizado de forma polimórfica, de modo a que o código que utiliza produtos não tenha de conhecer explicitamente o tipo concreto de cada produto.



== Empresas ==

O sistema mantém um registo das empresas que operam na plataforma. Cada empresa é identificada por um número de empresa. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada empresa tem ainda um nome (cadeia de caracteres não vazia).

Uma empresa pode disponibilizar vários produtos e cada produto pode ser disponibilizado por várias empresas.

Para cada produto que disponibiliza, a empresa deve manter informação sobre:
* número de unidades disponíveis (valor inteiro);
* factor multiplicativo do preço recomendado (número positivo).

O número de unidades disponíveis e o factor multiplicativo podem ser diferentes para cada empresa que disponibiliza o mesmo produto.

O factor multiplicativo permite que uma empresa pratique um preço de venda diferente do preço recomendado pelo sistema.
O preço de venda de um produto pela empresa é calculado multiplicando o preço recomendado do produto pelo factor multiplicativo definido pela empresa.
Assim, duas empresas podem disponibilizar o mesmo produto a preços diferentes e com quantidades diferentes em stock.

Por exemplo, o produto P1, com um preço recomendado de 100 euros, pode ser disponibilizado pela empresa A com um preço de 90 euros, através de um factor multiplicativo de 0,9. A empresa B pode disponibilizar o mesmo produto com um preço de 120 euros, através de um factor multiplicativo de 1,2.

Deve ser possível adicionar outras propriedades às empresas sem impacto significativo no código já desenvolvido.

== Clientes ==

O sistema mantém um registo de clientes. Cada cliente é identificado por um número de cliente. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada cliente tem ainda informação sobre o seu nome e endereço de correio electrónico. Estes campos não podem ser vazios.

Assume-se que os clientes têm sempre dinheiro, i.e., uma compra nunca é recusada por falta de fundos. 

== Compras ==

O sistema regista as compras efectuadas pelos clientes. Cada compra é identificada por um número de compra, atribuído automaticamente e incrementalmente. Uma compra é sempre feita por um único cliente a uma única empresa numa determinada data.

Uma compra é constituída por um conjunto de linhas (um "cabaz"). Cada linha corresponde a:
* um produto;
* uma quantidade (número de exemplares adquiridos desse produto);
* um preço unitário (o preço de venda do produto pela empresa no momento da compra);
* um preço total da linha (quantidade × preço unitário).

O preço unitário utilizado numa compra deve ser guardado na própria linha da compra. Alterações posteriores ao preço base, ao preço recomendado, ao factor multiplicativo da empresa, ou a qualquer outra propriedade utilizada no cálculo do preço, não devem alterar o valor de compras já efectuadas.

O preço total dos itens de uma compra é a soma dos preços totais das suas linhas.

Uma compra pode dar origem a uma ou mais encomendas, de acordo com uma estratégia de divisão de encomendas.

A divisão de uma compra em várias encomendas pode ter impacto no custo total da compra.

== Divisão das Compras em Encomendas ==

Cada encomenda tem um custo base de processamento e expedição. Assim, uma compra dividida em várias encomendas pode ter um custo superior ao de uma compra enviada numa única encomenda.

O custo base associado às encomendas corresponde ao número de encomendas multiplicado pelo custo base de uma encomenda.

A este custo podem acrescer os custos associados ao método de transporte seleccionado e aos serviços adicionais.

O custo total de uma compra corresponde, assim, ao custo dos produtos acrescido:
* do custo base das encomendas;
* dos custos adicionais dos métodos de transporte;
* dos custos dos serviços adicionais seleccionados.

A forma como uma compra é dividida em encomendas é determinada por uma estratégia de divisão de encomendas. Inicialmente, devem ser suportadas, pelo menos, as seguintes estratégias: encomenda única, agrupamento por prazo de entrega.

=== Encomenda única ===

Todos os produtos da compra são colocados numa única encomenda.

Neste caso, a compra origina uma única encomenda, independentemente dos prazos de entrega dos produtos.

=== Agrupamento por prazo de entrega ===

Os produtos são agrupados de acordo com os seus prazos de entrega.

Calcula-se a média dos prazos de entrega dos produtos das linhas da compra:
* todas as linhas cujo produto tem prazo menor ou igual à média são agrupadas numa única encomenda;
* cada linha cujo produto tem prazo estritamente maior do que a média é enviada separadamente, numa encomenda própria.

Por exemplo, considere-se uma compra com três linhas cujos produtos têm os prazos de entrega 3 (P1), 8 (P2) e 2 (P3). A média dos prazos é (3 + 8 + 2) / 3 ≈ 4,33. Logo, P1 e P3 (prazos ≤ 4,33) seguem juntos numa entrega e P2 (prazo > 4,33) segue numa outra encomenda:
* Encomenda A: {P1, P3} (prazo = 3)
* Encomenda B: {P2} (prazo = 8)

Uma estratégia de divisão que origina várias encomendas pode permitir que alguns produtos sejam entregues mais cedo, mas pode também resultar num custo superior devido ao custo associado a cada encomenda.

Deve ser possível introduzir novas estratégias de divisão de compras em encomendas com impacto mínimo na implementação desenvolvida.

== Transportadoras ==

Cada encomenda é enviada através de uma transportadora.
Inicialmente, devem ser suportadas, pelo menos, as seguintes modalidades: normal e expresso.

Cada modalidade de transporte define: (i) um custo adicional; e (ii) um tempo de transporte, expresso em dias.

Por exemplo:
{|
|Modalidade || Custo adicional || Tempo de transporte
|-
| Normal || 3 euros || 3 dias
|-
| Expresso || 8 euros || 1 dia
|}

A escolha de uma modalidade de transporte afecta tanto o custo como a data prevista de entrega da encomenda.

Deve ser possível introduzir novas modalidades de transporte com impacto mínimo na implementação desenvolvida.

== Serviços Adicionais ==

O cliente pode seleccionar serviços adicionais para cada encomenda, podendo aumentar o custo da encomenda, assim como o tempo necessário para a sua preparação e entrega.

Inicialmente, deve ser suportado, pelo menos, um serviço de embrulho.

Por exemplo, um serviço de embrulho pode acrescentar 2 euros ao custo da encomenda e um dia ao prazo necessário para a sua entrega.

Os serviços adicionais podem ser combinados.

Por exemplo, uma encomenda pode incluir simultaneamente embrulho, cartão de oferta ou outro serviço adicional.

Deve ser possível introduzir novos serviços adicionais sem alterar o código das encomendas ou dos serviços já existentes.

== Entregas ==
Cada encomenda tem uma data prevista de entrega.
A data prevista de entrega é determinada considerando:
* a data da compra;
* os prazos de entrega dos produtos que constituem a encomenda;
* o tempo de transporte da transportadora seleccionada;
* o tempo adicional introduzido pelos serviços seleccionados.

Para uma encomenda com vários produtos, o prazo dos produtos considerados para determinar a data prevista de entrega corresponde ao maior prazo de entrega dos seus produtos.

Não é necessário manter explicitamente um estado para representar se uma encomenda está ou não entregue. A situação da encomenda pode ser determinada a partir da data actual e da sua data prevista de entrega. Assim, uma encomenda é considerada entregue quando a data actual atinge ou ultrapassa a sua data prevista de entrega.

== Gestão de Tempo ==

A unidade de tempo do sistema é o dia. A data do sistema começa no dia 1 (um) e faz parte do estado persistente.

A data do sistema pode ser avançada. Sempre que a data é alterada, devem ser verificadas as encomendas existentes para determinar:
* quais as encomendas que serão entregues no dia seguinte;
* quais as encomendas cuja data prevista de entrega foi atingida ou ultrapassada.

Quando a data actual atinge ou ultrapassa a data prevista de entrega de uma encomenda, esta considera-se entregue.

A gestão do tempo deve ainda desencadear [[#Notificações|notificações]].

== Pesquisas ==

Para permitir que os clientes determinem a existência de um produto, deverá ser possível efectuar pesquisas.

As pesquisas consideram os campos relevantes dos vários produtos, por exemplo, nome, categoria, tipo de produto ou país de origem.

O termo de pesquisa deve ser comparado sem distinção entre letras maiúsculas e minúsculas.

O sistema deve suportar diferentes critérios de pesquisa. Por exemplo, uma pesquisa pode procurar produtos cujo nome contenha determinado termo ou produtos pertencentes a determinada categoria.

Deve ser possível introduzir novos métodos de pesquisa de produtos com impacto mínimo na implementação desenvolvida.

== Alterações de Inventário ==

O inventário de um produto numa empresa pode ser alterado através da especificação de um valor a somar ou subtrair ao número de exemplares disponíveis.
Se a quantidade indicada for um valor positivo, aumenta-se o número de exemplares disponíveis.
Se a quantidade indicada for um valor negativo, decrementa-se o número de exemplares disponíveis, desde que o número de exemplares disponíveis não fique negativo.

Um produto não é removido do sistema quando o seu inventário numa empresa chega a zero.
Quando o inventário de um produto numa empresa chega a zero, o produto deixa de estar disponível nessa empresa, mas continua a existir no sistema e pode continuar a ser disponibilizado por outras empresas.
Se o inventário de um produto numa empresa passar de zero para um valor positivo, o produto volta a estar disponível nessa empresa.

O número total de unidades disponíveis de um produto corresponde à soma dos inventários desse produto em todas as empresas que o disponibilizam.

Esta informação é utilizada, nomeadamente, no cálculo do preço recomendado dos produtos nacionais.

== Notificações ==

O sistema deve notificar os clientes relativamente às suas encomendas.

Devem ser enviadas notificações em duas situações:
* um dia antes da data prevista de entrega, informando o cliente de que a encomenda será entregue no dia seguinte;
* no dia da entrega, informando o cliente de que a encomenda foi entregue.

Cada notificação deve ser enviada através do mecanismo de notificação seleccionado pelo cliente.
Inicialmente, devem ser suportados, pelo menos, os seguintes mecanismos:
* correio electrónico;
* WhatsApp.

Cada cliente pode escolher o mecanismo através do qual pretende receber notificações do sistema. O mecanismo de notificação pode variar de cliente para cliente.
Por exemplo, um cliente pode receber notificações por correio electrónico, enquanto outro pode recebê-las através de WhatsApp.
Deve ser possível introduzir novos mecanismos de notificação sem necessidade de alterar o código dos clientes ou do sistema responsável por gerar as notificações.

Deve ser possível introduzir novos mecanismos de notificação com impacto mínimo na implementação desenvolvida.

As notificações devem ser enviadas pela ordem em que os acontecimentos ocorrem no sistema.

= Requisitos de Desenho =

A aplicação a desenvolver deve seguir o princípio de desenho aberto-fechado, por forma a aumentar a extensibilidade do seu código. Por exemplo, deve ser possível adicionar novos tipos de produto com um impacto mínimo no código já existente da aplicação.

Devem ser possíveis extensões ou alterações de funcionalidade com impacto mínimo no código já produzido para a aplicação. O objectivo é aumentar a flexibilidade da aplicação relativamente ao suporte de novas funções. Assim, deve ser possível:
* Adicionar novos tipos de produto (e.g., produtos digitais ou perecíveis);
* Adicionar novas categorias de produto;
* Definir novas entidades que desejem ser notificadas da disponibilidade de produtos;
* Introduzir novos critérios de discriminação/classificação dos clientes;
* Introduzir novos métodos de pesquisa de produtos;
* Alterar a regra de cálculo das entregas e da sobretaxa de entrega com um impacto mínimo no código existente.

= Funcionalidade da aplicação =

A aplicação permite manter informação sobre as entidades do modelo, permitindo, em particular, gerir empresas, produtos, clientes e compras. Possui ainda a capacidade de preservar o seu estado (não é possível manter várias versões do estado da aplicação em simultâneo).

A aplicação deve estar preparada para que se possa remover qualquer entidade (não apenas produtos).

No [[#Leitura de Dados a Partir de Ficheiros Textuais|início]], a aplicação está vazia, mas pode ser carregada uma base de dados textual com conceitos pré-definidos. Neste caso, a aplicação começará com um estado referente às entidades que foram carregadas no arranque da aplicação.

{{Suggestion|Note-se que não é necessário implementar de raiz a aplicação: já existem classes que representam e definem a interface geral da funcionalidade do ''core'' da aplicação, tal como é visível pelos comandos da aplicação.}}
{{CVSCode|A interface geral do ''core'' já está parcialmente implementada na classe '''erp.ErpManager''' e outras fornecidas (cujos nomes devem ser mantidos), devendo ser adaptadas onde necessário. É ainda necessário criar e implementar as restantes classes que suportam a operação da aplicação.}}

== Serialização ==

É possível guardar e recuperar o estado actual da aplicação, preservando toda a informação relacionada com o ERP e que foi descrita [[#Conceitos e Relações do Modelo|acima]].

Após a recuperação do estado, os identificadores atribuídos a novas entidades devem continuar a ser atribuídos incrementalmente a partir do último valor utilizado em cada caso.

= Interacção com o utilizador =

Descreve-se nesta secção a '''funcionalidade máxima''' da interface com o utilizador. Em geral, os comandos pedem toda a informação antes de procederem à sua validação (excepto onde indicado). Todos os menus têm automaticamente a opção '''Sair''' (fecha o menu).

As operações de pedido e apresentação de informação ao utilizador '''devem''' realizar-se através dos objectos ''form'' e ''display'', respectivamente, presentes em cada comando. As mensagens são produzidas pelos métodos das [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|bibliotecas de suporte]] ('''po-uilib''' e '''erp-app'''). As mensagens não podem ser usadas no núcleo da aplicação ('''erp-core'''). Além disso, não podem ser definidas novas. Potenciais omissões devem ser esclarecidas antes de qualquer implementação.

De um modo geral, sempre que no contexto de uma operação com o utilizador aconteça alguma excepção, então a operação não deve ter qualquer efeito no estado da aplicação, excepto em caso de indicação contrária na operação em causa. As excepções estão na package '''erp.app.exceptions''', excepto em caso de indicação contrária.

As excepções usadas na interacção (subclasses de '''pt.tecnico.uilib.menus.CommandException'''), excepto em caso de indicação contrária, são lançadas pelos comandos (subclasses de '''pt.tecnico.uilib.menus.Command''') e tratadas pelos menus (instâncias de subclasses de '''pt.tecnico.uilib.menus.Menu'''). Outras excepções não devem substituir as fornecidas nos casos descritos.

Nos pedidos e usos dos vários identificadores, podem ocorrer as seguintes excepções, caso o identificador indicado não corresponda a um objecto conhecido (excepto no processo de registo ou em caso de indicação contrária). Note-se que estas excepções não são utilizáveis no núcleo da aplicação.
{|
! style="background: #ebebeb;" | '''Tipo de dados'''
! style="background: #ebebeb;" | '''Classe'''
! style="background: #ebebeb;" | '''Pedido a apresentar'''
! style="background: #ebebeb;" | '''Excepção a lançar se desconhecido'''
|-
| Empresa
| '''Company'''
| '''erp.app.company.Prompt.companyId()'''
| '''erp.app.exceptions.UnknownCompanyKeyException'''
|-
| Produto
| '''Product'''
| '''erp.app.product.Prompt.productId()'''
| '''erp.app.exceptions.UnknownProductKeyException'''
|-
| Cliente
| '''Client'''
| '''erp.app.client.Prompt.clientId()'''
| '''erp.app.exceptions.UnknownClientKeyException'''
|-
| Compra
| '''Purchase'''
| '''erp.app.purchase.Prompt.purchaseId()'''
| '''erp.app.exceptions.UnknownPurchaseKeyException'''
|}

Alguns casos particulares podem usar pedidos específicos não apresentados nesta tabela.

{{CVSCode|Note-se que o programa principal e os comandos e menus, a seguir descritos, já estão parcial ou completamente implementados nas ''packages'' '''erp.app''', '''erp.app.main''', '''erp.app.company''', '''erp.app.product''', '''erp.app.client''', '''erp.app.purchase'''. Estas classes são de uso obrigatório e estão disponíveis no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|GIT]] (módulo '''erp-app''').}}

== Menu Principal ==

As acções deste menu permitem gerir a salvaguarda do estado da aplicação e abrir submenus. A lista completa é a seguinte: [[#Salvaguarda do estado actual da aplicação|Abrir]], [[#Salvaguarda do estado actual da aplicação|Guardar]], [[#Mostrar data actual|Mostrar data actual]], [[#Avançar data actual|Avançar data actual]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Empresas]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Produtos]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Clientes]] e [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Compras]]. Inicialmente, a aplicação apenas tem informação sobre as entidades que foram carregadas no arranque.

{{CVSCode|As etiquetas das opções deste menu estão definidas na classe '''erp.app.main.Label'''. Todos os métodos correspondentes às mensagens de diálogo para este menu estão definidos na classe '''erp.app.main.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.main''', respectivamente: '''DoOpenFile''', '''DoSaveFile''', '''DoDisplayDate''', '''DoAdvanceDate''', '''DoOpenMenuCompanies''', '''DoOpenMenuProducts''', '''DoOpenMenuClients''', '''DoOpenMenuPurchases'''.}}

=== Salvaguarda do estado actual da aplicação ===

O conteúdo da aplicação (toda a informação detida pelo ERP actualmente em memória) pode ser guardado para posterior recuperação (via serialização Java: '''java.io.Serializable'''). Na leitura e escrita do estado da aplicação, devem ser tratadas as excepções associadas. A funcionalidade é a seguinte:

* '''Abrir''' -- Carrega os dados de uma sessão anterior a partir de um ficheiro previamente guardado (ficando este ficheiro associado à aplicação, para futuras operações de salvaguarda). Pede-se o nome do ficheiro a abrir ('''Prompt.openFile()'''). Caso ocorra um problema na abertura ou processamento do ficheiro, deve ser lançada a excepção '''FileOpenFailedException'''. A execução bem-sucedida desta opção substitui toda a informação da aplicação. Quando se abandona uma aplicação com modificações não guardadas (porque se abre outra e existem alterações não guardadas), deve perguntar-se ao utilizador se quer guardar a informação actual antes de a abandonar, através de '''Prompt.saveBeforeExit()''' (a resposta é obtida via '''Form.confirm()''').

* '''Guardar''' -- Guarda o estado actual da aplicação no ficheiro associado. Se não existir associação, pede-se o nome do ficheiro a utilizar, ficando a ele associado (para operações de salvaguarda subsequentes). Esta interacção realiza-se através do método '''Prompt.newSaveAs()'''. Não é executada nenhuma acção se não existirem alterações desde a última salvaguarda.

{{Suggestion|Note-se que a opção '''Abrir''' não permite a leitura de ficheiros de texto (estes apenas podem ser utilizados no início da aplicação).}}
{{Suggestion|A opção '''Sair''' nunca implica a salvaguarda do estado da aplicação, mesmo que existam alterações.}}

=== Mostrar data actual ===

A data actual do sistema é apresentada através da mensagem '''Message.currentDate()'''.

=== Avançar data actual ===

O número de dias a avançar é pedido através de '''Prompt.daysToAdvance()'''. O valor indicado deve ser positivo. Caso contrário, a operação não tem efeito.

Além da data, o sistema deve actualizar, caso seja necessário, outros aspectos que dela dependam, designadamente, a situação das entregas relativa às suas datas de chegada.

=== Gestão e consulta de dados da aplicação ===

* '''Menu de Gestão de Empresas''' -- Abre o menu de gestão de empresas e operações associadas.
* '''Menu de Gestão de Produtos''' -- Abre o menu de gestão de produtos e operações associadas.
* '''Menu de Gestão de Clientes''' -- Abre o menu de gestão de clientes e operações associadas.
* '''Menu de Gestão de Compras''' -- Abre o menu de gestão de compras e operações associadas.

== Menu de Gestão de Empresas ==

Este menu permite efectuar operações sobre a base de dados de empresas. A lista completa é a seguinte: [[#Registar empresa|Registar empresa]], [[#Mostrar empresa|Mostrar empresa]], [[#Mostrar empresas|Mostrar empresas]], [[#Mostrar produtos de uma empresa|Mostrar produtos de uma empresa]], [[#Mostrar clientes de uma empresa|Mostrar clientes de uma empresa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.company.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.company.Prompt''' e '''erp.app.company.Message'''.}}

=== Registar empresa ===

Pede o nome ('''Prompt.companyName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CompanyRegistrationFailedException'''.

Note-se que a atribuição do identificador da empresa é automática.

=== Mostrar empresa ===

É pedido o identificador da empresa, sendo apresentadas as informações sobre essa empresa, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

=== Mostrar empresas ===

Apresenta informações sobre todas as empresas, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar empresa|Mostrar empresa]].

=== Mostrar produtos de uma empresa ===

É pedido o identificador da empresa e apresentam-se os produtos que essa empresa vende, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar produto|Mostrar produto]].

=== Mostrar clientes de uma empresa ===

É pedido o identificador da empresa e apresentam-se os clientes que já interagiram com essa empresa, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar cliente|Mostrar cliente]].

== Menu de Gestão de Produtos ==

Este menu apresenta as operações disponíveis sobre produtos. A lista completa é a seguinte: [[#Mostrar produto|Mostrar produto]], [[#Mostrar produtos|Mostrar produtos]], [[#Alterar inventário de um produto|Alterar inventário de um produto]] e [[#Efectuar pesquisa|Efectuar pesquisa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.product.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.product.Prompt''' e '''erp.app.product.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.product''' (disponível no GIT), respectivamente: '''DoShowProduct''', '''DoShowProducts''', '''DoChangeProductInventory''', '''DoPerformSearch'''.}}

=== Mostrar produto ===

É pedido o identificador do produto. Se o produto existir, é apresentado de acordo com o seguinte formato. O formato genérico de apresentação de um produto é como se segue:
{{CollapsedCode|Formato de apresentação de produtos|
''id'' - ''stock'' - ''tipo'' - ''nome'' - ''preço'' - ''categoria'' - ''informação adicional''
}}

Para produtos fabricados, a informação adicional corresponde ao nome do fabricante e ao código de fabrico (separados pelo carácter ''';'''); para produtos importados, a informação adicional corresponde ao país de origem e à taxa alfandegária.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
3 - 20 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
4 - 2 - IMPORTADO - Telemóvel - 200 - ELECTRONICA - China - 30
5 - 0 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

=== Mostrar produtos ===

Apresenta informações sobre todos os produtos, ordenando-os pelos seus identificadores. O formato de apresentação é como descrito em [[#Mostrar produto|Mostrar produto]].

=== Alterar inventário de um produto ===

É pedido o identificador de um produto e uma quantidade ('''Prompt.amountToUpdate()''') e actualizado o número de exemplares disponíveis do produto indicado somando a quantidade indicada ao número de exemplares disponíveis. No caso de não ser possível actualizar o número de exemplares devido ao facto de a quantidade indicada ser inválida, então a operação não deve ter qualquer efeito e deve ser apresentada a mensagem '''Message.notEnoughInventory()'''.

=== Efectuar pesquisa ===

Esta opção realiza uma procura por termo (cadeia de caracteres), pedido através de '''Prompt.searchTerm()'''. Como resultado, deve ser apresentada uma lista dos produtos encontrados pela pesquisa, ordenados por ordem crescente do seu identificador, utilizando o formato descrito para [[#Mostrar produto|Mostrar produto]].

O termo de pesquisa deve ser comparado (sem distinção entre letras maiúsculas e minúsculas) com os campos relevantes de cada produto: o nome e a categoria. Só devem ser apresentados produtos que contenham o termo de pesquisa num dos campos relevantes. Caso não sejam encontrados produtos, não deve ser produzido qualquer resultado.

== Menu de Gestão de Clientes ==

Este menu permite efectuar operações sobre a base de dados de clientes. A lista completa é a seguinte: [[#Registar cliente|Registar cliente]], [[#Mostrar cliente|Mostrar cliente]], [[#Mostrar clientes|Mostrar clientes]], [[#Mostrar notificações do cliente|Mostrar notificações do cliente]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.client.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.client.Prompt''' e '''erp.app.client.Message'''.}}

=== Registar cliente ===

Pede o nome ('''Prompt.clientName()''') e o endereço de correio electrónico ('''Prompt.clientEMail()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''ClientRegistrationFailedException'''.

Note-se que a atribuição do identificador do cliente é automática e que clientes diferentes são registados em cada operação de registo.

=== Mostrar cliente ===

É pedido o identificador do cliente, sendo apresentadas as informações sobre esse cliente, de acordo com o seguinte formato. O valor apresentado após o email corresponde ao total gasto pelo cliente em compras (um valor inteiro).
{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''gasto total''
}}
{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Alberto Meireles - ameireles@mymail.com - 275
1 - Fernando Meireles - fmeireles@mymail.com - 0
</syntaxhighlight>
}}

=== Mostrar clientes ===

Apresenta informações sobre todos os clientes, ordenando-os lexicograficamente pelo nome. Caso existam clientes com o mesmo nome, devem ser ordenados por ordem crescente dos seus identificadores. O formato é o descrito em [[#Mostrar cliente|Mostrar cliente]].

=== Mostrar notificações do cliente ===

É pedido o identificador do cliente, sendo apresentadas as notificações para esse cliente, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação das notificações de um cliente|
DISPONIBILIDADE: ''descrição de produto disponível''
}}
{{CollapsedCode|Exemplos de notificações|
<syntaxhighlight lang="text">
DISPONIBILIDADE: 5 - 4 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

Note-se que a descrição é idêntica à que é realizada para mostrar cada produto. No entanto, a solução deve ser suficientemente flexível para permitir outros formatos de apresentação das notificações (sem impacto no código do domínio da aplicação).

== Menu de Gestão de Compras ==

Este menu apresenta as operações relacionadas com compras e entregas. A lista completa é a seguinte: [[#Efectuar compra|Efectuar compra]], [[#Mostrar compra|Mostrar compra]], [[#Mostrar compras|Mostrar compras]], [[#Mostrar entregas de uma compra|Mostrar entregas de uma compra]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.purchase.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.purchase.Prompt''' e '''erp.app.purchase.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.purchase''' (disponível no GIT), respectivamente: '''DoDoPurchase''', '''DoShowPurchase''', '''DoShowPurchases''', '''DoShowPurchaseDeliveries'''.}}

=== Efectuar compra ===

No processo de efectuar uma compra, o sistema pede, primeiro, a identificação do cliente; de seguida, a identificação da empresa a que a compra é feita; e, finalmente, para cada linha, o identificador do produto e a quantidade pretendida ('''Prompt.productId()''' e '''Prompt.amountToBuy()'''). O processo de adição de linhas termina de acordo com a interacção definida no comando.

Se não houver exemplares suficientes de um produto para satisfazer a quantidade pretendida, deve ser apresentada a mensagem '''Message.notEnoughInventory()''' e essa linha não é adicionada. Concluída a compra, o ''stock'' dos produtos é decrementado, a empresa passa a seguir o cliente e são determinadas as entregas correspondentes. A data limite de chegada de cada entrega é comunicada através da mensagem '''Message.deliveryDate()'''.

=== Mostrar compra ===

É pedido o identificador da compra. Na primeira linha apresenta-se a informação da compra; de seguida, apresentam-se as suas entregas '''em detalhe''' — cada entrega (identificador da compra e data de chegada) seguida da descrição completa de cada um dos seus produtos (o mesmo formato de [[#Mostrar produto|Mostrar produto]]). O formato é o seguinte:
{{CollapsedCode|Formato de apresentação de uma compra (com entregas em detalhe)|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''sobretaxa de entrega'' - ''preço total''
''idCompra'' - ''data de chegada''
''descrição de produto''
...
}}
{{CollapsedCode|Exemplos de apresentação de compras|
<syntaxhighlight lang="text">
7 - 3 - 1 - 4 - 90 - 9 - 99
7 - 7
1 - 18 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
3 - 2 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
7 - 12
2 - 1 - IMPORTADO - Telemovel - 200 - ELECTRONICA - China - 30
</syntaxhighlight>
}}

=== Mostrar compras ===

Apresenta informações sobre todas as compras, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar compra|Mostrar compra]].

=== Mostrar entregas de uma compra ===

É pedido o identificador da compra e são apresentadas as entregas correspondentes, ordenadas pela data de chegada e, em caso de empate, pelos identificadores dos produtos. Ao contrário de [[#Mostrar compra|Mostrar compra]] (que apresenta as entregas em detalhe), aqui cada entrega é apresentada '''de forma resumida''' (uma linha, apenas com os identificadores dos produtos), de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma entrega|
''idCompra'' - ''data de chegada'' - ''lista de identificadores de produtos''
}}
{{CollapsedCode|Exemplos de apresentação de entregas (compra do exemplo da secção Entregas)|
<syntaxhighlight lang="text">
7 - 7 - 1, 3
7 - 12 - 2
</syntaxhighlight>
}}

= Leitura de Dados a Partir de Ficheiros Textuais =

Além das opções de manipulação de ficheiros descritas no [[#Menu Principal|menu principal]], é possível iniciar a aplicação com um ficheiro de texto especificado pela propriedade Java '''[[#Execução do Programa e Testes Automáticos|import]]'''.

Cada linha tem uma descrição distinta mas que segue o seguinte formato geral. É possível registar empresas, clientes e produtos, e definir os produtos que cada empresa vende. Assume-se que os campos de texto não podem conter o carácter ''':''' e que os preços são números inteiros. Não existem entradas mal-formadas.

Os produtos têm o formato descrito abaixo, respectivamente, para produtos fabricados e importados. O campo ''stock'' indica o número de exemplares disponíveis do produto.

MANUFACTURED:''idEmpresa'':''nome'':''preço'':''categoria'':''prazo'':''stock'':''fabricante'':''codigo''
IMPORTED:''idEmpresa'':''nome'':''preço'':''categoria'':''prazo'':''stock'':''paisOrigem'':''taxa''

O registo de empresas e de clientes segue os formatos:

COMPANY:''nome''
CLIENT:''nome'':''email''

Um exemplo de conteúdo do ficheiro inicial é como se segue:

{{CollapsedCode|Exemplo de ficheiro de entrada textual|
<syntaxhighlight lang="text">
COMPANY:Moageira Nacional
COMPANY:Importadora Atlantico
CLIENT:Obi-Wan Kenobi:obiwan@jedi.org
MANUFACTURED:1:Farinha:15:ALIMENTAR:3:23:Moageira Nacional:F-0091
IMPORTED:2:Telemovel:200:ELECTRONICA:8:2:China:30
MANUFACTURED:1:Camisa:45:VESTUARIO:2:4:Confeccoes Sul:C-1120
</syntaxhighlight>
}}
A codificação dos ficheiros a ler é garantidamente [[wp:UTF-8|UTF-8]].

{{Suggestion|Os métodos '''String.split()''', para partir cadeias de caracteres, e '''String.trim()''', para remover espaços no início e no final, podem ser usados no processamento de cada linha.}}
{{Suggestion|Note-se que o programa nunca produz ficheiros com este formato (é apenas um formato para ficheiros de entrada).}}

= Execução do Programa e Testes Automáticos =

Usando os ficheiros '''test.import''', '''test.in''' e '''test.out''', é possível verificar automaticamente o resultado correcto do programa. Note-se que é necessária a definição apropriada da variável '''CLASSPATH''' (ou da opção equivalente '''-cp''' do comando '''java'''), para localizar as classes do programa, incluindo a que contém o método correspondente ao ponto de entrada da aplicação ('''erp.app.App.main'''). As propriedades são tratadas automaticamente pelo código de apoio.

java -Dimport=test.import -Din=test.in -Dout=test.outhyp erp.app.App

Assumindo que aqueles ficheiros estão no directório onde é dado o comando de execução, o programa produz o ficheiro de saída '''test.outhyp'''. Em caso de sucesso, os ficheiros das saídas esperada ('''test.out''') e obtida ('''test.outhyp''') devem ser iguais. A comparação pode ser feita com o comando:

diff -b test.out test.outhyp

Este comando não deve produzir qualquer resultado quando os ficheiros são iguais. Note-se, contudo, que este teste não garante o correcto funcionamento do código desenvolvido, apenas verificando alguns aspectos da sua funcionalidade.

= Notas de Implementação =

Tal como indicado acima, algumas classes fornecidas como [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|material de apoio]], são de uso obrigatório e não podem ser alteradas. Outras dessas classes são de uso obrigatório e têm de ser alteradas.

A serialização Java usa as classes da ''package'' [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/package-summary.html java.io], em particular, a interface [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/Serializable.html java.io.Serializable] e as classes de leitura [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectInputStream.html java.io.ObjectInputStream] e escrita [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectOutputStream.html java.io.ObjectOutputStream] (entre outras).

[[category: Ensino]]
[[category:PO]]
[[category: Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T09:07:45Z

Root: /* Produtos Importados */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

'''EM PREPARAÇÃO'''

'''ÉPOCA NORMAL'''

O objectivo do projecto é desenvolver um sistema de gestão de entregas rápidas de produtos (ERP — Express Retail Platform). O sistema deverá permitir, entre outras operações, (i) registar dados de empresas; (ii) registar dados de clientes; (iii) registar, gerir e pesquisar produtos; (iv) efectuar e gerir características de compras; (v) gerir as entregas correspondentes; e (vi) notificar os clientes sobre a situação das suas encomendas.

Neste texto, o tipo '''negrito''' indica um literal (i.e., é exactamente como apresentado); o símbolo ␣ indica um espaço; e o tipo ''itálico'' indica uma parte variável (i.e., uma descrição).

= Conceitos e Relações do Modelo =

Existem vários conceitos importantes neste contexto: [[#Empresas|empresas]], [[#Produtos|produtos]], [[#Clientes|clientes]], [[#Compras|compras]] e [[#Encomendas|encomendas]], e [[#Entregas|entregas]].

Os conceitos listados não são os únicos possíveis no modelo e as suas relações (assim como relações com outros conceitos não mencionados) podem depender das escolhas do projecto.

Os clientes e os produtos são independentes das empresas: existem por si e podem relacionar-se com várias empresas. Cada empresa, no entanto, mantém registo dos clientes com quem interage, dos produtos que disponibiliza, das compras feitas e das encomendas que expede.

Uma compra representa a aquisição de produtos por um cliente a uma empresa. Uma compra pode dar origem a uma ou mais encomendas, de acordo com a estratégia de divisão de encomendas utilizada.

Cada encomenda pode ser enviada através de uma determinada transportadora e pode incluir serviços adicionais que alteram o seu custo e/ou prazo de entrega.

== Produtos ==

O sistema mantém um registo global de produtos. Cada produto é identificado por um número de produto. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Todos os produtos têm: um nome/descrição (cadeia de caracteres não vazia); um preço base (número inteiro positivo); uma categoria; e um prazo de entrega base (número inteiro de dias).

O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.

O sistema utiliza o preço base para calcular o preço recomendado do produto. O preço recomendado representa o valor de referência do produto no sistema. O seu cálculo pode depender do tipo de produto e de outras informações disponíveis no sistema.

Cada produto tem uma categoria, de acordo com a sua natureza. Inicialmente, consideram-se as seguintes categorias: (i) alimentar; (ii) electrónica; e (iii) vestuário. Deve ser possível adicionar novas categorias com impacto mínimo na aplicação já desenvolvida.

O produto existe independentemente das empresas que o disponibilizam. Assim, o mesmo produto pode ser disponibilizado por várias empresas, sendo possível que cada uma pratique um preço de venda diferente.

A informação relativa à disponibilização de um produto por uma empresa não deve ser considerada parte das características intrínsecas do produto.

== Tipos de Produto ==

Todos os produtos considerados no sistema são fabricados, mas podem ter diferentes origens.

Inicialmente, consideram-se os seguintes tipos de produto:
* produto nacional;
* produto importado.

Um produto nacional possui apenas as propriedades gerais dos produtos.

Um produto importado possui, para além das propriedades gerais dos produtos:
* um país de origem (cadeia de caracteres não vazia);
* uma taxa alfandegária (número inteiro expressando uma percentagem);
* um prazo de transporte internacional (número inteiro de dias).

O preço recomendado é calculado de forma diferente consoante o tipo de produto.

Deve ser possível introduzir novos tipos de produto com impacto mínimo na implementação desenvolvida.

=== Produtos Nacionais ===

Para um produto nacional, o preço recomendado depende do preço base e do número total de unidades actualmente disponíveis desse produto nas empresas que o disponibilizam.

Se o número total de unidades disponíveis for:
* superior a 10000, o preço recomendado corresponde a 90% do preço base;
* inferior a 100, o preço recomendado corresponde a 130% do preço base;
* nos restantes casos, o preço recomendado corresponde ao preço base.

Por exemplo, considerando um produto nacional com preço base de 100 euros:
* Unidades disponíveis = 50 => Preço recomendado = 130 euros;
* Unidades disponíveis = 5000 => Preço recomendado = 100 euros;
* Unidades disponíveis = 12000 => Preço recomendado = 90 euros.

=== Produtos Importados ===

Para um produto importado, o preço recomendado corresponde ao preço base acrescido da taxa alfandegária.

Se a taxa alfandegária for '''t%''', o preço recomendado é calculado de acordo com:

'''preço base × (100 + t) / 100'''

Por exemplo, considerando um produto importado com preço base de 100 euros e uma taxa alfandegária de 20%, o preço recomendado será:

'''100 × (100 + 20) / 100 = 120 euros'''

O cálculo do preço recomendado deve ser realizado de forma polimórfica, de modo a que o código que utiliza produtos não tenha de conhecer explicitamente o tipo concreto de cada produto.



== Empresas ==

O sistema mantém um registo das empresas que operam na plataforma. Cada empresa é identificada por um número de empresa. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada empresa tem ainda um nome (cadeia de caracteres não vazia).

Uma empresa pode disponibilizar vários produtos. Para cada produto que disponibiliza, a empresa deve manter informação sobre:
* número de unidades disponíveis;
* preço base do produto;
* factor multiplicativo do preço.

Duas empresas podem, assim, disponibilizar o mesmo produto com preços base, factores multiplicativos e quantidades em stock diferentes.

Por exemplo, o produto P1 pode ser disponibilizado pela empresa A com um preço base de 20 euros, um factor multiplicativo de 1,1 e 10 unidades disponíveis, enquanto a empresa B disponibiliza o mesmo produto com um preço base de 18 euros, um factor multiplicativo de 1,0 e 3 unidades disponíveis.

O preço base não corresponde necessariamente ao preço final a pagar pelo cliente. O preço final depende do tipo de produto e das regras aplicáveis ao seu cálculo.

Deve ser possível adicionar outras propriedades às empresas sem impacto significativo no código já desenvolvido.
== Cálculo do Preço ==

O preço final de um produto disponibilizado por uma empresa é determinado por uma estratégia de cálculo de preços.

A estratégia recebe a informação necessária para determinar o preço final, incluindo o produto e os valores definidos pela empresa para a sua disponibilização.

Inicialmente devem ser consideradas, pelo menos, as seguintes estratégias:
* '''preço normal''' — o preço final é calculado considerando o preço base e o factor multiplicativo;
* '''preço promocional''' — o preço final é calculado considerando o preço base, o factor multiplicativo e uma redução percentual definida pela promoção.

O sistema deve permitir introduzir novas estratégias de cálculo de preços sem necessidade de alterar o código responsável por efectuar compras.

Por exemplo, futuramente poderão ser introduzidas estratégias que considerem:
* descontos específicos;
* campanhas temporárias;
* preços específicos para determinados clientes;
* outras regras de formação do preço.

O preço efectivo utilizado numa compra deve ser calculado no momento em que a compra é efectuada.

== Clientes ==

O sistema mantém um registo de clientes. Cada cliente é identificado por um número de cliente. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada cliente tem ainda informação sobre o seu nome e endereço de correio electrónico. Estes campos não podem ser vazios.

Assume-se que os clientes têm sempre dinheiro, i.e., uma compra nunca é recusada por falta de fundos. Deve, no entanto, ser possível discriminar os clientes segundo outros critérios (por exemplo, o volume de compras efectuadas), com um impacto mínimo na implementação desenvolvida.

== Compras ==

O sistema regista as compras efectuadas pelos clientes. Cada compra é identificada por um número de compra, atribuído automaticamente e incrementalmente. Uma compra é sempre feita por um único cliente a uma única empresa numa determinada data.

Uma compra é constituída por um conjunto de linhas (um "cabaz"). Cada linha corresponde a:
* um produto;
* uma quantidade (número de exemplares adquiridos desse produto);
* um preço unitário (o preço do produto no momento da compra);
* um preço total da linha (quantidade × preço unitário).

O preço unitário efectivo utilizado na compra deve ser guardado na própria linha da compra. Uma alteração posterior do preço base do produto pela empresa, do factor multiplicativo da empresa, ou de qualquer outra propriedade relevante para o cálculo do preço, não deve alterar o valor de compras já efectuadas.

O preço total dos itens de uma compra é a soma dos preços totais das suas linhas. A cada compra está ainda associada uma sobretaxa de entrega, correspondente a 10% do preço total dos itens, independentemente do número de entregas.



== Gestão de Stock ==

O stock de um produto é mantido por cada empresa que o disponibiliza.
Assim, duas empresas que disponibilizem o mesmo produto podem ter quantidades diferentes desse produto em stock.
O stock de um produto numa determinada empresa pode ser alterado através da especificação de um valor a somar/subtrair ao número de exemplares disponíveis:
* se a quantidade indicada for positiva, aumenta-se o número de exemplares disponíveis;
* se a quantidade indicada for negativa, decrementa-se o número de exemplares disponíveis desde que o número de exemplares disponíveis não fique negativo.

Caso o número de exemplares disponíveis de um produto numa determinada empresa chegue a 0, o produto deixa de estar disponível nessa empresa.

O produto não é removido do sistema, podendo continuar a ser disponibilizado por outras empresas ou voltar a ser disponibilizado posteriormente pela mesma empresa.

Quando o stock de um produto passa de zero para um valor positivo, o produto volta a estar disponível nessa empresa.

A relação entre uma empresa e um produto pode deixar de existir quando a empresa deixa de disponibilizar esse produto.

O produto global deve, no entanto, continuar a existir no sistema enquanto houver outras razões para a sua existência, independentemente de estar temporariamente disponível ou não em qualquer empresa.

== Entregas ==

A cada compra correspondem uma ou mais entregas. A forma como uma compra é dividida em entregas é determinada por uma estratégia de planeamento de entregas.

Inicialmente devem ser suportadas, pelo menos, as seguintes estratégias: entrega conjunta e entrega individual.

Calcula-se a média dos prazos de entrega dos produtos das linhas da compra:
* todas as linhas cujo produto tem prazo menor ou igual à média são agrupadas numa única entrega (a entrega conjunta);
* cada linha cujo produto tem prazo estritamente maior do que a média é enviada separadamente, numa entrega própria (uma entrega conjunta pode não existir se todas as linhas forem enviadas separadamente).

A estratégia de planeamento de entregas deve poder ser seleccionada e substituída sem alterar o código que representa uma compra.

== Ciclo de Vida das Entregas ==
A estratégia de planeamento de entregas deve poder ser seleccionada e substituída sem alterar o código que representa uma compra.

Inicialmente, são considerados os seguintes estados:
* '''CRIADA''' — a entrega foi criada, mas ainda não foi iniciada a sua preparação;
* '''EM_PREPARAÇÃO''' — os produtos da entrega estão a ser preparados;
* '''ENVIADA''' — os produtos foram expedidos e a entrega encontra-se a caminho do cliente;
* '''ENTREGUE''' — a entrega chegou ao cliente.

Uma entrega é inicialmente criada no estado '''CRIADA'''.

As transições entre estados devem respeitar o seguinte fluxo: '''CRIADA''' → '''EM_PREPARAÇÃO''' → '''ENVIADA''' → '''ENTREGUE'''. Não é possível passar ao estado anterior. Não são possíveis alterações depois de se atingir '''ENTREGUE'''.

As operações permitidas sobre uma entrega podem depender do seu estado actual.
Por exemplo, uma entrega que ainda se encontra no estado '''CRIADA''' pode ser colocada em preparação, enquanto uma entrega no estado '''ENVIADA''' não pode voltar ao estado '''EM_PREPARAÇÃO'''.

O comportamento associado aos diferentes estados de uma entrega deve ser modelado de modo a evitar que todas as regras de transição e de comportamento dependente do estado sejam concentradas numa única classe.

Deve ser possível adicionar novos estados ou alterar as regras de transição existentes com impacto mínimo no código já desenvolvido.

== Data de Chegada das Entregas ==

Cada entrega tem uma data de chegada prevista, calculada a partir da data da compra e do prazo aplicável: uma entrega individual usa o prazo do respectivo produto; uma entrega conjunta usa o maior dos prazos dos produtos que dela fazem parte.

Por exemplo, considere-se uma compra com três linhas cujos produtos têm os prazos de entrega 3 (P1), 8 (P2) e 2 (P3). A média dos prazos é (3 + 8 + 2) / 3 ≈ 4,33. Logo, P1 e P3 (prazos ≤ 4,33) seguem juntos numa entrega e P2 (prazo > 4,33) segue numa entrega separada:
* Entrega A: {P1, P3} (prazo = 3) (entrega conjunta)
* Entrega B: {P2} (prazo = 8) (entrega individual)

A data de chegada prevista da entrega A corresponde à data da compra acrescida de 3 dias.
A data de chegada prevista da entrega B corresponde à data da compra acrescida de 8 dias.

Quando a data actual atinge ou ultrapassa a data de chegada prevista de uma entrega que se encontra no estado '''ENVIADA''', a entrega passa automaticamente para o estado '''ENTREGUE'''.

Uma entrega que ainda não tenha sido enviada não pode passar directamente para o estado '''ENTREGUE''' apenas devido à passagem do tempo.

== Pesquisas ==

Para permitir que o sistema ajude os clientes a determinar a existência de um produto, deverá ser possível efectuar pesquisas. As pesquisas consideram os campos relevantes dos vários produtos.

Inicialmente devem ser suportados, pelo menos, os seguintes critérios de pesquisa:
* nome;
* descrição do produto;
* categoria do produto;
* disponibilidade em stock;
* intervalo de preços.

O termo de pesquisa deve ser comparado sem distinção entre letras maiúsculas e minúsculas (quando aplicável).

O sistema deve permitir seleccionar diferentes estratégias de pesquisa.
Deve ser possível introduzir novos métodos de pesquisa de um produto com um impacto mínimo na implementação desenvolvida. Por exemplo, futuramente poderá ser possível pesquisar produtos por país de origem, por prazo de entrega, ou por combinação de vários critérios.

== Gestão de Tempo ==

A unidade de tempo do sistema é o dia. A data do sistema começa no dia 1 (um) e faz parte do estado persistente.

Sempre que a data é alterada, deve ser verificada a situação das entregas: quando a data actual atinge ou ultrapassa a data de chegada prevista de uma entrega que se encontra no estado '''ENVIADA''', a entrega passa para o estado '''ENTREGUE'''.

Devem ainda ser actualizados outros aspectos que dependam da data actual.

== Notificações ==

Deve existir um mecanismo de notificações que permita avisar eventuais interessados quando os produtos ficam em determinadas situações.
Quando um produto sem qualquer exemplar disponível '''numa determinada empresa''' passa a ter pelo menos um exemplar disponível nessa empresa, quer-se enviar uma notificação a todas as entidades que demonstraram interesse nesta situação.

As notificações de um cliente apenas devem ser apresentadas uma única vez. Após esta visualização, considera-se que o cliente fica sem notificações. As notificações devem ser apresentadas pela mesma ordem em que foram enviadas pelo sistema.

No caso de uma entidade interessada em ser avisada da disponibilidade de um produto numa determinada empresa, isto significa que, sempre que o produto em causa passar da situação de indisponível (zero exemplares disponíveis) para disponível (pelo menos um exemplar disponível), nessa empresa, a entidade deve receber uma notificação.

Deve ser possível definir novas entidades interessadas e novos tipos de notificação, com impacto mínimo no código do domínio da aplicação.

= Requisitos de Desenho =

A aplicação a desenvolver deve seguir o princípio de desenho aberto-fechado, por forma a aumentar a extensibilidade do seu código. Por exemplo, deve ser possível adicionar novos tipos de produto com um impacto mínimo no código já existente da aplicação.

Devem ser possíveis extensões ou alterações de funcionalidade com impacto mínimo no código já produzido para a aplicação. O objectivo é aumentar a flexibilidade da aplicação relativamente ao suporte de novas funções. Assim, deve ser possível:
* Adicionar novos tipos de produto (e.g., produtos digitais ou perecíveis);
* Adicionar novas categorias de produto;
* Definir novas entidades que desejem ser notificadas da disponibilidade de produtos;
* Introduzir novos critérios de discriminação/classificação dos clientes;
* Introduzir novos métodos de pesquisa de produtos;
* Alterar a regra de cálculo das entregas e da sobretaxa de entrega com um impacto mínimo no código existente.

= Funcionalidade da aplicação =

A aplicação permite manter informação sobre as entidades do modelo, permitindo, em particular, gerir empresas, produtos, clientes e compras. Possui ainda a capacidade de preservar o seu estado (não é possível manter várias versões do estado da aplicação em simultâneo).

A aplicação deve estar preparada para que se possa remover qualquer entidade (não apenas produtos).

No [[#Leitura de Dados a Partir de Ficheiros Textuais|início]], a aplicação está vazia, mas pode ser carregada uma base de dados textual com conceitos pré-definidos. Neste caso, a aplicação começará com um estado referente às entidades que foram carregadas no arranque da aplicação.

{{Suggestion|Note-se que não é necessário implementar de raiz a aplicação: já existem classes que representam e definem a interface geral da funcionalidade do ''core'' da aplicação, tal como é visível pelos comandos da aplicação.}}
{{CVSCode|A interface geral do ''core'' já está parcialmente implementada na classe '''erp.ErpManager''' e outras fornecidas (cujos nomes devem ser mantidos), devendo ser adaptadas onde necessário. É ainda necessário criar e implementar as restantes classes que suportam a operação da aplicação.}}

== Serialização ==

É possível guardar e recuperar o estado actual da aplicação, preservando toda a informação relacionada com o ERP e que foi descrita [[#Conceitos e Relações do Modelo|acima]].

= Interacção com o utilizador =

Descreve-se nesta secção a '''funcionalidade máxima''' da interface com o utilizador. Em geral, os comandos pedem toda a informação antes de procederem à sua validação (excepto onde indicado). Todos os menus têm automaticamente a opção '''Sair''' (fecha o menu).

As operações de pedido e apresentação de informação ao utilizador '''devem''' realizar-se através dos objectos ''form'' e ''display'', respectivamente, presentes em cada comando. As mensagens são produzidas pelos métodos das [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|bibliotecas de suporte]] ('''po-uilib''' e '''erp-app'''). As mensagens não podem ser usadas no núcleo da aplicação ('''erp-core'''). Além disso, não podem ser definidas novas. Potenciais omissões devem ser esclarecidas antes de qualquer implementação.

De um modo geral, sempre que no contexto de uma operação com o utilizador aconteça alguma excepção, então a operação não deve ter qualquer efeito no estado da aplicação, excepto em caso de indicação contrária na operação em causa. As excepções estão na package '''erp.app.exceptions''', excepto em caso de indicação contrária.

As excepções usadas na interacção (subclasses de '''pt.tecnico.uilib.menus.CommandException'''), excepto em caso de indicação contrária, são lançadas pelos comandos (subclasses de '''pt.tecnico.uilib.menus.Command''') e tratadas pelos menus (instâncias de subclasses de '''pt.tecnico.uilib.menus.Menu'''). Outras excepções não devem substituir as fornecidas nos casos descritos.

Nos pedidos e usos dos vários identificadores, podem ocorrer as seguintes excepções, caso o identificador indicado não corresponda a um objecto conhecido (excepto no processo de registo ou em caso de indicação contrária). Note-se que estas excepções não são utilizáveis no núcleo da aplicação.
{|
! style="background: #ebebeb;" | '''Tipo de dados'''
! style="background: #ebebeb;" | '''Classe'''
! style="background: #ebebeb;" | '''Pedido a apresentar'''
! style="background: #ebebeb;" | '''Excepção a lançar se desconhecido'''
|-
| Empresa
| '''Company'''
| '''erp.app.company.Prompt.companyId()'''
| '''erp.app.exceptions.UnknownCompanyKeyException'''
|-
| Produto
| '''Product'''
| '''erp.app.product.Prompt.productId()'''
| '''erp.app.exceptions.UnknownProductKeyException'''
|-
| Cliente
| '''Client'''
| '''erp.app.client.Prompt.clientId()'''
| '''erp.app.exceptions.UnknownClientKeyException'''
|-
| Compra
| '''Purchase'''
| '''erp.app.purchase.Prompt.purchaseId()'''
| '''erp.app.exceptions.UnknownPurchaseKeyException'''
|}

Alguns casos particulares podem usar pedidos específicos não apresentados nesta tabela.

{{CVSCode|Note-se que o programa principal e os comandos e menus, a seguir descritos, já estão parcial ou completamente implementados nas ''packages'' '''erp.app''', '''erp.app.main''', '''erp.app.company''', '''erp.app.product''', '''erp.app.client''', '''erp.app.purchase'''. Estas classes são de uso obrigatório e estão disponíveis no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|GIT]] (módulo '''erp-app''').}}

== Menu Principal ==

As acções deste menu permitem gerir a salvaguarda do estado da aplicação e abrir submenus. A lista completa é a seguinte: [[#Salvaguarda do estado actual da aplicação|Abrir]], [[#Salvaguarda do estado actual da aplicação|Guardar]], [[#Mostrar data actual|Mostrar data actual]], [[#Avançar data actual|Avançar data actual]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Empresas]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Produtos]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Clientes]] e [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Compras]]. Inicialmente, a aplicação apenas tem informação sobre as entidades que foram carregadas no arranque.

{{CVSCode|As etiquetas das opções deste menu estão definidas na classe '''erp.app.main.Label'''. Todos os métodos correspondentes às mensagens de diálogo para este menu estão definidos na classe '''erp.app.main.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.main''', respectivamente: '''DoOpenFile''', '''DoSaveFile''', '''DoDisplayDate''', '''DoAdvanceDate''', '''DoOpenMenuCompanies''', '''DoOpenMenuProducts''', '''DoOpenMenuClients''', '''DoOpenMenuPurchases'''.}}

=== Salvaguarda do estado actual da aplicação ===

O conteúdo da aplicação (toda a informação detida pelo ERP actualmente em memória) pode ser guardado para posterior recuperação (via serialização Java: '''java.io.Serializable'''). Na leitura e escrita do estado da aplicação, devem ser tratadas as excepções associadas. A funcionalidade é a seguinte:

* '''Abrir''' -- Carrega os dados de uma sessão anterior a partir de um ficheiro previamente guardado (ficando este ficheiro associado à aplicação, para futuras operações de salvaguarda). Pede-se o nome do ficheiro a abrir ('''Prompt.openFile()'''). Caso ocorra um problema na abertura ou processamento do ficheiro, deve ser lançada a excepção '''FileOpenFailedException'''. A execução bem-sucedida desta opção substitui toda a informação da aplicação. Quando se abandona uma aplicação com modificações não guardadas (porque se abre outra e existem alterações não guardadas), deve perguntar-se ao utilizador se quer guardar a informação actual antes de a abandonar, através de '''Prompt.saveBeforeExit()''' (a resposta é obtida via '''Form.confirm()''').

* '''Guardar''' -- Guarda o estado actual da aplicação no ficheiro associado. Se não existir associação, pede-se o nome do ficheiro a utilizar, ficando a ele associado (para operações de salvaguarda subsequentes). Esta interacção realiza-se através do método '''Prompt.newSaveAs()'''. Não é executada nenhuma acção se não existirem alterações desde a última salvaguarda.

{{Suggestion|Note-se que a opção '''Abrir''' não permite a leitura de ficheiros de texto (estes apenas podem ser utilizados no início da aplicação).}}
{{Suggestion|A opção '''Sair''' nunca implica a salvaguarda do estado da aplicação, mesmo que existam alterações.}}

=== Mostrar data actual ===

A data actual do sistema é apresentada através da mensagem '''Message.currentDate()'''.

=== Avançar data actual ===

O número de dias a avançar é pedido através de '''Prompt.daysToAdvance()'''. O valor indicado deve ser positivo. Caso contrário, a operação não tem efeito.

Além da data, o sistema deve actualizar, caso seja necessário, outros aspectos que dela dependam, designadamente, a situação das entregas relativa às suas datas de chegada.

=== Gestão e consulta de dados da aplicação ===

* '''Menu de Gestão de Empresas''' -- Abre o menu de gestão de empresas e operações associadas.
* '''Menu de Gestão de Produtos''' -- Abre o menu de gestão de produtos e operações associadas.
* '''Menu de Gestão de Clientes''' -- Abre o menu de gestão de clientes e operações associadas.
* '''Menu de Gestão de Compras''' -- Abre o menu de gestão de compras e operações associadas.

== Menu de Gestão de Empresas ==

Este menu permite efectuar operações sobre a base de dados de empresas. A lista completa é a seguinte: [[#Registar empresa|Registar empresa]], [[#Mostrar empresa|Mostrar empresa]], [[#Mostrar empresas|Mostrar empresas]], [[#Mostrar produtos de uma empresa|Mostrar produtos de uma empresa]], [[#Mostrar clientes de uma empresa|Mostrar clientes de uma empresa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.company.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.company.Prompt''' e '''erp.app.company.Message'''.}}

=== Registar empresa ===

Pede o nome ('''Prompt.companyName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CompanyRegistrationFailedException'''.

Note-se que a atribuição do identificador da empresa é automática.

=== Mostrar empresa ===

É pedido o identificador da empresa, sendo apresentadas as informações sobre essa empresa, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

=== Mostrar empresas ===

Apresenta informações sobre todas as empresas, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar empresa|Mostrar empresa]].

=== Mostrar produtos de uma empresa ===

É pedido o identificador da empresa e apresentam-se os produtos que essa empresa vende, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar produto|Mostrar produto]].

=== Mostrar clientes de uma empresa ===

É pedido o identificador da empresa e apresentam-se os clientes que já interagiram com essa empresa, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar cliente|Mostrar cliente]].

== Menu de Gestão de Produtos ==

Este menu apresenta as operações disponíveis sobre produtos. A lista completa é a seguinte: [[#Mostrar produto|Mostrar produto]], [[#Mostrar produtos|Mostrar produtos]], [[#Alterar inventário de um produto|Alterar inventário de um produto]] e [[#Efectuar pesquisa|Efectuar pesquisa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.product.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.product.Prompt''' e '''erp.app.product.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.product''' (disponível no GIT), respectivamente: '''DoShowProduct''', '''DoShowProducts''', '''DoChangeProductInventory''', '''DoPerformSearch'''.}}

=== Mostrar produto ===

É pedido o identificador do produto. Se o produto existir, é apresentado de acordo com o seguinte formato. O formato genérico de apresentação de um produto é como se segue:
{{CollapsedCode|Formato de apresentação de produtos|
''id'' - ''stock'' - ''tipo'' - ''nome'' - ''preço'' - ''categoria'' - ''informação adicional''
}}

Para produtos fabricados, a informação adicional corresponde ao nome do fabricante e ao código de fabrico (separados pelo carácter ''';'''); para produtos importados, a informação adicional corresponde ao país de origem e à taxa alfandegária.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
3 - 20 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
4 - 2 - IMPORTADO - Telemóvel - 200 - ELECTRONICA - China - 30
5 - 0 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

=== Mostrar produtos ===

Apresenta informações sobre todos os produtos, ordenando-os pelos seus identificadores. O formato de apresentação é como descrito em [[#Mostrar produto|Mostrar produto]].

=== Alterar inventário de um produto ===

É pedido o identificador de um produto e uma quantidade ('''Prompt.amountToUpdate()''') e actualizado o número de exemplares disponíveis do produto indicado somando a quantidade indicada ao número de exemplares disponíveis. No caso de não ser possível actualizar o número de exemplares devido ao facto de a quantidade indicada ser inválida, então a operação não deve ter qualquer efeito e deve ser apresentada a mensagem '''Message.notEnoughInventory()'''.

=== Efectuar pesquisa ===

Esta opção realiza uma procura por termo (cadeia de caracteres), pedido através de '''Prompt.searchTerm()'''. Como resultado, deve ser apresentada uma lista dos produtos encontrados pela pesquisa, ordenados por ordem crescente do seu identificador, utilizando o formato descrito para [[#Mostrar produto|Mostrar produto]].

O termo de pesquisa deve ser comparado (sem distinção entre letras maiúsculas e minúsculas) com os campos relevantes de cada produto: o nome e a categoria. Só devem ser apresentados produtos que contenham o termo de pesquisa num dos campos relevantes. Caso não sejam encontrados produtos, não deve ser produzido qualquer resultado.

== Menu de Gestão de Clientes ==

Este menu permite efectuar operações sobre a base de dados de clientes. A lista completa é a seguinte: [[#Registar cliente|Registar cliente]], [[#Mostrar cliente|Mostrar cliente]], [[#Mostrar clientes|Mostrar clientes]], [[#Mostrar notificações do cliente|Mostrar notificações do cliente]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.client.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.client.Prompt''' e '''erp.app.client.Message'''.}}

=== Registar cliente ===

Pede o nome ('''Prompt.clientName()''') e o endereço de correio electrónico ('''Prompt.clientEMail()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''ClientRegistrationFailedException'''.

Note-se que a atribuição do identificador do cliente é automática e que clientes diferentes são registados em cada operação de registo.

=== Mostrar cliente ===

É pedido o identificador do cliente, sendo apresentadas as informações sobre esse cliente, de acordo com o seguinte formato. O valor apresentado após o email corresponde ao total gasto pelo cliente em compras (um valor inteiro).
{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''gasto total''
}}
{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Alberto Meireles - ameireles@mymail.com - 275
1 - Fernando Meireles - fmeireles@mymail.com - 0
</syntaxhighlight>
}}

=== Mostrar clientes ===

Apresenta informações sobre todos os clientes, ordenando-os lexicograficamente pelo nome. Caso existam clientes com o mesmo nome, devem ser ordenados por ordem crescente dos seus identificadores. O formato é o descrito em [[#Mostrar cliente|Mostrar cliente]].

=== Mostrar notificações do cliente ===

É pedido o identificador do cliente, sendo apresentadas as notificações para esse cliente, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação das notificações de um cliente|
DISPONIBILIDADE: ''descrição de produto disponível''
}}
{{CollapsedCode|Exemplos de notificações|
<syntaxhighlight lang="text">
DISPONIBILIDADE: 5 - 4 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

Note-se que a descrição é idêntica à que é realizada para mostrar cada produto. No entanto, a solução deve ser suficientemente flexível para permitir outros formatos de apresentação das notificações (sem impacto no código do domínio da aplicação).

== Menu de Gestão de Compras ==

Este menu apresenta as operações relacionadas com compras e entregas. A lista completa é a seguinte: [[#Efectuar compra|Efectuar compra]], [[#Mostrar compra|Mostrar compra]], [[#Mostrar compras|Mostrar compras]], [[#Mostrar entregas de uma compra|Mostrar entregas de uma compra]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.purchase.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.purchase.Prompt''' e '''erp.app.purchase.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.purchase''' (disponível no GIT), respectivamente: '''DoDoPurchase''', '''DoShowPurchase''', '''DoShowPurchases''', '''DoShowPurchaseDeliveries'''.}}

=== Efectuar compra ===

No processo de efectuar uma compra, o sistema pede, primeiro, a identificação do cliente; de seguida, a identificação da empresa a que a compra é feita; e, finalmente, para cada linha, o identificador do produto e a quantidade pretendida ('''Prompt.productId()''' e '''Prompt.amountToBuy()'''). O processo de adição de linhas termina de acordo com a interacção definida no comando.

Se não houver exemplares suficientes de um produto para satisfazer a quantidade pretendida, deve ser apresentada a mensagem '''Message.notEnoughInventory()''' e essa linha não é adicionada. Concluída a compra, o ''stock'' dos produtos é decrementado, a empresa passa a seguir o cliente e são determinadas as entregas correspondentes. A data limite de chegada de cada entrega é comunicada através da mensagem '''Message.deliveryDate()'''.

=== Mostrar compra ===

É pedido o identificador da compra. Na primeira linha apresenta-se a informação da compra; de seguida, apresentam-se as suas entregas '''em detalhe''' — cada entrega (identificador da compra e data de chegada) seguida da descrição completa de cada um dos seus produtos (o mesmo formato de [[#Mostrar produto|Mostrar produto]]). O formato é o seguinte:
{{CollapsedCode|Formato de apresentação de uma compra (com entregas em detalhe)|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''sobretaxa de entrega'' - ''preço total''
''idCompra'' - ''data de chegada''
''descrição de produto''
...
}}
{{CollapsedCode|Exemplos de apresentação de compras|
<syntaxhighlight lang="text">
7 - 3 - 1 - 4 - 90 - 9 - 99
7 - 7
1 - 18 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
3 - 2 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
7 - 12
2 - 1 - IMPORTADO - Telemovel - 200 - ELECTRONICA - China - 30
</syntaxhighlight>
}}

=== Mostrar compras ===

Apresenta informações sobre todas as compras, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar compra|Mostrar compra]].

=== Mostrar entregas de uma compra ===

É pedido o identificador da compra e são apresentadas as entregas correspondentes, ordenadas pela data de chegada e, em caso de empate, pelos identificadores dos produtos. Ao contrário de [[#Mostrar compra|Mostrar compra]] (que apresenta as entregas em detalhe), aqui cada entrega é apresentada '''de forma resumida''' (uma linha, apenas com os identificadores dos produtos), de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma entrega|
''idCompra'' - ''data de chegada'' - ''lista de identificadores de produtos''
}}
{{CollapsedCode|Exemplos de apresentação de entregas (compra do exemplo da secção Entregas)|
<syntaxhighlight lang="text">
7 - 7 - 1, 3
7 - 12 - 2
</syntaxhighlight>
}}

= Leitura de Dados a Partir de Ficheiros Textuais =

Além das opções de manipulação de ficheiros descritas no [[#Menu Principal|menu principal]], é possível iniciar a aplicação com um ficheiro de texto especificado pela propriedade Java '''[[#Execução do Programa e Testes Automáticos|import]]'''.

Cada linha tem uma descrição distinta mas que segue o seguinte formato geral. É possível registar empresas, clientes e produtos, e definir os produtos que cada empresa vende. Assume-se que os campos de texto não podem conter o carácter ''':''' e que os preços são números inteiros. Não existem entradas mal-formadas.

Os produtos têm o formato descrito abaixo, respectivamente, para produtos fabricados e importados. O campo ''stock'' indica o número de exemplares disponíveis do produto.

MANUFACTURED:''idEmpresa'':''nome'':''preço'':''categoria'':''prazo'':''stock'':''fabricante'':''codigo''
IMPORTED:''idEmpresa'':''nome'':''preço'':''categoria'':''prazo'':''stock'':''paisOrigem'':''taxa''

O registo de empresas e de clientes segue os formatos:

COMPANY:''nome''
CLIENT:''nome'':''email''

Um exemplo de conteúdo do ficheiro inicial é como se segue:

{{CollapsedCode|Exemplo de ficheiro de entrada textual|
<syntaxhighlight lang="text">
COMPANY:Moageira Nacional
COMPANY:Importadora Atlantico
CLIENT:Obi-Wan Kenobi:obiwan@jedi.org
MANUFACTURED:1:Farinha:15:ALIMENTAR:3:23:Moageira Nacional:F-0091
IMPORTED:2:Telemovel:200:ELECTRONICA:8:2:China:30
MANUFACTURED:1:Camisa:45:VESTUARIO:2:4:Confeccoes Sul:C-1120
</syntaxhighlight>
}}
A codificação dos ficheiros a ler é garantidamente [[wp:UTF-8|UTF-8]].

{{Suggestion|Os métodos '''String.split()''', para partir cadeias de caracteres, e '''String.trim()''', para remover espaços no início e no final, podem ser usados no processamento de cada linha.}}
{{Suggestion|Note-se que o programa nunca produz ficheiros com este formato (é apenas um formato para ficheiros de entrada).}}

= Execução do Programa e Testes Automáticos =

Usando os ficheiros '''test.import''', '''test.in''' e '''test.out''', é possível verificar automaticamente o resultado correcto do programa. Note-se que é necessária a definição apropriada da variável '''CLASSPATH''' (ou da opção equivalente '''-cp''' do comando '''java'''), para localizar as classes do programa, incluindo a que contém o método correspondente ao ponto de entrada da aplicação ('''erp.app.App.main'''). As propriedades são tratadas automaticamente pelo código de apoio.

java -Dimport=test.import -Din=test.in -Dout=test.outhyp erp.app.App

Assumindo que aqueles ficheiros estão no directório onde é dado o comando de execução, o programa produz o ficheiro de saída '''test.outhyp'''. Em caso de sucesso, os ficheiros das saídas esperada ('''test.out''') e obtida ('''test.outhyp''') devem ser iguais. A comparação pode ser feita com o comando:

diff -b test.out test.outhyp

Este comando não deve produzir qualquer resultado quando os ficheiros são iguais. Note-se, contudo, que este teste não garante o correcto funcionamento do código desenvolvido, apenas verificando alguns aspectos da sua funcionalidade.

= Notas de Implementação =

Tal como indicado acima, algumas classes fornecidas como [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|material de apoio]], são de uso obrigatório e não podem ser alteradas. Outras dessas classes são de uso obrigatório e têm de ser alteradas.

A serialização Java usa as classes da ''package'' [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/package-summary.html java.io], em particular, a interface [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/Serializable.html java.io.Serializable] e as classes de leitura [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectInputStream.html java.io.ObjectInputStream] e escrita [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectOutputStream.html java.io.ObjectOutputStream] (entre outras).

[[category: Ensino]]
[[category:PO]]
[[category: Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T09:07:12Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

'''EM PREPARAÇÃO'''

'''ÉPOCA NORMAL'''

O objectivo do projecto é desenvolver um sistema de gestão de entregas rápidas de produtos (ERP — Express Retail Platform). O sistema deverá permitir, entre outras operações, (i) registar dados de empresas; (ii) registar dados de clientes; (iii) registar, gerir e pesquisar produtos; (iv) efectuar e gerir características de compras; (v) gerir as entregas correspondentes; e (vi) notificar os clientes sobre a situação das suas encomendas.

Neste texto, o tipo '''negrito''' indica um literal (i.e., é exactamente como apresentado); o símbolo ␣ indica um espaço; e o tipo ''itálico'' indica uma parte variável (i.e., uma descrição).

= Conceitos e Relações do Modelo =

Existem vários conceitos importantes neste contexto: [[#Empresas|empresas]], [[#Produtos|produtos]], [[#Clientes|clientes]], [[#Compras|compras]] e [[#Encomendas|encomendas]], e [[#Entregas|entregas]].

Os conceitos listados não são os únicos possíveis no modelo e as suas relações (assim como relações com outros conceitos não mencionados) podem depender das escolhas do projecto.

Os clientes e os produtos são independentes das empresas: existem por si e podem relacionar-se com várias empresas. Cada empresa, no entanto, mantém registo dos clientes com quem interage, dos produtos que disponibiliza, das compras feitas e das encomendas que expede.

Uma compra representa a aquisição de produtos por um cliente a uma empresa. Uma compra pode dar origem a uma ou mais encomendas, de acordo com a estratégia de divisão de encomendas utilizada.

Cada encomenda pode ser enviada através de uma determinada transportadora e pode incluir serviços adicionais que alteram o seu custo e/ou prazo de entrega.

== Produtos ==

O sistema mantém um registo global de produtos. Cada produto é identificado por um número de produto. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Todos os produtos têm: um nome/descrição (cadeia de caracteres não vazia); um preço base (número inteiro positivo); uma categoria; e um prazo de entrega base (número inteiro de dias).

O preço base é uma propriedade intrínseca do produto e é definido ao nível do sistema. O preço base é independente das empresas que disponibilizam o produto.

O sistema utiliza o preço base para calcular o preço recomendado do produto. O preço recomendado representa o valor de referência do produto no sistema. O seu cálculo pode depender do tipo de produto e de outras informações disponíveis no sistema.

Cada produto tem uma categoria, de acordo com a sua natureza. Inicialmente, consideram-se as seguintes categorias: (i) alimentar; (ii) electrónica; e (iii) vestuário. Deve ser possível adicionar novas categorias com impacto mínimo na aplicação já desenvolvida.

O produto existe independentemente das empresas que o disponibilizam. Assim, o mesmo produto pode ser disponibilizado por várias empresas, sendo possível que cada uma pratique um preço de venda diferente.

A informação relativa à disponibilização de um produto por uma empresa não deve ser considerada parte das características intrínsecas do produto.

== Tipos de Produto ==

Todos os produtos considerados no sistema são fabricados, mas podem ter diferentes origens.

Inicialmente, consideram-se os seguintes tipos de produto:
* produto nacional;
* produto importado.

Um produto nacional possui apenas as propriedades gerais dos produtos.

Um produto importado possui, para além das propriedades gerais dos produtos:
* um país de origem (cadeia de caracteres não vazia);
* uma taxa alfandegária (número inteiro expressando uma percentagem);
* um prazo de transporte internacional (número inteiro de dias).

O preço recomendado é calculado de forma diferente consoante o tipo de produto.

Deve ser possível introduzir novos tipos de produto com impacto mínimo na implementação desenvolvida.

=== Produtos Nacionais ===

Para um produto nacional, o preço recomendado depende do preço base e do número total de unidades actualmente disponíveis desse produto nas empresas que o disponibilizam.

Se o número total de unidades disponíveis for:
* superior a 10000, o preço recomendado corresponde a 90% do preço base;
* inferior a 100, o preço recomendado corresponde a 130% do preço base;
* nos restantes casos, o preço recomendado corresponde ao preço base.

Por exemplo, considerando um produto nacional com preço base de 100 euros:
* Unidades disponíveis = 50 => Preço recomendado = 130 euros;
* Unidades disponíveis = 5000 => Preço recomendado = 100 euros;
* Unidades disponíveis = 12000 => Preço recomendado = 90 euros.

=== Produtos Importados ===

Para um produto importado, o preço recomendado corresponde ao preço base acrescido da taxa alfandegária.

Se a taxa alfandegária for t%, o preço recomendado é calculado de acordo com:

'''preço base × (100 + t) / 100'''

Por exemplo, considerando um produto importado com preço base de 100 euros e uma taxa alfandegária de 20%, o preço recomendado será:

'''100 × (100 + 20) / 100 = 120 euros'''

O cálculo do preço recomendado deve ser realizado de forma polimórfica, de modo a que o código que utiliza produtos não tenha de conhecer explicitamente o tipo concreto de cada produto.


== Empresas ==

O sistema mantém um registo das empresas que operam na plataforma. Cada empresa é identificada por um número de empresa. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada empresa tem ainda um nome (cadeia de caracteres não vazia).

Uma empresa pode disponibilizar vários produtos. Para cada produto que disponibiliza, a empresa deve manter informação sobre:
* número de unidades disponíveis;
* preço base do produto;
* factor multiplicativo do preço.

Duas empresas podem, assim, disponibilizar o mesmo produto com preços base, factores multiplicativos e quantidades em stock diferentes.

Por exemplo, o produto P1 pode ser disponibilizado pela empresa A com um preço base de 20 euros, um factor multiplicativo de 1,1 e 10 unidades disponíveis, enquanto a empresa B disponibiliza o mesmo produto com um preço base de 18 euros, um factor multiplicativo de 1,0 e 3 unidades disponíveis.

O preço base não corresponde necessariamente ao preço final a pagar pelo cliente. O preço final depende do tipo de produto e das regras aplicáveis ao seu cálculo.

Deve ser possível adicionar outras propriedades às empresas sem impacto significativo no código já desenvolvido.
== Cálculo do Preço ==

O preço final de um produto disponibilizado por uma empresa é determinado por uma estratégia de cálculo de preços.

A estratégia recebe a informação necessária para determinar o preço final, incluindo o produto e os valores definidos pela empresa para a sua disponibilização.

Inicialmente devem ser consideradas, pelo menos, as seguintes estratégias:
* '''preço normal''' — o preço final é calculado considerando o preço base e o factor multiplicativo;
* '''preço promocional''' — o preço final é calculado considerando o preço base, o factor multiplicativo e uma redução percentual definida pela promoção.

O sistema deve permitir introduzir novas estratégias de cálculo de preços sem necessidade de alterar o código responsável por efectuar compras.

Por exemplo, futuramente poderão ser introduzidas estratégias que considerem:
* descontos específicos;
* campanhas temporárias;
* preços específicos para determinados clientes;
* outras regras de formação do preço.

O preço efectivo utilizado numa compra deve ser calculado no momento em que a compra é efectuada.

== Clientes ==

O sistema mantém um registo de clientes. Cada cliente é identificado por um número de cliente. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada cliente tem ainda informação sobre o seu nome e endereço de correio electrónico. Estes campos não podem ser vazios.

Assume-se que os clientes têm sempre dinheiro, i.e., uma compra nunca é recusada por falta de fundos. Deve, no entanto, ser possível discriminar os clientes segundo outros critérios (por exemplo, o volume de compras efectuadas), com um impacto mínimo na implementação desenvolvida.

== Compras ==

O sistema regista as compras efectuadas pelos clientes. Cada compra é identificada por um número de compra, atribuído automaticamente e incrementalmente. Uma compra é sempre feita por um único cliente a uma única empresa numa determinada data.

Uma compra é constituída por um conjunto de linhas (um "cabaz"). Cada linha corresponde a:
* um produto;
* uma quantidade (número de exemplares adquiridos desse produto);
* um preço unitário (o preço do produto no momento da compra);
* um preço total da linha (quantidade × preço unitário).

O preço unitário efectivo utilizado na compra deve ser guardado na própria linha da compra. Uma alteração posterior do preço base do produto pela empresa, do factor multiplicativo da empresa, ou de qualquer outra propriedade relevante para o cálculo do preço, não deve alterar o valor de compras já efectuadas.

O preço total dos itens de uma compra é a soma dos preços totais das suas linhas. A cada compra está ainda associada uma sobretaxa de entrega, correspondente a 10% do preço total dos itens, independentemente do número de entregas.



== Gestão de Stock ==

O stock de um produto é mantido por cada empresa que o disponibiliza.
Assim, duas empresas que disponibilizem o mesmo produto podem ter quantidades diferentes desse produto em stock.
O stock de um produto numa determinada empresa pode ser alterado através da especificação de um valor a somar/subtrair ao número de exemplares disponíveis:
* se a quantidade indicada for positiva, aumenta-se o número de exemplares disponíveis;
* se a quantidade indicada for negativa, decrementa-se o número de exemplares disponíveis desde que o número de exemplares disponíveis não fique negativo.

Caso o número de exemplares disponíveis de um produto numa determinada empresa chegue a 0, o produto deixa de estar disponível nessa empresa.

O produto não é removido do sistema, podendo continuar a ser disponibilizado por outras empresas ou voltar a ser disponibilizado posteriormente pela mesma empresa.

Quando o stock de um produto passa de zero para um valor positivo, o produto volta a estar disponível nessa empresa.

A relação entre uma empresa e um produto pode deixar de existir quando a empresa deixa de disponibilizar esse produto.

O produto global deve, no entanto, continuar a existir no sistema enquanto houver outras razões para a sua existência, independentemente de estar temporariamente disponível ou não em qualquer empresa.

== Entregas ==

A cada compra correspondem uma ou mais entregas. A forma como uma compra é dividida em entregas é determinada por uma estratégia de planeamento de entregas.

Inicialmente devem ser suportadas, pelo menos, as seguintes estratégias: entrega conjunta e entrega individual.

Calcula-se a média dos prazos de entrega dos produtos das linhas da compra:
* todas as linhas cujo produto tem prazo menor ou igual à média são agrupadas numa única entrega (a entrega conjunta);
* cada linha cujo produto tem prazo estritamente maior do que a média é enviada separadamente, numa entrega própria (uma entrega conjunta pode não existir se todas as linhas forem enviadas separadamente).

A estratégia de planeamento de entregas deve poder ser seleccionada e substituída sem alterar o código que representa uma compra.

== Ciclo de Vida das Entregas ==
A estratégia de planeamento de entregas deve poder ser seleccionada e substituída sem alterar o código que representa uma compra.

Inicialmente, são considerados os seguintes estados:
* '''CRIADA''' — a entrega foi criada, mas ainda não foi iniciada a sua preparação;
* '''EM_PREPARAÇÃO''' — os produtos da entrega estão a ser preparados;
* '''ENVIADA''' — os produtos foram expedidos e a entrega encontra-se a caminho do cliente;
* '''ENTREGUE''' — a entrega chegou ao cliente.

Uma entrega é inicialmente criada no estado '''CRIADA'''.

As transições entre estados devem respeitar o seguinte fluxo: '''CRIADA''' → '''EM_PREPARAÇÃO''' → '''ENVIADA''' → '''ENTREGUE'''. Não é possível passar ao estado anterior. Não são possíveis alterações depois de se atingir '''ENTREGUE'''.

As operações permitidas sobre uma entrega podem depender do seu estado actual.
Por exemplo, uma entrega que ainda se encontra no estado '''CRIADA''' pode ser colocada em preparação, enquanto uma entrega no estado '''ENVIADA''' não pode voltar ao estado '''EM_PREPARAÇÃO'''.

O comportamento associado aos diferentes estados de uma entrega deve ser modelado de modo a evitar que todas as regras de transição e de comportamento dependente do estado sejam concentradas numa única classe.

Deve ser possível adicionar novos estados ou alterar as regras de transição existentes com impacto mínimo no código já desenvolvido.

== Data de Chegada das Entregas ==

Cada entrega tem uma data de chegada prevista, calculada a partir da data da compra e do prazo aplicável: uma entrega individual usa o prazo do respectivo produto; uma entrega conjunta usa o maior dos prazos dos produtos que dela fazem parte.

Por exemplo, considere-se uma compra com três linhas cujos produtos têm os prazos de entrega 3 (P1), 8 (P2) e 2 (P3). A média dos prazos é (3 + 8 + 2) / 3 ≈ 4,33. Logo, P1 e P3 (prazos ≤ 4,33) seguem juntos numa entrega e P2 (prazo > 4,33) segue numa entrega separada:
* Entrega A: {P1, P3} (prazo = 3) (entrega conjunta)
* Entrega B: {P2} (prazo = 8) (entrega individual)

A data de chegada prevista da entrega A corresponde à data da compra acrescida de 3 dias.
A data de chegada prevista da entrega B corresponde à data da compra acrescida de 8 dias.

Quando a data actual atinge ou ultrapassa a data de chegada prevista de uma entrega que se encontra no estado '''ENVIADA''', a entrega passa automaticamente para o estado '''ENTREGUE'''.

Uma entrega que ainda não tenha sido enviada não pode passar directamente para o estado '''ENTREGUE''' apenas devido à passagem do tempo.

== Pesquisas ==

Para permitir que o sistema ajude os clientes a determinar a existência de um produto, deverá ser possível efectuar pesquisas. As pesquisas consideram os campos relevantes dos vários produtos.

Inicialmente devem ser suportados, pelo menos, os seguintes critérios de pesquisa:
* nome;
* descrição do produto;
* categoria do produto;
* disponibilidade em stock;
* intervalo de preços.

O termo de pesquisa deve ser comparado sem distinção entre letras maiúsculas e minúsculas (quando aplicável).

O sistema deve permitir seleccionar diferentes estratégias de pesquisa.
Deve ser possível introduzir novos métodos de pesquisa de um produto com um impacto mínimo na implementação desenvolvida. Por exemplo, futuramente poderá ser possível pesquisar produtos por país de origem, por prazo de entrega, ou por combinação de vários critérios.

== Gestão de Tempo ==

A unidade de tempo do sistema é o dia. A data do sistema começa no dia 1 (um) e faz parte do estado persistente.

Sempre que a data é alterada, deve ser verificada a situação das entregas: quando a data actual atinge ou ultrapassa a data de chegada prevista de uma entrega que se encontra no estado '''ENVIADA''', a entrega passa para o estado '''ENTREGUE'''.

Devem ainda ser actualizados outros aspectos que dependam da data actual.

== Notificações ==

Deve existir um mecanismo de notificações que permita avisar eventuais interessados quando os produtos ficam em determinadas situações.
Quando um produto sem qualquer exemplar disponível '''numa determinada empresa''' passa a ter pelo menos um exemplar disponível nessa empresa, quer-se enviar uma notificação a todas as entidades que demonstraram interesse nesta situação.

As notificações de um cliente apenas devem ser apresentadas uma única vez. Após esta visualização, considera-se que o cliente fica sem notificações. As notificações devem ser apresentadas pela mesma ordem em que foram enviadas pelo sistema.

No caso de uma entidade interessada em ser avisada da disponibilidade de um produto numa determinada empresa, isto significa que, sempre que o produto em causa passar da situação de indisponível (zero exemplares disponíveis) para disponível (pelo menos um exemplar disponível), nessa empresa, a entidade deve receber uma notificação.

Deve ser possível definir novas entidades interessadas e novos tipos de notificação, com impacto mínimo no código do domínio da aplicação.

= Requisitos de Desenho =

A aplicação a desenvolver deve seguir o princípio de desenho aberto-fechado, por forma a aumentar a extensibilidade do seu código. Por exemplo, deve ser possível adicionar novos tipos de produto com um impacto mínimo no código já existente da aplicação.

Devem ser possíveis extensões ou alterações de funcionalidade com impacto mínimo no código já produzido para a aplicação. O objectivo é aumentar a flexibilidade da aplicação relativamente ao suporte de novas funções. Assim, deve ser possível:
* Adicionar novos tipos de produto (e.g., produtos digitais ou perecíveis);
* Adicionar novas categorias de produto;
* Definir novas entidades que desejem ser notificadas da disponibilidade de produtos;
* Introduzir novos critérios de discriminação/classificação dos clientes;
* Introduzir novos métodos de pesquisa de produtos;
* Alterar a regra de cálculo das entregas e da sobretaxa de entrega com um impacto mínimo no código existente.

= Funcionalidade da aplicação =

A aplicação permite manter informação sobre as entidades do modelo, permitindo, em particular, gerir empresas, produtos, clientes e compras. Possui ainda a capacidade de preservar o seu estado (não é possível manter várias versões do estado da aplicação em simultâneo).

A aplicação deve estar preparada para que se possa remover qualquer entidade (não apenas produtos).

No [[#Leitura de Dados a Partir de Ficheiros Textuais|início]], a aplicação está vazia, mas pode ser carregada uma base de dados textual com conceitos pré-definidos. Neste caso, a aplicação começará com um estado referente às entidades que foram carregadas no arranque da aplicação.

{{Suggestion|Note-se que não é necessário implementar de raiz a aplicação: já existem classes que representam e definem a interface geral da funcionalidade do ''core'' da aplicação, tal como é visível pelos comandos da aplicação.}}
{{CVSCode|A interface geral do ''core'' já está parcialmente implementada na classe '''erp.ErpManager''' e outras fornecidas (cujos nomes devem ser mantidos), devendo ser adaptadas onde necessário. É ainda necessário criar e implementar as restantes classes que suportam a operação da aplicação.}}

== Serialização ==

É possível guardar e recuperar o estado actual da aplicação, preservando toda a informação relacionada com o ERP e que foi descrita [[#Conceitos e Relações do Modelo|acima]].

= Interacção com o utilizador =

Descreve-se nesta secção a '''funcionalidade máxima''' da interface com o utilizador. Em geral, os comandos pedem toda a informação antes de procederem à sua validação (excepto onde indicado). Todos os menus têm automaticamente a opção '''Sair''' (fecha o menu).

As operações de pedido e apresentação de informação ao utilizador '''devem''' realizar-se através dos objectos ''form'' e ''display'', respectivamente, presentes em cada comando. As mensagens são produzidas pelos métodos das [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|bibliotecas de suporte]] ('''po-uilib''' e '''erp-app'''). As mensagens não podem ser usadas no núcleo da aplicação ('''erp-core'''). Além disso, não podem ser definidas novas. Potenciais omissões devem ser esclarecidas antes de qualquer implementação.

De um modo geral, sempre que no contexto de uma operação com o utilizador aconteça alguma excepção, então a operação não deve ter qualquer efeito no estado da aplicação, excepto em caso de indicação contrária na operação em causa. As excepções estão na package '''erp.app.exceptions''', excepto em caso de indicação contrária.

As excepções usadas na interacção (subclasses de '''pt.tecnico.uilib.menus.CommandException'''), excepto em caso de indicação contrária, são lançadas pelos comandos (subclasses de '''pt.tecnico.uilib.menus.Command''') e tratadas pelos menus (instâncias de subclasses de '''pt.tecnico.uilib.menus.Menu'''). Outras excepções não devem substituir as fornecidas nos casos descritos.

Nos pedidos e usos dos vários identificadores, podem ocorrer as seguintes excepções, caso o identificador indicado não corresponda a um objecto conhecido (excepto no processo de registo ou em caso de indicação contrária). Note-se que estas excepções não são utilizáveis no núcleo da aplicação.
{|
! style="background: #ebebeb;" | '''Tipo de dados'''
! style="background: #ebebeb;" | '''Classe'''
! style="background: #ebebeb;" | '''Pedido a apresentar'''
! style="background: #ebebeb;" | '''Excepção a lançar se desconhecido'''
|-
| Empresa
| '''Company'''
| '''erp.app.company.Prompt.companyId()'''
| '''erp.app.exceptions.UnknownCompanyKeyException'''
|-
| Produto
| '''Product'''
| '''erp.app.product.Prompt.productId()'''
| '''erp.app.exceptions.UnknownProductKeyException'''
|-
| Cliente
| '''Client'''
| '''erp.app.client.Prompt.clientId()'''
| '''erp.app.exceptions.UnknownClientKeyException'''
|-
| Compra
| '''Purchase'''
| '''erp.app.purchase.Prompt.purchaseId()'''
| '''erp.app.exceptions.UnknownPurchaseKeyException'''
|}

Alguns casos particulares podem usar pedidos específicos não apresentados nesta tabela.

{{CVSCode|Note-se que o programa principal e os comandos e menus, a seguir descritos, já estão parcial ou completamente implementados nas ''packages'' '''erp.app''', '''erp.app.main''', '''erp.app.company''', '''erp.app.product''', '''erp.app.client''', '''erp.app.purchase'''. Estas classes são de uso obrigatório e estão disponíveis no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|GIT]] (módulo '''erp-app''').}}

== Menu Principal ==

As acções deste menu permitem gerir a salvaguarda do estado da aplicação e abrir submenus. A lista completa é a seguinte: [[#Salvaguarda do estado actual da aplicação|Abrir]], [[#Salvaguarda do estado actual da aplicação|Guardar]], [[#Mostrar data actual|Mostrar data actual]], [[#Avançar data actual|Avançar data actual]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Empresas]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Produtos]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Clientes]] e [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Compras]]. Inicialmente, a aplicação apenas tem informação sobre as entidades que foram carregadas no arranque.

{{CVSCode|As etiquetas das opções deste menu estão definidas na classe '''erp.app.main.Label'''. Todos os métodos correspondentes às mensagens de diálogo para este menu estão definidos na classe '''erp.app.main.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.main''', respectivamente: '''DoOpenFile''', '''DoSaveFile''', '''DoDisplayDate''', '''DoAdvanceDate''', '''DoOpenMenuCompanies''', '''DoOpenMenuProducts''', '''DoOpenMenuClients''', '''DoOpenMenuPurchases'''.}}

=== Salvaguarda do estado actual da aplicação ===

O conteúdo da aplicação (toda a informação detida pelo ERP actualmente em memória) pode ser guardado para posterior recuperação (via serialização Java: '''java.io.Serializable'''). Na leitura e escrita do estado da aplicação, devem ser tratadas as excepções associadas. A funcionalidade é a seguinte:

* '''Abrir''' -- Carrega os dados de uma sessão anterior a partir de um ficheiro previamente guardado (ficando este ficheiro associado à aplicação, para futuras operações de salvaguarda). Pede-se o nome do ficheiro a abrir ('''Prompt.openFile()'''). Caso ocorra um problema na abertura ou processamento do ficheiro, deve ser lançada a excepção '''FileOpenFailedException'''. A execução bem-sucedida desta opção substitui toda a informação da aplicação. Quando se abandona uma aplicação com modificações não guardadas (porque se abre outra e existem alterações não guardadas), deve perguntar-se ao utilizador se quer guardar a informação actual antes de a abandonar, através de '''Prompt.saveBeforeExit()''' (a resposta é obtida via '''Form.confirm()''').

* '''Guardar''' -- Guarda o estado actual da aplicação no ficheiro associado. Se não existir associação, pede-se o nome do ficheiro a utilizar, ficando a ele associado (para operações de salvaguarda subsequentes). Esta interacção realiza-se através do método '''Prompt.newSaveAs()'''. Não é executada nenhuma acção se não existirem alterações desde a última salvaguarda.

{{Suggestion|Note-se que a opção '''Abrir''' não permite a leitura de ficheiros de texto (estes apenas podem ser utilizados no início da aplicação).}}
{{Suggestion|A opção '''Sair''' nunca implica a salvaguarda do estado da aplicação, mesmo que existam alterações.}}

=== Mostrar data actual ===

A data actual do sistema é apresentada através da mensagem '''Message.currentDate()'''.

=== Avançar data actual ===

O número de dias a avançar é pedido através de '''Prompt.daysToAdvance()'''. O valor indicado deve ser positivo. Caso contrário, a operação não tem efeito.

Além da data, o sistema deve actualizar, caso seja necessário, outros aspectos que dela dependam, designadamente, a situação das entregas relativa às suas datas de chegada.

=== Gestão e consulta de dados da aplicação ===

* '''Menu de Gestão de Empresas''' -- Abre o menu de gestão de empresas e operações associadas.
* '''Menu de Gestão de Produtos''' -- Abre o menu de gestão de produtos e operações associadas.
* '''Menu de Gestão de Clientes''' -- Abre o menu de gestão de clientes e operações associadas.
* '''Menu de Gestão de Compras''' -- Abre o menu de gestão de compras e operações associadas.

== Menu de Gestão de Empresas ==

Este menu permite efectuar operações sobre a base de dados de empresas. A lista completa é a seguinte: [[#Registar empresa|Registar empresa]], [[#Mostrar empresa|Mostrar empresa]], [[#Mostrar empresas|Mostrar empresas]], [[#Mostrar produtos de uma empresa|Mostrar produtos de uma empresa]], [[#Mostrar clientes de uma empresa|Mostrar clientes de uma empresa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.company.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.company.Prompt''' e '''erp.app.company.Message'''.}}

=== Registar empresa ===

Pede o nome ('''Prompt.companyName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CompanyRegistrationFailedException'''.

Note-se que a atribuição do identificador da empresa é automática.

=== Mostrar empresa ===

É pedido o identificador da empresa, sendo apresentadas as informações sobre essa empresa, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

=== Mostrar empresas ===

Apresenta informações sobre todas as empresas, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar empresa|Mostrar empresa]].

=== Mostrar produtos de uma empresa ===

É pedido o identificador da empresa e apresentam-se os produtos que essa empresa vende, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar produto|Mostrar produto]].

=== Mostrar clientes de uma empresa ===

É pedido o identificador da empresa e apresentam-se os clientes que já interagiram com essa empresa, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar cliente|Mostrar cliente]].

== Menu de Gestão de Produtos ==

Este menu apresenta as operações disponíveis sobre produtos. A lista completa é a seguinte: [[#Mostrar produto|Mostrar produto]], [[#Mostrar produtos|Mostrar produtos]], [[#Alterar inventário de um produto|Alterar inventário de um produto]] e [[#Efectuar pesquisa|Efectuar pesquisa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.product.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.product.Prompt''' e '''erp.app.product.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.product''' (disponível no GIT), respectivamente: '''DoShowProduct''', '''DoShowProducts''', '''DoChangeProductInventory''', '''DoPerformSearch'''.}}

=== Mostrar produto ===

É pedido o identificador do produto. Se o produto existir, é apresentado de acordo com o seguinte formato. O formato genérico de apresentação de um produto é como se segue:
{{CollapsedCode|Formato de apresentação de produtos|
''id'' - ''stock'' - ''tipo'' - ''nome'' - ''preço'' - ''categoria'' - ''informação adicional''
}}

Para produtos fabricados, a informação adicional corresponde ao nome do fabricante e ao código de fabrico (separados pelo carácter ''';'''); para produtos importados, a informação adicional corresponde ao país de origem e à taxa alfandegária.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
3 - 20 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
4 - 2 - IMPORTADO - Telemóvel - 200 - ELECTRONICA - China - 30
5 - 0 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

=== Mostrar produtos ===

Apresenta informações sobre todos os produtos, ordenando-os pelos seus identificadores. O formato de apresentação é como descrito em [[#Mostrar produto|Mostrar produto]].

=== Alterar inventário de um produto ===

É pedido o identificador de um produto e uma quantidade ('''Prompt.amountToUpdate()''') e actualizado o número de exemplares disponíveis do produto indicado somando a quantidade indicada ao número de exemplares disponíveis. No caso de não ser possível actualizar o número de exemplares devido ao facto de a quantidade indicada ser inválida, então a operação não deve ter qualquer efeito e deve ser apresentada a mensagem '''Message.notEnoughInventory()'''.

=== Efectuar pesquisa ===

Esta opção realiza uma procura por termo (cadeia de caracteres), pedido através de '''Prompt.searchTerm()'''. Como resultado, deve ser apresentada uma lista dos produtos encontrados pela pesquisa, ordenados por ordem crescente do seu identificador, utilizando o formato descrito para [[#Mostrar produto|Mostrar produto]].

O termo de pesquisa deve ser comparado (sem distinção entre letras maiúsculas e minúsculas) com os campos relevantes de cada produto: o nome e a categoria. Só devem ser apresentados produtos que contenham o termo de pesquisa num dos campos relevantes. Caso não sejam encontrados produtos, não deve ser produzido qualquer resultado.

== Menu de Gestão de Clientes ==

Este menu permite efectuar operações sobre a base de dados de clientes. A lista completa é a seguinte: [[#Registar cliente|Registar cliente]], [[#Mostrar cliente|Mostrar cliente]], [[#Mostrar clientes|Mostrar clientes]], [[#Mostrar notificações do cliente|Mostrar notificações do cliente]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.client.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.client.Prompt''' e '''erp.app.client.Message'''.}}

=== Registar cliente ===

Pede o nome ('''Prompt.clientName()''') e o endereço de correio electrónico ('''Prompt.clientEMail()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''ClientRegistrationFailedException'''.

Note-se que a atribuição do identificador do cliente é automática e que clientes diferentes são registados em cada operação de registo.

=== Mostrar cliente ===

É pedido o identificador do cliente, sendo apresentadas as informações sobre esse cliente, de acordo com o seguinte formato. O valor apresentado após o email corresponde ao total gasto pelo cliente em compras (um valor inteiro).
{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''gasto total''
}}
{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Alberto Meireles - ameireles@mymail.com - 275
1 - Fernando Meireles - fmeireles@mymail.com - 0
</syntaxhighlight>
}}

=== Mostrar clientes ===

Apresenta informações sobre todos os clientes, ordenando-os lexicograficamente pelo nome. Caso existam clientes com o mesmo nome, devem ser ordenados por ordem crescente dos seus identificadores. O formato é o descrito em [[#Mostrar cliente|Mostrar cliente]].

=== Mostrar notificações do cliente ===

É pedido o identificador do cliente, sendo apresentadas as notificações para esse cliente, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação das notificações de um cliente|
DISPONIBILIDADE: ''descrição de produto disponível''
}}
{{CollapsedCode|Exemplos de notificações|
<syntaxhighlight lang="text">
DISPONIBILIDADE: 5 - 4 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

Note-se que a descrição é idêntica à que é realizada para mostrar cada produto. No entanto, a solução deve ser suficientemente flexível para permitir outros formatos de apresentação das notificações (sem impacto no código do domínio da aplicação).

== Menu de Gestão de Compras ==

Este menu apresenta as operações relacionadas com compras e entregas. A lista completa é a seguinte: [[#Efectuar compra|Efectuar compra]], [[#Mostrar compra|Mostrar compra]], [[#Mostrar compras|Mostrar compras]], [[#Mostrar entregas de uma compra|Mostrar entregas de uma compra]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.purchase.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.purchase.Prompt''' e '''erp.app.purchase.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.purchase''' (disponível no GIT), respectivamente: '''DoDoPurchase''', '''DoShowPurchase''', '''DoShowPurchases''', '''DoShowPurchaseDeliveries'''.}}

=== Efectuar compra ===

No processo de efectuar uma compra, o sistema pede, primeiro, a identificação do cliente; de seguida, a identificação da empresa a que a compra é feita; e, finalmente, para cada linha, o identificador do produto e a quantidade pretendida ('''Prompt.productId()''' e '''Prompt.amountToBuy()'''). O processo de adição de linhas termina de acordo com a interacção definida no comando.

Se não houver exemplares suficientes de um produto para satisfazer a quantidade pretendida, deve ser apresentada a mensagem '''Message.notEnoughInventory()''' e essa linha não é adicionada. Concluída a compra, o ''stock'' dos produtos é decrementado, a empresa passa a seguir o cliente e são determinadas as entregas correspondentes. A data limite de chegada de cada entrega é comunicada através da mensagem '''Message.deliveryDate()'''.

=== Mostrar compra ===

É pedido o identificador da compra. Na primeira linha apresenta-se a informação da compra; de seguida, apresentam-se as suas entregas '''em detalhe''' — cada entrega (identificador da compra e data de chegada) seguida da descrição completa de cada um dos seus produtos (o mesmo formato de [[#Mostrar produto|Mostrar produto]]). O formato é o seguinte:
{{CollapsedCode|Formato de apresentação de uma compra (com entregas em detalhe)|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''sobretaxa de entrega'' - ''preço total''
''idCompra'' - ''data de chegada''
''descrição de produto''
...
}}
{{CollapsedCode|Exemplos de apresentação de compras|
<syntaxhighlight lang="text">
7 - 3 - 1 - 4 - 90 - 9 - 99
7 - 7
1 - 18 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
3 - 2 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
7 - 12
2 - 1 - IMPORTADO - Telemovel - 200 - ELECTRONICA - China - 30
</syntaxhighlight>
}}

=== Mostrar compras ===

Apresenta informações sobre todas as compras, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar compra|Mostrar compra]].

=== Mostrar entregas de uma compra ===

É pedido o identificador da compra e são apresentadas as entregas correspondentes, ordenadas pela data de chegada e, em caso de empate, pelos identificadores dos produtos. Ao contrário de [[#Mostrar compra|Mostrar compra]] (que apresenta as entregas em detalhe), aqui cada entrega é apresentada '''de forma resumida''' (uma linha, apenas com os identificadores dos produtos), de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma entrega|
''idCompra'' - ''data de chegada'' - ''lista de identificadores de produtos''
}}
{{CollapsedCode|Exemplos de apresentação de entregas (compra do exemplo da secção Entregas)|
<syntaxhighlight lang="text">
7 - 7 - 1, 3
7 - 12 - 2
</syntaxhighlight>
}}

= Leitura de Dados a Partir de Ficheiros Textuais =

Além das opções de manipulação de ficheiros descritas no [[#Menu Principal|menu principal]], é possível iniciar a aplicação com um ficheiro de texto especificado pela propriedade Java '''[[#Execução do Programa e Testes Automáticos|import]]'''.

Cada linha tem uma descrição distinta mas que segue o seguinte formato geral. É possível registar empresas, clientes e produtos, e definir os produtos que cada empresa vende. Assume-se que os campos de texto não podem conter o carácter ''':''' e que os preços são números inteiros. Não existem entradas mal-formadas.

Os produtos têm o formato descrito abaixo, respectivamente, para produtos fabricados e importados. O campo ''stock'' indica o número de exemplares disponíveis do produto.

MANUFACTURED:''idEmpresa'':''nome'':''preço'':''categoria'':''prazo'':''stock'':''fabricante'':''codigo''
IMPORTED:''idEmpresa'':''nome'':''preço'':''categoria'':''prazo'':''stock'':''paisOrigem'':''taxa''

O registo de empresas e de clientes segue os formatos:

COMPANY:''nome''
CLIENT:''nome'':''email''

Um exemplo de conteúdo do ficheiro inicial é como se segue:

{{CollapsedCode|Exemplo de ficheiro de entrada textual|
<syntaxhighlight lang="text">
COMPANY:Moageira Nacional
COMPANY:Importadora Atlantico
CLIENT:Obi-Wan Kenobi:obiwan@jedi.org
MANUFACTURED:1:Farinha:15:ALIMENTAR:3:23:Moageira Nacional:F-0091
IMPORTED:2:Telemovel:200:ELECTRONICA:8:2:China:30
MANUFACTURED:1:Camisa:45:VESTUARIO:2:4:Confeccoes Sul:C-1120
</syntaxhighlight>
}}
A codificação dos ficheiros a ler é garantidamente [[wp:UTF-8|UTF-8]].

{{Suggestion|Os métodos '''String.split()''', para partir cadeias de caracteres, e '''String.trim()''', para remover espaços no início e no final, podem ser usados no processamento de cada linha.}}
{{Suggestion|Note-se que o programa nunca produz ficheiros com este formato (é apenas um formato para ficheiros de entrada).}}

= Execução do Programa e Testes Automáticos =

Usando os ficheiros '''test.import''', '''test.in''' e '''test.out''', é possível verificar automaticamente o resultado correcto do programa. Note-se que é necessária a definição apropriada da variável '''CLASSPATH''' (ou da opção equivalente '''-cp''' do comando '''java'''), para localizar as classes do programa, incluindo a que contém o método correspondente ao ponto de entrada da aplicação ('''erp.app.App.main'''). As propriedades são tratadas automaticamente pelo código de apoio.

java -Dimport=test.import -Din=test.in -Dout=test.outhyp erp.app.App

Assumindo que aqueles ficheiros estão no directório onde é dado o comando de execução, o programa produz o ficheiro de saída '''test.outhyp'''. Em caso de sucesso, os ficheiros das saídas esperada ('''test.out''') e obtida ('''test.outhyp''') devem ser iguais. A comparação pode ser feita com o comando:

diff -b test.out test.outhyp

Este comando não deve produzir qualquer resultado quando os ficheiros são iguais. Note-se, contudo, que este teste não garante o correcto funcionamento do código desenvolvido, apenas verificando alguns aspectos da sua funcionalidade.

= Notas de Implementação =

Tal como indicado acima, algumas classes fornecidas como [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|material de apoio]], são de uso obrigatório e não podem ser alteradas. Outras dessas classes são de uso obrigatório e têm de ser alteradas.

A serialização Java usa as classes da ''package'' [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/package-summary.html java.io], em particular, a interface [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/Serializable.html java.io.Serializable] e as classes de leitura [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectInputStream.html java.io.ObjectInputStream] e escrita [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectOutputStream.html java.io.ObjectOutputStream] (entre outras).

[[category: Ensino]]
[[category:PO]]
[[category: Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T08:34:16Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

'''EM PREPARAÇÃO'''

'''ÉPOCA NORMAL'''

O objectivo do projecto é desenvolver um sistema de gestão de '''entregas rápidas de produtos''' (ERP). O sistema deverá permitir, entre outras operações, (i) registar dados de empresas; (ii) registar dados de clientes; (iii) registar e pesquisar produtos; (iv) efectuar compras; e (v) gerir as entregas correspondentes.

Neste texto, o tipo '''negrito''' indica um literal (i.e., é exactamente como apresentado); o símbolo ␣ indica um espaço; e o tipo ''itálico'' indica uma parte variável (i.e., uma descrição).

= Conceitos e Relações do Modelo =

Existem vários conceitos importantes neste contexto: [[#Empresas|empresas]], [[#Produtos|produtos]], [[#Clientes|clientes]], [[#Compras|compras]] e [[#Entregas|entregas]].

Os conceitos listados não são os únicos possíveis no modelo e as suas relações (assim como relações com outros conceitos não mencionados) podem depender das escolhas do projecto.

Os clientes e os produtos são independentes das empresas: existem por si e podem relacionar-se com várias empresas.

Cada produto pode estar disponível em mais do que uma empresa. Quando uma empresa disponibiliza um produto, deve indicar:
* o número de unidades do produto que tem disponíveis;
* o preço base a que disponibiliza o produto;
* um factor multiplicativo a aplicar ao preço base.

O número de unidades disponíveis, o preço base e o factor multiplicativo podem ser diferentes para cada empresa que disponibiliza o mesmo produto.

Cada empresa mantém ainda registo:
* dos produtos que disponibiliza;
* dos clientes com que já interagiu (i.e., que lhe fizeram compras);
* das entregas que efectuou.

== Empresas ==

O sistema mantém um registo das empresas que operam na plataforma. Cada empresa é identificada por um número de empresa. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada empresa tem ainda um nome (cadeia de caracteres não vazia).

Uma empresa pode disponibilizar vários produtos. Para cada produto que disponibiliza, a empresa deve manter informação sobre:
* número de unidades disponíveis;
* preço base do produto;
* factor multiplicativo do preço.

Duas empresas podem, assim, disponibilizar o mesmo produto com preços base, factores multiplicativos e quantidades em stock diferentes.

Por exemplo, o produto P1 pode ser disponibilizado pela empresa A com um preço base de 20 euros, um factor multiplicativo de 1,1 e 10 unidades disponíveis, enquanto a empresa B disponibiliza o mesmo produto com um preço base de 18 euros, um factor multiplicativo de 1,0 e 3 unidades disponíveis.

O preço base não corresponde necessariamente ao preço final a pagar pelo cliente. O preço final depende do tipo de produto e das regras aplicáveis ao seu cálculo.

Deve ser possível adicionar outras propriedades às empresas sem impacto significativo no código já desenvolvido.

== Produtos ==

O sistema mantém um registo global de produtos. Cada produto é identificado por um número de produto. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Todos os produtos têm um nome/descrição (cadeia de caracteres não vazia), uma categoria e um prazo de entrega (número inteiro de dias).

Cada produto tem uma categoria, de acordo com a sua natureza. Inicialmente, consideram-se as seguintes categorias: (i) alimentar; (ii) electrónica; e (iii) vestuário. Deve ser possível adicionar novas categorias com impacto mínimo na aplicação já desenvolvida.

O produto existe independentemente das empresas que o disponibilizam. Assim, o mesmo produto pode ser disponibilizado por várias empresas, sendo possível que cada uma pratique um preço base diferente, utilize um factor multiplicativo diferente e disponha de uma quantidade diferente em stock.

A informação relativa à disponibilização de um produto por uma empresa não deve ser considerada parte das características intrínsecas do produto.

== Tipos de Produto ==

Todos os produtos considerados no sistema são fabricados, mas podem ter diferentes origens.

Inicialmente, consideram-se os seguintes tipos de produto:
* produto nacional;
* produto importado.

Um produto nacional possui apenas as propriedades gerais dos produtos.

Um produto importado possui, para além das propriedades gerais dos produtos:
* um país de origem (cadeia de caracteres não vazia);
* uma taxa alfandegária (número inteiro).

A taxa alfandegária representa um custo adicional associado à importação do produto.

O tipo de produto deve ter impacto no cálculo do preço final do produto.

O preço final de um produto disponibilizado por uma empresa deve ser calculado a partir:
* do preço base definido pela empresa;
* do factor multiplicativo definido pela empresa;
* das características específicas do produto.

Para um produto nacional, o preço final corresponde ao preço base multiplicado pelo factor multiplicativo aplicável à disponibilização do produto pela empresa.

Para um produto importado, o preço final corresponde ao preço base multiplicado pelo factor multiplicativo aplicável à disponibilização do produto pela empresa, acrescido da taxa alfandegária.

Por exemplo, se uma empresa disponibilizar um produto com preço base de 100 euros e factor multiplicativo de 1,1:
* um produto nacional terá preço final de 110 euros;
* um produto importado com taxa alfandegária de 20 euros terá preço final de 130 euros.

O cálculo do preço final deve ser realizado de forma polimórfica, de modo a que o código que utiliza produtos não tenha de conhecer explicitamente o tipo concreto de cada produto.

Deve ser possível introduzir novos tipos de produto com impacto mínimo na implementação desenvolvida.

== Cálculo do Preço ==

O preço final de um produto disponibilizado por uma empresa é determinado por uma estratégia de cálculo de preços.

A estratégia recebe a informação necessária para determinar o preço final, incluindo o produto e os valores definidos pela empresa para a sua disponibilização.

Inicialmente devem ser consideradas, pelo menos, as seguintes estratégias:
* '''preço normal''' — o preço final é calculado considerando o preço base e o factor multiplicativo;
* '''preço promocional''' — o preço final é calculado considerando o preço base, o factor multiplicativo e uma redução percentual definida pela promoção.

O sistema deve permitir introduzir novas estratégias de cálculo de preços sem necessidade de alterar o código responsável por efectuar compras.

Por exemplo, futuramente poderão ser introduzidas estratégias que considerem:
* descontos específicos;
* campanhas temporárias;
* preços específicos para determinados clientes;
* outras regras de formação do preço.

O preço efectivo utilizado numa compra deve ser calculado no momento em que a compra é efectuada.

== Clientes ==

O sistema mantém um registo de clientes. Cada cliente é identificado por um número de cliente. O identificador é atribuído automaticamente e incrementalmente (a partir de 1 ou do último valor atribuído, caso o estado do sistema tenha sido recuperado). Cada cliente tem ainda informação sobre o seu nome e endereço de correio electrónico. Estes campos não podem ser vazios.

Assume-se que os clientes têm sempre dinheiro, i.e., uma compra nunca é recusada por falta de fundos. Deve, no entanto, ser possível discriminar os clientes segundo outros critérios (por exemplo, o volume de compras efectuadas), com um impacto mínimo na implementação desenvolvida.

== Compras ==

O sistema regista as compras efectuadas pelos clientes. Cada compra é identificada por um número de compra, atribuído automaticamente e incrementalmente. Uma compra é sempre feita por um único cliente a uma única empresa numa determinada data.

Uma compra é constituída por um conjunto de linhas (um "cabaz"). Cada linha corresponde a:
* um produto;
* uma quantidade (número de exemplares adquiridos desse produto);
* um preço unitário (o preço do produto no momento da compra);
* um preço total da linha (quantidade × preço unitário).

O preço unitário efectivo utilizado na compra deve ser guardado na própria linha da compra. Uma alteração posterior do preço base do produto pela empresa, do factor multiplicativo da empresa, ou de qualquer outra propriedade relevante para o cálculo do preço, não deve alterar o valor de compras já efectuadas.

O preço total dos itens de uma compra é a soma dos preços totais das suas linhas. A cada compra está ainda associada uma sobretaxa de entrega, correspondente a 10% do preço total dos itens, independentemente do número de entregas.



== Gestão de Stock ==

O stock de um produto é mantido por cada empresa que o disponibiliza.
Assim, duas empresas que disponibilizem o mesmo produto podem ter quantidades diferentes desse produto em stock.
O stock de um produto numa determinada empresa pode ser alterado através da especificação de um valor a somar/subtrair ao número de exemplares disponíveis:
* se a quantidade indicada for positiva, aumenta-se o número de exemplares disponíveis;
* se a quantidade indicada for negativa, decrementa-se o número de exemplares disponíveis desde que o número de exemplares disponíveis não fique negativo.

Caso o número de exemplares disponíveis de um produto numa determinada empresa chegue a 0, o produto deixa de estar disponível nessa empresa.

O produto não é removido do sistema, podendo continuar a ser disponibilizado por outras empresas ou voltar a ser disponibilizado posteriormente pela mesma empresa.

Quando o stock de um produto passa de zero para um valor positivo, o produto volta a estar disponível nessa empresa.

A relação entre uma empresa e um produto pode deixar de existir quando a empresa deixa de disponibilizar esse produto.

O produto global deve, no entanto, continuar a existir no sistema enquanto houver outras razões para a sua existência, independentemente de estar temporariamente disponível ou não em qualquer empresa.

== Entregas ==

A cada compra correspondem uma ou mais entregas. A forma como uma compra é dividida em entregas é determinada por uma estratégia de planeamento de entregas.

Inicialmente devem ser suportadas, pelo menos, as seguintes estratégias: entrega conjunta e entrega individual.

Calcula-se a média dos prazos de entrega dos produtos das linhas da compra:
* todas as linhas cujo produto tem prazo menor ou igual à média são agrupadas numa única entrega (a entrega conjunta);
* cada linha cujo produto tem prazo estritamente maior do que a média é enviada separadamente, numa entrega própria (uma entrega conjunta pode não existir se todas as linhas forem enviadas separadamente).

A estratégia de planeamento de entregas deve poder ser seleccionada e substituída sem alterar o código que representa uma compra.

== Ciclo de Vida das Entregas ==
A estratégia de planeamento de entregas deve poder ser seleccionada e substituída sem alterar o código que representa uma compra.

Inicialmente, são considerados os seguintes estados:
* '''CRIADA''' — a entrega foi criada, mas ainda não foi iniciada a sua preparação;
* '''EM_PREPARAÇÃO''' — os produtos da entrega estão a ser preparados;
* '''ENVIADA''' — os produtos foram expedidos e a entrega encontra-se a caminho do cliente;
* '''ENTREGUE''' — a entrega chegou ao cliente.

Uma entrega é inicialmente criada no estado '''CRIADA'''.

As transições entre estados devem respeitar o seguinte fluxo: '''CRIADA''' → '''EM_PREPARAÇÃO''' → '''ENVIADA''' → '''ENTREGUE'''. Não é possível passar ao estado anterior. Não são possíveis alterações depois de se atingir '''ENTREGUE'''.

As operações permitidas sobre uma entrega podem depender do seu estado actual.
Por exemplo, uma entrega que ainda se encontra no estado '''CRIADA''' pode ser colocada em preparação, enquanto uma entrega no estado '''ENVIADA''' não pode voltar ao estado '''EM_PREPARAÇÃO'''.

O comportamento associado aos diferentes estados de uma entrega deve ser modelado de modo a evitar que todas as regras de transição e de comportamento dependente do estado sejam concentradas numa única classe.

Deve ser possível adicionar novos estados ou alterar as regras de transição existentes com impacto mínimo no código já desenvolvido.

== Data de Chegada das Entregas ==

Cada entrega tem uma data de chegada prevista, calculada a partir da data da compra e do prazo aplicável: uma entrega individual usa o prazo do respectivo produto; uma entrega conjunta usa o maior dos prazos dos produtos que dela fazem parte.

Por exemplo, considere-se uma compra com três linhas cujos produtos têm os prazos de entrega 3 (P1), 8 (P2) e 2 (P3). A média dos prazos é (3 + 8 + 2) / 3 ≈ 4,33. Logo, P1 e P3 (prazos ≤ 4,33) seguem juntos numa entrega e P2 (prazo > 4,33) segue numa entrega separada:
* Entrega A: {P1, P3} (prazo = 3) (entrega conjunta)
* Entrega B: {P2} (prazo = 8) (entrega individual)

A data de chegada prevista da entrega A corresponde à data da compra acrescida de 3 dias.
A data de chegada prevista da entrega B corresponde à data da compra acrescida de 8 dias.

Quando a data actual atinge ou ultrapassa a data de chegada prevista de uma entrega que se encontra no estado '''ENVIADA''', a entrega passa automaticamente para o estado '''ENTREGUE'''.

Uma entrega que ainda não tenha sido enviada não pode passar directamente para o estado '''ENTREGUE''' apenas devido à passagem do tempo.

== Pesquisas ==

Para permitir que o sistema ajude os clientes a determinar a existência de um produto, deverá ser possível efectuar pesquisas. As pesquisas consideram os campos relevantes dos vários produtos.

Inicialmente devem ser suportados, pelo menos, os seguintes critérios de pesquisa:
* nome;
* descrição do produto;
* categoria do produto;
* disponibilidade em stock;
* intervalo de preços.

O termo de pesquisa deve ser comparado sem distinção entre letras maiúsculas e minúsculas (quando aplicável).

O sistema deve permitir seleccionar diferentes estratégias de pesquisa.
Deve ser possível introduzir novos métodos de pesquisa de um produto com um impacto mínimo na implementação desenvolvida. Por exemplo, futuramente poderá ser possível pesquisar produtos por país de origem, por prazo de entrega, ou por combinação de vários critérios.

== Gestão de Tempo ==

A unidade de tempo do sistema é o dia. A data do sistema começa no dia 1 (um) e faz parte do estado persistente.

Sempre que a data é alterada, deve ser verificada a situação das entregas: quando a data actual atinge ou ultrapassa a data de chegada prevista de uma entrega que se encontra no estado '''ENVIADA''', a entrega passa para o estado '''ENTREGUE'''.

Devem ainda ser actualizados outros aspectos que dependam da data actual.

== Notificações ==

Deve existir um mecanismo de notificações que permita avisar eventuais interessados quando os produtos ficam em determinadas situações.
Quando um produto sem qualquer exemplar disponível '''numa determinada empresa''' passa a ter pelo menos um exemplar disponível nessa empresa, quer-se enviar uma notificação a todas as entidades que demonstraram interesse nesta situação.

As notificações de um cliente apenas devem ser apresentadas uma única vez. Após esta visualização, considera-se que o cliente fica sem notificações. As notificações devem ser apresentadas pela mesma ordem em que foram enviadas pelo sistema.

No caso de uma entidade interessada em ser avisada da disponibilidade de um produto numa determinada empresa, isto significa que, sempre que o produto em causa passar da situação de indisponível (zero exemplares disponíveis) para disponível (pelo menos um exemplar disponível), nessa empresa, a entidade deve receber uma notificação.

Deve ser possível definir novas entidades interessadas e novos tipos de notificação, com impacto mínimo no código do domínio da aplicação.

= Requisitos de Desenho =

A aplicação a desenvolver deve seguir o princípio de desenho aberto-fechado, por forma a aumentar a extensibilidade do seu código. Por exemplo, deve ser possível adicionar novos tipos de produto com um impacto mínimo no código já existente da aplicação.

Devem ser possíveis extensões ou alterações de funcionalidade com impacto mínimo no código já produzido para a aplicação. O objectivo é aumentar a flexibilidade da aplicação relativamente ao suporte de novas funções. Assim, deve ser possível:
* Adicionar novos tipos de produto (e.g., produtos digitais ou perecíveis);
* Adicionar novas categorias de produto;
* Definir novas entidades que desejem ser notificadas da disponibilidade de produtos;
* Introduzir novos critérios de discriminação/classificação dos clientes;
* Introduzir novos métodos de pesquisa de produtos;
* Alterar a regra de cálculo das entregas e da sobretaxa de entrega com um impacto mínimo no código existente.

= Funcionalidade da aplicação =

A aplicação permite manter informação sobre as entidades do modelo, permitindo, em particular, gerir empresas, produtos, clientes e compras. Possui ainda a capacidade de preservar o seu estado (não é possível manter várias versões do estado da aplicação em simultâneo).

A aplicação deve estar preparada para que se possa remover qualquer entidade (não apenas produtos).

No [[#Leitura de Dados a Partir de Ficheiros Textuais|início]], a aplicação está vazia, mas pode ser carregada uma base de dados textual com conceitos pré-definidos. Neste caso, a aplicação começará com um estado referente às entidades que foram carregadas no arranque da aplicação.

{{Suggestion|Note-se que não é necessário implementar de raiz a aplicação: já existem classes que representam e definem a interface geral da funcionalidade do ''core'' da aplicação, tal como é visível pelos comandos da aplicação.}}
{{CVSCode|A interface geral do ''core'' já está parcialmente implementada na classe '''erp.ErpManager''' e outras fornecidas (cujos nomes devem ser mantidos), devendo ser adaptadas onde necessário. É ainda necessário criar e implementar as restantes classes que suportam a operação da aplicação.}}

== Serialização ==

É possível guardar e recuperar o estado actual da aplicação, preservando toda a informação relacionada com o ERP e que foi descrita [[#Conceitos e Relações do Modelo|acima]].

= Interacção com o utilizador =

Descreve-se nesta secção a '''funcionalidade máxima''' da interface com o utilizador. Em geral, os comandos pedem toda a informação antes de procederem à sua validação (excepto onde indicado). Todos os menus têm automaticamente a opção '''Sair''' (fecha o menu).

As operações de pedido e apresentação de informação ao utilizador '''devem''' realizar-se através dos objectos ''form'' e ''display'', respectivamente, presentes em cada comando. As mensagens são produzidas pelos métodos das [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|bibliotecas de suporte]] ('''po-uilib''' e '''erp-app'''). As mensagens não podem ser usadas no núcleo da aplicação ('''erp-core'''). Além disso, não podem ser definidas novas. Potenciais omissões devem ser esclarecidas antes de qualquer implementação.

De um modo geral, sempre que no contexto de uma operação com o utilizador aconteça alguma excepção, então a operação não deve ter qualquer efeito no estado da aplicação, excepto em caso de indicação contrária na operação em causa. As excepções estão na package '''erp.app.exceptions''', excepto em caso de indicação contrária.

As excepções usadas na interacção (subclasses de '''pt.tecnico.uilib.menus.CommandException'''), excepto em caso de indicação contrária, são lançadas pelos comandos (subclasses de '''pt.tecnico.uilib.menus.Command''') e tratadas pelos menus (instâncias de subclasses de '''pt.tecnico.uilib.menus.Menu'''). Outras excepções não devem substituir as fornecidas nos casos descritos.

Nos pedidos e usos dos vários identificadores, podem ocorrer as seguintes excepções, caso o identificador indicado não corresponda a um objecto conhecido (excepto no processo de registo ou em caso de indicação contrária). Note-se que estas excepções não são utilizáveis no núcleo da aplicação.
{|
! style="background: #ebebeb;" | '''Tipo de dados'''
! style="background: #ebebeb;" | '''Classe'''
! style="background: #ebebeb;" | '''Pedido a apresentar'''
! style="background: #ebebeb;" | '''Excepção a lançar se desconhecido'''
|-
| Empresa
| '''Company'''
| '''erp.app.company.Prompt.companyId()'''
| '''erp.app.exceptions.UnknownCompanyKeyException'''
|-
| Produto
| '''Product'''
| '''erp.app.product.Prompt.productId()'''
| '''erp.app.exceptions.UnknownProductKeyException'''
|-
| Cliente
| '''Client'''
| '''erp.app.client.Prompt.clientId()'''
| '''erp.app.exceptions.UnknownClientKeyException'''
|-
| Compra
| '''Purchase'''
| '''erp.app.purchase.Prompt.purchaseId()'''
| '''erp.app.exceptions.UnknownPurchaseKeyException'''
|}

Alguns casos particulares podem usar pedidos específicos não apresentados nesta tabela.

{{CVSCode|Note-se que o programa principal e os comandos e menus, a seguir descritos, já estão parcial ou completamente implementados nas ''packages'' '''erp.app''', '''erp.app.main''', '''erp.app.company''', '''erp.app.product''', '''erp.app.client''', '''erp.app.purchase'''. Estas classes são de uso obrigatório e estão disponíveis no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|GIT]] (módulo '''erp-app''').}}

== Menu Principal ==

As acções deste menu permitem gerir a salvaguarda do estado da aplicação e abrir submenus. A lista completa é a seguinte: [[#Salvaguarda do estado actual da aplicação|Abrir]], [[#Salvaguarda do estado actual da aplicação|Guardar]], [[#Mostrar data actual|Mostrar data actual]], [[#Avançar data actual|Avançar data actual]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Empresas]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Produtos]], [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Clientes]] e [[#Gestão e consulta de dados da aplicação|Menu de Gestão de Compras]]. Inicialmente, a aplicação apenas tem informação sobre as entidades que foram carregadas no arranque.

{{CVSCode|As etiquetas das opções deste menu estão definidas na classe '''erp.app.main.Label'''. Todos os métodos correspondentes às mensagens de diálogo para este menu estão definidos na classe '''erp.app.main.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.main''', respectivamente: '''DoOpenFile''', '''DoSaveFile''', '''DoDisplayDate''', '''DoAdvanceDate''', '''DoOpenMenuCompanies''', '''DoOpenMenuProducts''', '''DoOpenMenuClients''', '''DoOpenMenuPurchases'''.}}

=== Salvaguarda do estado actual da aplicação ===

O conteúdo da aplicação (toda a informação detida pelo ERP actualmente em memória) pode ser guardado para posterior recuperação (via serialização Java: '''java.io.Serializable'''). Na leitura e escrita do estado da aplicação, devem ser tratadas as excepções associadas. A funcionalidade é a seguinte:

* '''Abrir''' -- Carrega os dados de uma sessão anterior a partir de um ficheiro previamente guardado (ficando este ficheiro associado à aplicação, para futuras operações de salvaguarda). Pede-se o nome do ficheiro a abrir ('''Prompt.openFile()'''). Caso ocorra um problema na abertura ou processamento do ficheiro, deve ser lançada a excepção '''FileOpenFailedException'''. A execução bem-sucedida desta opção substitui toda a informação da aplicação. Quando se abandona uma aplicação com modificações não guardadas (porque se abre outra e existem alterações não guardadas), deve perguntar-se ao utilizador se quer guardar a informação actual antes de a abandonar, através de '''Prompt.saveBeforeExit()''' (a resposta é obtida via '''Form.confirm()''').

* '''Guardar''' -- Guarda o estado actual da aplicação no ficheiro associado. Se não existir associação, pede-se o nome do ficheiro a utilizar, ficando a ele associado (para operações de salvaguarda subsequentes). Esta interacção realiza-se através do método '''Prompt.newSaveAs()'''. Não é executada nenhuma acção se não existirem alterações desde a última salvaguarda.

{{Suggestion|Note-se que a opção '''Abrir''' não permite a leitura de ficheiros de texto (estes apenas podem ser utilizados no início da aplicação).}}
{{Suggestion|A opção '''Sair''' nunca implica a salvaguarda do estado da aplicação, mesmo que existam alterações.}}

=== Mostrar data actual ===

A data actual do sistema é apresentada através da mensagem '''Message.currentDate()'''.

=== Avançar data actual ===

O número de dias a avançar é pedido através de '''Prompt.daysToAdvance()'''. O valor indicado deve ser positivo. Caso contrário, a operação não tem efeito.

Além da data, o sistema deve actualizar, caso seja necessário, outros aspectos que dela dependam, designadamente, a situação das entregas relativa às suas datas de chegada.

=== Gestão e consulta de dados da aplicação ===

* '''Menu de Gestão de Empresas''' -- Abre o menu de gestão de empresas e operações associadas.
* '''Menu de Gestão de Produtos''' -- Abre o menu de gestão de produtos e operações associadas.
* '''Menu de Gestão de Clientes''' -- Abre o menu de gestão de clientes e operações associadas.
* '''Menu de Gestão de Compras''' -- Abre o menu de gestão de compras e operações associadas.

== Menu de Gestão de Empresas ==

Este menu permite efectuar operações sobre a base de dados de empresas. A lista completa é a seguinte: [[#Registar empresa|Registar empresa]], [[#Mostrar empresa|Mostrar empresa]], [[#Mostrar empresas|Mostrar empresas]], [[#Mostrar produtos de uma empresa|Mostrar produtos de uma empresa]], [[#Mostrar clientes de uma empresa|Mostrar clientes de uma empresa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.company.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.company.Prompt''' e '''erp.app.company.Message'''.}}

=== Registar empresa ===

Pede o nome ('''Prompt.companyName()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''CompanyRegistrationFailedException'''.

Note-se que a atribuição do identificador da empresa é automática.

=== Mostrar empresa ===

É pedido o identificador da empresa, sendo apresentadas as informações sobre essa empresa, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma empresa|
''id'' - ''nome''
}}

=== Mostrar empresas ===

Apresenta informações sobre todas as empresas, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar empresa|Mostrar empresa]].

=== Mostrar produtos de uma empresa ===

É pedido o identificador da empresa e apresentam-se os produtos que essa empresa vende, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar produto|Mostrar produto]].

=== Mostrar clientes de uma empresa ===

É pedido o identificador da empresa e apresentam-se os clientes que já interagiram com essa empresa, ordenados pelos seus identificadores, utilizando o formato descrito em [[#Mostrar cliente|Mostrar cliente]].

== Menu de Gestão de Produtos ==

Este menu apresenta as operações disponíveis sobre produtos. A lista completa é a seguinte: [[#Mostrar produto|Mostrar produto]], [[#Mostrar produtos|Mostrar produtos]], [[#Alterar inventário de um produto|Alterar inventário de um produto]] e [[#Efectuar pesquisa|Efectuar pesquisa]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.product.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.product.Prompt''' e '''erp.app.product.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.product''' (disponível no GIT), respectivamente: '''DoShowProduct''', '''DoShowProducts''', '''DoChangeProductInventory''', '''DoPerformSearch'''.}}

=== Mostrar produto ===

É pedido o identificador do produto. Se o produto existir, é apresentado de acordo com o seguinte formato. O formato genérico de apresentação de um produto é como se segue:
{{CollapsedCode|Formato de apresentação de produtos|
''id'' - ''stock'' - ''tipo'' - ''nome'' - ''preço'' - ''categoria'' - ''informação adicional''
}}

Para produtos fabricados, a informação adicional corresponde ao nome do fabricante e ao código de fabrico (separados pelo carácter ''';'''); para produtos importados, a informação adicional corresponde ao país de origem e à taxa alfandegária.

{{CollapsedCode|Exemplos de apresentação de produtos|
<syntaxhighlight lang="text">
3 - 20 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
4 - 2 - IMPORTADO - Telemóvel - 200 - ELECTRONICA - China - 30
5 - 0 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

=== Mostrar produtos ===

Apresenta informações sobre todos os produtos, ordenando-os pelos seus identificadores. O formato de apresentação é como descrito em [[#Mostrar produto|Mostrar produto]].

=== Alterar inventário de um produto ===

É pedido o identificador de um produto e uma quantidade ('''Prompt.amountToUpdate()''') e actualizado o número de exemplares disponíveis do produto indicado somando a quantidade indicada ao número de exemplares disponíveis. No caso de não ser possível actualizar o número de exemplares devido ao facto de a quantidade indicada ser inválida, então a operação não deve ter qualquer efeito e deve ser apresentada a mensagem '''Message.notEnoughInventory()'''.

=== Efectuar pesquisa ===

Esta opção realiza uma procura por termo (cadeia de caracteres), pedido através de '''Prompt.searchTerm()'''. Como resultado, deve ser apresentada uma lista dos produtos encontrados pela pesquisa, ordenados por ordem crescente do seu identificador, utilizando o formato descrito para [[#Mostrar produto|Mostrar produto]].

O termo de pesquisa deve ser comparado (sem distinção entre letras maiúsculas e minúsculas) com os campos relevantes de cada produto: o nome e a categoria. Só devem ser apresentados produtos que contenham o termo de pesquisa num dos campos relevantes. Caso não sejam encontrados produtos, não deve ser produzido qualquer resultado.

== Menu de Gestão de Clientes ==

Este menu permite efectuar operações sobre a base de dados de clientes. A lista completa é a seguinte: [[#Registar cliente|Registar cliente]], [[#Mostrar cliente|Mostrar cliente]], [[#Mostrar clientes|Mostrar clientes]], [[#Mostrar notificações do cliente|Mostrar notificações do cliente]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.client.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.client.Prompt''' e '''erp.app.client.Message'''.}}

=== Registar cliente ===

Pede o nome ('''Prompt.clientName()''') e o endereço de correio electrónico ('''Prompt.clientEMail()'''). O registo bem sucedido é assinalado através da mensagem '''Message.registrationSuccessful()'''; caso contrário, é lançada a excepção '''ClientRegistrationFailedException'''.

Note-se que a atribuição do identificador do cliente é automática e que clientes diferentes são registados em cada operação de registo.

=== Mostrar cliente ===

É pedido o identificador do cliente, sendo apresentadas as informações sobre esse cliente, de acordo com o seguinte formato. O valor apresentado após o email corresponde ao total gasto pelo cliente em compras (um valor inteiro).
{{CollapsedCode|Formato de apresentação de um cliente|
''id'' - ''nome'' - ''email'' - ''gasto total''
}}
{{CollapsedCode|Exemplos de apresentação de clientes|
<syntaxhighlight lang="text">
2 - Alberto Meireles - ameireles@mymail.com - 275
1 - Fernando Meireles - fmeireles@mymail.com - 0
</syntaxhighlight>
}}

=== Mostrar clientes ===

Apresenta informações sobre todos os clientes, ordenando-os lexicograficamente pelo nome. Caso existam clientes com o mesmo nome, devem ser ordenados por ordem crescente dos seus identificadores. O formato é o descrito em [[#Mostrar cliente|Mostrar cliente]].

=== Mostrar notificações do cliente ===

É pedido o identificador do cliente, sendo apresentadas as notificações para esse cliente, de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação das notificações de um cliente|
DISPONIBILIDADE: ''descrição de produto disponível''
}}
{{CollapsedCode|Exemplos de notificações|
<syntaxhighlight lang="text">
DISPONIBILIDADE: 5 - 4 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
</syntaxhighlight>
}}

Note-se que a descrição é idêntica à que é realizada para mostrar cada produto. No entanto, a solução deve ser suficientemente flexível para permitir outros formatos de apresentação das notificações (sem impacto no código do domínio da aplicação).

== Menu de Gestão de Compras ==

Este menu apresenta as operações relacionadas com compras e entregas. A lista completa é a seguinte: [[#Efectuar compra|Efectuar compra]], [[#Mostrar compra|Mostrar compra]], [[#Mostrar compras|Mostrar compras]], [[#Mostrar entregas de uma compra|Mostrar entregas de uma compra]].

{{CVSCode|As etiquetas das opções deste menu estão definidas em '''erp.app.purchase.Label'''. Os métodos correspondentes às mensagens de diálogo para este menu estão definidos em '''erp.app.purchase.Prompt''' e '''erp.app.purchase.Message'''.}}
{{CVSCode|Estes comandos já estão implementados nas classes da ''package'' '''erp.app.purchase''' (disponível no GIT), respectivamente: '''DoDoPurchase''', '''DoShowPurchase''', '''DoShowPurchases''', '''DoShowPurchaseDeliveries'''.}}

=== Efectuar compra ===

No processo de efectuar uma compra, o sistema pede, primeiro, a identificação do cliente; de seguida, a identificação da empresa a que a compra é feita; e, finalmente, para cada linha, o identificador do produto e a quantidade pretendida ('''Prompt.productId()''' e '''Prompt.amountToBuy()'''). O processo de adição de linhas termina de acordo com a interacção definida no comando.

Se não houver exemplares suficientes de um produto para satisfazer a quantidade pretendida, deve ser apresentada a mensagem '''Message.notEnoughInventory()''' e essa linha não é adicionada. Concluída a compra, o ''stock'' dos produtos é decrementado, a empresa passa a seguir o cliente e são determinadas as entregas correspondentes. A data limite de chegada de cada entrega é comunicada através da mensagem '''Message.deliveryDate()'''.

=== Mostrar compra ===

É pedido o identificador da compra. Na primeira linha apresenta-se a informação da compra; de seguida, apresentam-se as suas entregas '''em detalhe''' — cada entrega (identificador da compra e data de chegada) seguida da descrição completa de cada um dos seus produtos (o mesmo formato de [[#Mostrar produto|Mostrar produto]]). O formato é o seguinte:
{{CollapsedCode|Formato de apresentação de uma compra (com entregas em detalhe)|
''id'' - ''idCliente'' - ''idEmpresa'' - ''data'' - ''preço total dos itens'' - ''sobretaxa de entrega'' - ''preço total''
''idCompra'' - ''data de chegada''
''descrição de produto''
...
}}
{{CollapsedCode|Exemplos de apresentação de compras|
<syntaxhighlight lang="text">
7 - 3 - 1 - 4 - 90 - 9 - 99
7 - 7
1 - 18 - FABRICADO - Farinha - 15 - ALIMENTAR - Moageira Nacional; F-0091
3 - 2 - FABRICADO - Camisa - 45 - VESTUARIO - Confeccoes Sul; C-1120
7 - 12
2 - 1 - IMPORTADO - Telemovel - 200 - ELECTRONICA - China - 30
</syntaxhighlight>
}}

=== Mostrar compras ===

Apresenta informações sobre todas as compras, ordenando-as pelos seus identificadores. O formato é o descrito em [[#Mostrar compra|Mostrar compra]].

=== Mostrar entregas de uma compra ===

É pedido o identificador da compra e são apresentadas as entregas correspondentes, ordenadas pela data de chegada e, em caso de empate, pelos identificadores dos produtos. Ao contrário de [[#Mostrar compra|Mostrar compra]] (que apresenta as entregas em detalhe), aqui cada entrega é apresentada '''de forma resumida''' (uma linha, apenas com os identificadores dos produtos), de acordo com o seguinte formato:
{{CollapsedCode|Formato de apresentação de uma entrega|
''idCompra'' - ''data de chegada'' - ''lista de identificadores de produtos''
}}
{{CollapsedCode|Exemplos de apresentação de entregas (compra do exemplo da secção Entregas)|
<syntaxhighlight lang="text">
7 - 7 - 1, 3
7 - 12 - 2
</syntaxhighlight>
}}

= Leitura de Dados a Partir de Ficheiros Textuais =

Além das opções de manipulação de ficheiros descritas no [[#Menu Principal|menu principal]], é possível iniciar a aplicação com um ficheiro de texto especificado pela propriedade Java '''[[#Execução do Programa e Testes Automáticos|import]]'''.

Cada linha tem uma descrição distinta mas que segue o seguinte formato geral. É possível registar empresas, clientes e produtos, e definir os produtos que cada empresa vende. Assume-se que os campos de texto não podem conter o carácter ''':''' e que os preços são números inteiros. Não existem entradas mal-formadas.

Os produtos têm o formato descrito abaixo, respectivamente, para produtos fabricados e importados. O campo ''stock'' indica o número de exemplares disponíveis do produto.

MANUFACTURED:''idEmpresa'':''nome'':''preço'':''categoria'':''prazo'':''stock'':''fabricante'':''codigo''
IMPORTED:''idEmpresa'':''nome'':''preço'':''categoria'':''prazo'':''stock'':''paisOrigem'':''taxa''

O registo de empresas e de clientes segue os formatos:

COMPANY:''nome''
CLIENT:''nome'':''email''

Um exemplo de conteúdo do ficheiro inicial é como se segue:

{{CollapsedCode|Exemplo de ficheiro de entrada textual|
<syntaxhighlight lang="text">
COMPANY:Moageira Nacional
COMPANY:Importadora Atlantico
CLIENT:Obi-Wan Kenobi:obiwan@jedi.org
MANUFACTURED:1:Farinha:15:ALIMENTAR:3:23:Moageira Nacional:F-0091
IMPORTED:2:Telemovel:200:ELECTRONICA:8:2:China:30
MANUFACTURED:1:Camisa:45:VESTUARIO:2:4:Confeccoes Sul:C-1120
</syntaxhighlight>
}}
A codificação dos ficheiros a ler é garantidamente [[wp:UTF-8|UTF-8]].

{{Suggestion|Os métodos '''String.split()''', para partir cadeias de caracteres, e '''String.trim()''', para remover espaços no início e no final, podem ser usados no processamento de cada linha.}}
{{Suggestion|Note-se que o programa nunca produz ficheiros com este formato (é apenas um formato para ficheiros de entrada).}}

= Execução do Programa e Testes Automáticos =

Usando os ficheiros '''test.import''', '''test.in''' e '''test.out''', é possível verificar automaticamente o resultado correcto do programa. Note-se que é necessária a definição apropriada da variável '''CLASSPATH''' (ou da opção equivalente '''-cp''' do comando '''java'''), para localizar as classes do programa, incluindo a que contém o método correspondente ao ponto de entrada da aplicação ('''erp.app.App.main'''). As propriedades são tratadas automaticamente pelo código de apoio.

java -Dimport=test.import -Din=test.in -Dout=test.outhyp erp.app.App

Assumindo que aqueles ficheiros estão no directório onde é dado o comando de execução, o programa produz o ficheiro de saída '''test.outhyp'''. Em caso de sucesso, os ficheiros das saídas esperada ('''test.out''') e obtida ('''test.outhyp''') devem ser iguais. A comparação pode ser feita com o comando:

diff -b test.out test.outhyp

Este comando não deve produzir qualquer resultado quando os ficheiros são iguais. Note-se, contudo, que este teste não garante o correcto funcionamento do código desenvolvido, apenas verificando alguns aspectos da sua funcionalidade.

= Notas de Implementação =

Tal como indicado acima, algumas classes fornecidas como [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|material de apoio]], são de uso obrigatório e não podem ser alteradas. Outras dessas classes são de uso obrigatório e têm de ser alteradas.

A serialização Java usa as classes da ''package'' [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/package-summary.html java.io], em particular, a interface [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/Serializable.html java.io.Serializable] e as classes de leitura [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectInputStream.html java.io.ObjectInputStream] e escrita [https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/io/ObjectOutputStream.html java.io.ObjectOutputStream] (entre outras).

[[category: Ensino]]
[[category:PO]]
[[category: Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T08:08:40Z

Root:

Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027 (rascunho)

2026-08-26T07:59:21Z

Root:

Programação com Objectos/Pautas 2026-2027/Pauta Global da Disciplina

2026-08-26T07:21:38Z

Root:

__NOTOC__
== Pauta Global ==

Aqui: https://bit.ly/po26-pautas (Fénix)
{{Suggestion|Quaisquer dúvidas relativas a esta informação devem ser enviadas ao responsável pela disciplina.}}
{{Suggestion|Esta pauta corresponde ao projecto de época normal.}}

== Prazo de Revisão ==

* '''Época Normal:''' ver prazo de revisão nas páginas correspondentes às provas em curso.  '''EM ACTUALIZAÇÃO'''
* '''Época Especial:''' provas a realizar em Julho de 2027 (ver datas na página da disciplina: Fénix) 

== Legenda ==

Não existem arredondamentos (excepto na coluna '''FINAL''').

Condições de aprovação: '''NOTA''', '''EXR''', '''PRJ''', '''EE''' têm de ser iguais ou superiores a 9.5.

Legenda:

* '''FINAL''' - resultado da avaliação (será lançado na secretaria)
* '''NOTA''' - resultado numérico da avaliação (quando aplicável)
* '''EXR''' - nota final dos exercícios de programação
* '''PRJ''' - nota final do projecto (inclui nota do teste prático)
* '''EE''' - época especial (6 exercícios de programação)

As notações especiais têm o seguinte significado:
* '''NA''' - "não avaliado"
* '''RE''' - "reprovado"

[[category: Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta do Projecto: Entrega Final

2026-08-26T07:21:00Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
__NOTOC__



'''A entrega final é obrigatória''' e vale 11 valores em 20 (5.5 valores para a avaliação automática).'''

'''Projectos que não estejam nas condições indicadas nos [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|critérios de avaliação]] não são considerados, conduzindo a reprovação. Não existem excepções.'''

{{Suggestion|Quaisquer dúvidas relativas a esta informação devem ser enviadas ao responsável pela disciplina.}}
{{Suggestion|Esta pauta corresponde ao projecto de época normal.}}

== Pauta ==
Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazo de Revisão ==

Ver anúncio correspondente no Fénix.

==Legenda ==

Existem factores aditivos positivos (colunas a verde) e negativos (colunas laranja).

'''NA''' na coluna "Nota" indica "não avaliado" (grupo excluído da avaliação da disciplina em época normal no lectivo actual).

O significado das anotações é semelhante ao das utilizadas na pauta da entrega intermédia.

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[category:Pautas de PO - Época Normal]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta do Projecto: Entrega Intermédia

2026-08-26T07:20:42Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
__NOTOC__




'''A entrega intermédia é obrigatória''' e vale 6 valores em 20.

'''Projectos que não estejam nas condições indicadas nos [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|critérios de avaliação]] não são considerados, conduzindo a reprovação. Não existem excepções.'''

Os alunos devem compreender/verificar/corrigir os problemas reportados.

{{Suggestion|Quaisquer dúvidas relativas a esta informação devem ser enviadas ao responsável pela disciplina.}}
{{Suggestion|Esta pauta corresponde ao projecto de época normal.}}

== Pauta ==

Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazo de Revisão ==

Esta pauta está em revisão até à data da entrega final do projecto.

== Legenda ==

Existem factores aditivos positivos (colunas a verde) e negativos (colunas laranja).

A coluna "Auto" indica a percentagem de teste automáticos certos e vale 2.5 valores.

'''NA''' na coluna "Nota" indica "não avaliado" (grupo excluído da avaliação da disciplina em época normal no lectivo actual).

{| class="mw-collapsible mw-collapsed wikitable" align="right" style="border-style: solid; border-width: 1px; border-color: #bbbbaa; background: #f7f8ff;"
! style="padding-left:10px; padding-right:10px; border-style: solid; border-width: 0px; border-bottom-width: 0px; border-color: #bbbbaa; background: #d7d8ed;" | '''Explicação dos testes automáticos'''
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 1px; border-color: #bbbbaa; " |
Ver avaliação automática no GitLab (RNL): https://gitlab.rnl.tecnico.ulisboa.pt/leic-a-po26/eval/po26

São consideradas irrelevantes diferenças que consistam apenas em quantidade de espaços brancos (não ter espaços é considerada uma diferença).

|}

{| class="mw-collapsible mw-collapsed wikitable" align="right" style="border-style: solid; border-width: 1px; border-color: #bbbbaa; background: #f7f8ff;"
! style="padding-left:10px; padding-right:10px; border-style: solid; border-width: 0px; border-bottom-width: 0px; border-color: #bbbbaa; background: #d7d8ed;" | '''Explicação das anotações'''
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 1px; border-color: #bbbbaa; " |
'''Atributos não públicos:'''
* public - atributos públicos
* protected - atributos protected (potencialmente desnecessária a qualificação)
* package - atributos sem qualificação de acesso
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Atributos e métodos não “static”'''
* (const) - contantes
* (comparator) - constantes (comparador)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Serialização'''
* ois - problemas na utilização de ObjectInputStream
* oos - problemas na utilização de ObjectOutputStream
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Utilização de estruturas de dados correctas'''
* lists - utilização de listas onde se justifica a utilização de mapas
* generics - falta de parâmetro em tipo paramétrico
* Object - utilização directa da classe Object (sem ser para satisfazer um requisito de Java)
* Exception - utilização directa da classe Exception (processamento indiscriminado de excepções)
* instanceof - uso de instanceof (não é justificável numa solução de boa qualidade) (idem para getClass)
* System.* - problemas na utilização de canais de I/O
* app attrs/fields - definição de atributos em classes da app: deveriam ser variáveis locais a métodos ou simplesmente não existir
* ArrayList/TreeMap/HashSet/etc. - uso de tipos concretos em declarações de atributos (usar List/Map/Set/etc.)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Separação app/core'''
* serialization - uso de primitivas de serialização na app
* options - não uso de processo de escolha de opções
* reader - criação do leitor do ficheiro indicado pela propriedade "import" na app
* core exposed - exposição desnecessária de estruturas/abstracções do core
* except - não tratamento de excepções na app
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Qualidade do projecto (apreciação global)'''
* instanceof - uso de instanceof (não é justificável numa solução de boa qualidade) (idem para getClass)
* Object - utilização directa da classe Object (sem ser para satisfazer um requisito de Java)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Javadoc'''
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Seguir regras codificação'''
* class - erros de nomenclatura (maus nomes para classes)
* vars - erros de nomenclatura (maus nomes para variáveis)
* funcs - erros de nomenclatura (maus nomes para funções)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Lixo no Repositório'''
* [outras anotações] - consultar professor responsável (horário de dúvidas)
|}

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[category:Pautas de PO - Época Normal]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta do Projecto: Entrega Intermédia

2026-08-26T07:20:22Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
__NOTOC__




'''A entrega intermédia é obrigatória''' e vale 6 valores em 20.

'''Projectos que não estejam nas condições indicadas nos [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|critérios de avaliação]] não são considerados, conduzindo a reprovação. Não existem excepções.'''

{{Suggestion|Os alunos devem compreender/verificar/corrigir os problemas reportados.}}

{{Suggestion|Quaisquer dúvidas relativas a esta informação devem ser enviadas ao responsável pela disciplina.}}
{{Suggestion|Esta pauta corresponde ao projecto de época normal.}}

== Pauta ==

Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazo de Revisão ==

Esta pauta está em revisão até à data da entrega final do projecto.

== Legenda ==

Existem factores aditivos positivos (colunas a verde) e negativos (colunas laranja).

A coluna "Auto" indica a percentagem de teste automáticos certos e vale 2.5 valores.

'''NA''' na coluna "Nota" indica "não avaliado" (grupo excluído da avaliação da disciplina em época normal no lectivo actual).

{| class="mw-collapsible mw-collapsed wikitable" align="right" style="border-style: solid; border-width: 1px; border-color: #bbbbaa; background: #f7f8ff;"
! style="padding-left:10px; padding-right:10px; border-style: solid; border-width: 0px; border-bottom-width: 0px; border-color: #bbbbaa; background: #d7d8ed;" | '''Explicação dos testes automáticos'''
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 1px; border-color: #bbbbaa; " |
Ver avaliação automática no GitLab (RNL): https://gitlab.rnl.tecnico.ulisboa.pt/leic-a-po26/eval/po26

São consideradas irrelevantes diferenças que consistam apenas em quantidade de espaços brancos (não ter espaços é considerada uma diferença).

|}

{| class="mw-collapsible mw-collapsed wikitable" align="right" style="border-style: solid; border-width: 1px; border-color: #bbbbaa; background: #f7f8ff;"
! style="padding-left:10px; padding-right:10px; border-style: solid; border-width: 0px; border-bottom-width: 0px; border-color: #bbbbaa; background: #d7d8ed;" | '''Explicação das anotações'''
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 1px; border-color: #bbbbaa; " |
'''Atributos não públicos:'''
* public - atributos públicos
* protected - atributos protected (potencialmente desnecessária a qualificação)
* package - atributos sem qualificação de acesso
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Atributos e métodos não “static”'''
* (const) - contantes
* (comparator) - constantes (comparador)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Serialização'''
* ois - problemas na utilização de ObjectInputStream
* oos - problemas na utilização de ObjectOutputStream
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Utilização de estruturas de dados correctas'''
* lists - utilização de listas onde se justifica a utilização de mapas
* generics - falta de parâmetro em tipo paramétrico
* Object - utilização directa da classe Object (sem ser para satisfazer um requisito de Java)
* Exception - utilização directa da classe Exception (processamento indiscriminado de excepções)
* instanceof - uso de instanceof (não é justificável numa solução de boa qualidade) (idem para getClass)
* System.* - problemas na utilização de canais de I/O
* app attrs/fields - definição de atributos em classes da app: deveriam ser variáveis locais a métodos ou simplesmente não existir
* ArrayList/TreeMap/HashSet/etc. - uso de tipos concretos em declarações de atributos (usar List/Map/Set/etc.)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Separação app/core'''
* serialization - uso de primitivas de serialização na app
* options - não uso de processo de escolha de opções
* reader - criação do leitor do ficheiro indicado pela propriedade "import" na app
* core exposed - exposição desnecessária de estruturas/abstracções do core
* except - não tratamento de excepções na app
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Qualidade do projecto (apreciação global)'''
* instanceof - uso de instanceof (não é justificável numa solução de boa qualidade) (idem para getClass)
* Object - utilização directa da classe Object (sem ser para satisfazer um requisito de Java)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Javadoc'''
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Seguir regras codificação'''
* class - erros de nomenclatura (maus nomes para classes)
* vars - erros de nomenclatura (maus nomes para variáveis)
* funcs - erros de nomenclatura (maus nomes para funções)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Lixo no Repositório'''
* [outras anotações] - consultar professor responsável (horário de dúvidas)
|}

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[category:Pautas de PO - Época Normal]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta das Aulas Práticas

2026-08-26T07:19:18Z

Root: /* Legenda */

__NOTOC__

'''EM ACTUALIZAÇÃO'''

A avaliação nestas aulas é obrigatória e não é repetível fora da semana em que cada exercício é realizado. 
Não se avaliam alunos fora do turno de inscrição.

Alunos que compareçam atrasados a estas aulas não são avaliados. 
É admitido um limite máximo de 20 minutos para entrada em cada aula, após a hora definida para a aula (i.e., já contabilizando os 10 minutos do início).

Não são considerados casos especiais na avaliação das aulas práticas. Alunos que considerem ter direito a tratamento especial e que não consigam comparecer com aproveitamento nestas aulas poderão requerer avaliação em época especial.
{{Suggestion|Quaisquer dúvidas relativas a esta informação devem ser enviadas ao responsável pela disciplina.}}
{{Suggestion|Esta pauta corresponde ao projecto de época normal.}}

== Pauta ==

Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazos de revisão ==

Ver anúncio correspondente a cada semana no Fénix.

== Legenda ==
As colunas agregadas da pauta têm o seguinte significado:
* ''Nota'' indica a nota final (são contabilizados os 10 melhores exercícios)
* ''Média'' indica a média dos exercícios apresentados (são contabilizados todos os exercícios para a média: é meramente indicativa e não é usada na avaliação)

As classificações possíveis para cada exercício são:

* 0.00 - ignorância (quase) completa da matéria em avaliação
* 0.25 - erros graves ou solução muito incompleta ou inadequada
* 0.50 - erros importantes ou solução incompleta
* 0.75 - erros menos graves ou solução quase completa
* 1.00 - solução completa

{{Aviso|Obter classificações abaixo de 0.75 deve constituir motivo de preocupação, especialmente nos casos 0 e 0.25, sendo os alunos fortemente encorajados a contactar o responsável pela disciplina para consulta dos exercícios em causa.}}

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta das Aulas Práticas

2026-08-26T07:18:54Z

Root:

__NOTOC__

'''EM ACTUALIZAÇÃO'''

A avaliação nestas aulas é obrigatória e não é repetível fora da semana em que cada exercício é realizado. 
Não se avaliam alunos fora do turno de inscrição.

Alunos que compareçam atrasados a estas aulas não são avaliados. 
É admitido um limite máximo de 20 minutos para entrada em cada aula, após a hora definida para a aula (i.e., já contabilizando os 10 minutos do início).

Não são considerados casos especiais na avaliação das aulas práticas. Alunos que considerem ter direito a tratamento especial e que não consigam comparecer com aproveitamento nestas aulas poderão requerer avaliação em época especial.
{{Suggestion|Quaisquer dúvidas relativas a esta informação devem ser enviadas ao responsável pela disciplina.}}
{{Suggestion|Esta pauta corresponde ao projecto de época normal.}}

== Pauta ==

Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazos de revisão ==

Ver anúncio correspondente a cada semana no Fénix.

== Legenda ==
As colunas agregadas da pauta têm o seguinte significado:
* ''Nota'' indica a nota final (são contabilizados os 10 melhores exercícios)
* ''Média'' indica a média dos exercícios apresentados (são contabilizados todos os exercícios para a média: é meramente indicativa e não é usada na avaliação)

As classificações possíveis para cada exercício são:

* 0.00 - ignorância (quase) completa da matéria em avaliação
* 0.25 - erros graves ou solução muito incompleta ou inadequada
* 0.50 - erros importantes ou solução incompleta
* 0.75 - erros menos graves ou solução quase completa
* 1.00 - solução completa

Obter classificações abaixo de 0.75 deve constituir motivo de preocupação, especialmente nos casos 0 e 0.25, sendo os alunos fortemente encorajados a contactar o responsável pela disciplina para consulta dos exercícios em causa.

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta do Projecto: UML

2026-08-26T07:18:30Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
__NOTOC__

'''EM ACTUALIZAÇÃO'''


'''A entrega inicial é obrigatória''' e vale 3 valores em 20.

'''Projectos que não estejam nas condições indicadas nos [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|critérios de avaliação]] não são considerados, conduzindo a reprovação. Não existem excepções.'''

{{Suggestion|Quaisquer dúvidas relativas a esta informação devem ser enviadas ao responsável pela disciplina.}}
{{Suggestion|Esta pauta corresponde ao projecto de época normal.}}

== Pauta ==

Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazo de Revisão ==

Os resultados da avaliação dos diagramas UML podem ser revistos até à data da entrega intermédia do projecto.

Aconselha-se celeridade no processo de revisão, pois algumas questões têm impacto na qualidade do código.

As aulas teóricas podem ser utilizadas para esclarecer dúvidas sobre as anotações na pauta.

== Legenda ==

Existem factores aditivos positivos (colunas a verde) e negativos (coluna laranja). As colunas sombreadas indicam o grau de completude dos diagramas correspondentes a cada caso (0 indica diagrama em falta, 0.25 indica diagrama inadequado para o problema, 1 indica diagrama adequado para o problema).

'''NA''' na coluna "Nota" indica "não avaliado" (grupo excluído da avaliação da disciplina em época normal no lectivo actual).
{| class="mw-collapsible mw-collapsed wikitable" align="right" style="border-style: solid; border-width: 1px; border-color: #bbbbaa; background: #f7f8ff;"
! style="padding-left:10px; padding-right:10px; border-style: solid; border-width: 0px; border-bottom-width: 0px; border-color: #bbbbaa; background: #d7d8ed;" | '''Explicação dos testes automáticos'''
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 1px; border-color: #bbbbaa; " |
Ver avaliação automática no GitLab (RNL): https://gitlab.rnl.tecnico.ulisboa.pt/leic-a-po26/eval/po26
|}

{| class="mw-collapsible mw-collapsed wikitable" align="right" style="border-style: solid; border-width: 1px; border-color: #bbbbaa; background: #f7f8ff;"
! style="padding-left:10px; padding-right:10px; border-style: solid; border-width: 0px; border-bottom-width: 0px; border-color: #bbbbaa; background: #d7d8ed;" | '''Explicação das anotações'''
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 1px; border-color: #bbbbaa; " |
'''Conceitos:'''
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Herança:'''
* bind - problemas de representação de especializações de classes/interfaces genéricas
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Associações:'''
* assoc - associações em falta ou em excesso
* mult - multiplicidades erradas
* deps - uso incorrecto de dependências (deviam ser outra relação)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Atributos:'''
* app - atributos errados na app
* reps - atributos repetidos em classes hierarquicamente relacionadas (ou não colocados em superclasse)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Interface (métodos):'''
* core - interfaces do core incompletas
* (core) - interfaces do core com problemas potenciais
* manager - interface do manager com problemas
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Problemas:'''
* notation - erros de desenho de UML (herança)
* nomenc - erros de nomenclatura (maus nomes para classes)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
|}

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[category:Pautas de PO - Época Normal]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta do Projecto: UML

2026-08-26T07:18:05Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
__NOTOC__

'''EM ACTUALIZAÇÃO'''


'''A entrega inicial é obrigatória''' e vale 3 valores em 20.

'''Projectos que não estejam nas condições indicadas nos [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|critérios de avaliação]] não são considerados, conduzindo a reprovação. Não existem excepções.'''

Quaisquer dúvidas relativas a esta informação devem ser enviadas ao responsável pela disciplina.
{{Suggestion|Esta pauta corresponde ao projecto de época normal.}}

== Pauta ==

Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazo de Revisão ==

Os resultados da avaliação dos diagramas UML podem ser revistos até à data da entrega intermédia do projecto.

Aconselha-se celeridade no processo de revisão, pois algumas questões têm impacto na qualidade do código.

As aulas teóricas podem ser utilizadas para esclarecer dúvidas sobre as anotações na pauta.

== Legenda ==

Existem factores aditivos positivos (colunas a verde) e negativos (coluna laranja). As colunas sombreadas indicam o grau de completude dos diagramas correspondentes a cada caso (0 indica diagrama em falta, 0.25 indica diagrama inadequado para o problema, 1 indica diagrama adequado para o problema).

'''NA''' na coluna "Nota" indica "não avaliado" (grupo excluído da avaliação da disciplina em época normal no lectivo actual).
{| class="mw-collapsible mw-collapsed wikitable" align="right" style="border-style: solid; border-width: 1px; border-color: #bbbbaa; background: #f7f8ff;"
! style="padding-left:10px; padding-right:10px; border-style: solid; border-width: 0px; border-bottom-width: 0px; border-color: #bbbbaa; background: #d7d8ed;" | '''Explicação dos testes automáticos'''
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 1px; border-color: #bbbbaa; " |
Ver avaliação automática no GitLab (RNL): https://gitlab.rnl.tecnico.ulisboa.pt/leic-a-po26/eval/po26
|}

{| class="mw-collapsible mw-collapsed wikitable" align="right" style="border-style: solid; border-width: 1px; border-color: #bbbbaa; background: #f7f8ff;"
! style="padding-left:10px; padding-right:10px; border-style: solid; border-width: 0px; border-bottom-width: 0px; border-color: #bbbbaa; background: #d7d8ed;" | '''Explicação das anotações'''
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 1px; border-color: #bbbbaa; " |
'''Conceitos:'''
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Herança:'''
* bind - problemas de representação de especializações de classes/interfaces genéricas
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Associações:'''
* assoc - associações em falta ou em excesso
* mult - multiplicidades erradas
* deps - uso incorrecto de dependências (deviam ser outra relação)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Atributos:'''
* app - atributos errados na app
* reps - atributos repetidos em classes hierarquicamente relacionadas (ou não colocados em superclasse)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Interface (métodos):'''
* core - interfaces do core incompletas
* (core) - interfaces do core com problemas potenciais
* manager - interface do manager com problemas
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Problemas:'''
* notation - erros de desenho de UML (herança)
* nomenc - erros de nomenclatura (maus nomes para classes)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
|}

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[category:Pautas de PO - Época Normal]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta Global do Projecto

2026-08-26T07:17:13Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
__NOTOC__
'''PAUTA EM ACTUALIZAÇÃO'''


'''O projecto é obrigatório. O teste prático é obrigatório.'''

'''Projectos que não estejam nas condições indicadas nos [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|critérios de avaliação]] não são considerados, conduzindo a reprovação. Não existem excepções.'''

{{Suggestion|Esta pauta corresponde ao projecto de época normal.}}

== Pauta ==
Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazo de Revisão ==

Ver anúncio correspondente no Fénix.

== Legenda da Pauta Global do Projecto ==

Componentes de avaliação:

* PRJ - nota final do projecto
* PU - nota da entrega do diagrama UML
* PI- nota da entrega intermédia
* PF- nota da entrega final
* TP - nota do teste prático

A nota do teste prático condiciona a distância ao mínimo entre as notas do teste prático e a do projecto: desde um mínimo de 12.5% de acréscimo à menor das duas (abaixo de 7.5 valores no TP), até um máximo de 25% (para 20 valores no TP). O acréscimo é linear entre 7.5 e 20.

Ou seja:

* PRJ = min(PU+PI+PF, TP) + | TP - PU - PI - PF | * max(12.5, TP+5) / 100

Condições necessárias para aprovação à disciplina (necessárias todas):

* PRJ >= 9.5 (sem arredondamento)
* PRJ != NA
* TP > 0
* TP != NA

Linhas com números sombreados correspondem a alunos excluídos da avaliação em Época Normal, por não terem realizado componentes obrigatórias do projecto ou não terem comparecido ao teste prático.

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[category:Pautas de PO - Época Normal]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta Global do Projecto

2026-08-26T07:16:32Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
__NOTOC__
'''PAUTA EM ACTUALIZAÇÃO'''

Esta pauta corresponde ao projecto de época normal.

'''O projecto é obrigatório. O teste prático é obrigatório.'''

'''Projectos que não estejam nas condições indicadas nos [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|critérios de avaliação]] não são considerados, conduzindo a reprovação. Não existem excepções.'''

== Pauta ==
Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazo de Revisão ==

Ver anúncio correspondente no Fénix.

== Legenda da Pauta Global do Projecto ==

Componentes de avaliação:

* PRJ - nota final do projecto
* PU - nota da entrega do diagrama UML
* PI- nota da entrega intermédia
* PF- nota da entrega final
* TP - nota do teste prático

A nota do teste prático condiciona a distância ao mínimo entre as notas do teste prático e a do projecto: desde um mínimo de 12.5% de acréscimo à menor das duas (abaixo de 7.5 valores no TP), até um máximo de 25% (para 20 valores no TP). O acréscimo é linear entre 7.5 e 20.

Ou seja:

* PRJ = min(PU+PI+PF, TP) + | TP - PU - PI - PF | * max(12.5, TP+5) / 100

Condições necessárias para aprovação à disciplina (necessárias todas):

* PRJ >= 9.5 (sem arredondamento)
* PRJ != NA
* TP > 0
* TP != NA

Linhas com números sombreados correspondem a alunos excluídos da avaliação em Época Normal, por não terem realizado componentes obrigatórias do projecto ou não terem comparecido ao teste prático.

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[category:Pautas de PO - Época Normal]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta Global do Projecto

2026-08-26T07:15:31Z

Root: /* Prazo de Revisão */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
__NOTOC__
'''PAUTA EM ACTUALIZAÇÃO'''


'''O projecto é obrigatório. O teste prático é obrigatório.'''

'''Projectos que não estejam nas condições indicadas nos [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|critérios de avaliação]] não são considerados, conduzindo a reprovação. Não existem excepções.'''

== Pauta ==
Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazo de Revisão ==

Ver anúncio correspondente no Fénix.

== Legenda da Pauta Global do Projecto ==

Componentes de avaliação:

* PRJ - nota final do projecto
* PU - nota da entrega do diagrama UML
* PI- nota da entrega intermédia
* PF- nota da entrega final
* TP - nota do teste prático

A nota do teste prático condiciona a distância ao mínimo entre as notas do teste prático e a do projecto: desde um mínimo de 12.5% de acréscimo à menor das duas (abaixo de 7.5 valores no TP), até um máximo de 25% (para 20 valores no TP). O acréscimo é linear entre 7.5 e 20.

Ou seja:

* PRJ = min(PU+PI+PF, TP) + | TP - PU - PI - PF | * max(12.5, TP+5) / 100

Condições necessárias para aprovação à disciplina (necessárias todas):

* PRJ >= 9.5 (sem arredondamento)
* PRJ != NA
* TP > 0
* TP != NA

Linhas com números sombreados correspondem a alunos excluídos da avaliação em Época Normal, por não terem realizado componentes obrigatórias do projecto ou não terem comparecido ao teste prático.

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[category:Pautas de PO - Época Normal]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta Global do Projecto

2026-08-26T07:15:14Z

Root: Created page with "{{PRJPOAvisosEN20262027}} {{PRJPOMandatory20262027}} __NOTOC__ '''PAUTA EM ACTUALIZAÇÃO'''  '''O projecto é obrigatório. O teste prático é obrigatório.''' '''Projectos que não estejam nas condições indicadas nos critérios de avaliação não são considerados, conduzindo a rep..."

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
__NOTOC__
'''PAUTA EM ACTUALIZAÇÃO'''


'''O projecto é obrigatório. O teste prático é obrigatório.'''

'''Projectos que não estejam nas condições indicadas nos [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|critérios de avaliação]] não são considerados, conduzindo a reprovação. Não existem excepções.'''

== Pauta ==
Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazo de Revisão ==

Ver anúncio no Fénix.

== Legenda da Pauta Global do Projecto ==

Componentes de avaliação:

* PRJ - nota final do projecto
* PU - nota da entrega do diagrama UML
* PI- nota da entrega intermédia
* PF- nota da entrega final
* TP - nota do teste prático

A nota do teste prático condiciona a distância ao mínimo entre as notas do teste prático e a do projecto: desde um mínimo de 12.5% de acréscimo à menor das duas (abaixo de 7.5 valores no TP), até um máximo de 25% (para 20 valores no TP). O acréscimo é linear entre 7.5 e 20.

Ou seja:

* PRJ = min(PU+PI+PF, TP) + | TP - PU - PI - PF | * max(12.5, TP+5) / 100

Condições necessárias para aprovação à disciplina (necessárias todas):

* PRJ >= 9.5 (sem arredondamento)
* PRJ != NA
* TP > 0
* TP != NA

Linhas com números sombreados correspondem a alunos excluídos da avaliação em Época Normal, por não terem realizado componentes obrigatórias do projecto ou não terem comparecido ao teste prático.

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[category:Pautas de PO - Época Normal]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta do Projecto: Entrega Final

2026-08-26T07:13:25Z

Root: Created page with "{{PRJPOAvisosEN20262027}} {{PRJPOMandatory20262027}} __NOTOC__   '''A entrega final é obrigatória''' e vale 11 valores em 20 (5.5 valores para a avaliação automática).''' '''Projectos que não estejam nas condições indicadas nos Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|critérios de a..."

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
__NOTOC__



'''A entrega final é obrigatória''' e vale 11 valores em 20 (5.5 valores para a avaliação automática).'''

'''Projectos que não estejam nas condições indicadas nos [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|critérios de avaliação]] não são considerados, conduzindo a reprovação. Não existem excepções.'''

Quaisquer dúvidas, relativas a esta informação, devem ser enviadas ao responsável pela disciplina.

== Pauta ==
Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazo de Revisão ==

Ver anúncio correspondente no Fénix.

==Legenda ==

Existem factores aditivos positivos (colunas a verde) e negativos (colunas laranja).

'''NA''' na coluna "Nota" indica "não avaliado" (grupo excluído da avaliação da disciplina em época normal no lectivo actual).

O significado das anotações é semelhante ao das utilizadas na pauta da entrega intermédia.

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[category:Pautas de PO - Época Normal]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta do Projecto: Entrega Intermédia

2026-08-26T07:11:45Z

Root: Created page with "{{PRJPOAvisosEN20262027}} {{PRJPOMandatory20262027}} __NOTOC__   '''A entrega intermédia é obrigatória''' e vale 6 valores em 20. '''Projectos que não estejam nas condições indicadas nos critérios de avaliação não são considerados, condu..."

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
__NOTOC__




'''A entrega intermédia é obrigatória''' e vale 6 valores em 20.

'''Projectos que não estejam nas condições indicadas nos [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|critérios de avaliação]] não são considerados, conduzindo a reprovação. Não existem excepções.'''

Os alunos devem compreender/verificar/corrigir os problemas reportados.

Quaisquer dúvidas, relativas a esta informação, devem ser enviadas ao responsável pela disciplina.

== Pauta ==

Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazo de Revisão ==

Esta pauta está em revisão até à data da entrega final do projecto.

== Legenda ==

Existem factores aditivos positivos (colunas a verde) e negativos (colunas laranja).

A coluna "Auto" indica a percentagem de teste automáticos certos e vale 2.5 valores.

'''NA''' na coluna "Nota" indica "não avaliado" (grupo excluído da avaliação da disciplina em época normal no lectivo actual).

{| class="mw-collapsible mw-collapsed wikitable" align="right" style="border-style: solid; border-width: 1px; border-color: #bbbbaa; background: #f7f8ff;"
! style="padding-left:10px; padding-right:10px; border-style: solid; border-width: 0px; border-bottom-width: 0px; border-color: #bbbbaa; background: #d7d8ed;" | '''Explicação dos testes automáticos'''
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 1px; border-color: #bbbbaa; " |
Ver avaliação automática no GitLab (RNL): https://gitlab.rnl.tecnico.ulisboa.pt/leic-a-po26/eval/po26

São consideradas irrelevantes diferenças que consistam apenas em quantidade de espaços brancos (não ter espaços é considerada uma diferença).

|}

{| class="mw-collapsible mw-collapsed wikitable" align="right" style="border-style: solid; border-width: 1px; border-color: #bbbbaa; background: #f7f8ff;"
! style="padding-left:10px; padding-right:10px; border-style: solid; border-width: 0px; border-bottom-width: 0px; border-color: #bbbbaa; background: #d7d8ed;" | '''Explicação das anotações'''
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 1px; border-color: #bbbbaa; " |
'''Atributos não públicos:'''
* public - atributos públicos
* protected - atributos protected (potencialmente desnecessária a qualificação)
* package - atributos sem qualificação de acesso
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Atributos e métodos não “static”'''
* (const) - contantes
* (comparator) - constantes (comparador)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Serialização'''
* ois - problemas na utilização de ObjectInputStream
* oos - problemas na utilização de ObjectOutputStream
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Utilização de estruturas de dados correctas'''
* lists - utilização de listas onde se justifica a utilização de mapas
* generics - falta de parâmetro em tipo paramétrico
* Object - utilização directa da classe Object (sem ser para satisfazer um requisito de Java)
* Exception - utilização directa da classe Exception (processamento indiscriminado de excepções)
* instanceof - uso de instanceof (não é justificável numa solução de boa qualidade) (idem para getClass)
* System.* - problemas na utilização de canais de I/O
* app attrs/fields - definição de atributos em classes da app: deveriam ser variáveis locais a métodos ou simplesmente não existir
* ArrayList/TreeMap/HashSet/etc. - uso de tipos concretos em declarações de atributos (usar List/Map/Set/etc.)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Separação app/core'''
* serialization - uso de primitivas de serialização na app
* options - não uso de processo de escolha de opções
* reader - criação do leitor do ficheiro indicado pela propriedade "import" na app
* core exposed - exposição desnecessária de estruturas/abstracções do core
* except - não tratamento de excepções na app
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Qualidade do projecto (apreciação global)'''
* instanceof - uso de instanceof (não é justificável numa solução de boa qualidade) (idem para getClass)
* Object - utilização directa da classe Object (sem ser para satisfazer um requisito de Java)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Javadoc'''
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Seguir regras codificação'''
* class - erros de nomenclatura (maus nomes para classes)
* vars - erros de nomenclatura (maus nomes para variáveis)
* funcs - erros de nomenclatura (maus nomes para funções)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Lixo no Repositório'''
* [outras anotações] - consultar professor responsável (horário de dúvidas)
|}

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[category:Pautas de PO - Época Normal]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta do Projecto: UML

2026-08-26T07:09:33Z

Root: Created page with "{{PRJPOAvisosEN20262027}} {{PRJPOMandatory20262027}} __NOTOC__ '''EM ACTUALIZAÇÃO'''  '''A entrega inicial é obrigatória''' e vale 3 valores em 20. '''Projectos que não estejam nas condições indicadas nos critérios de avaliação não são considerados, conduzindo a reprovaç..."

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
__NOTOC__

'''EM ACTUALIZAÇÃO'''


'''A entrega inicial é obrigatória''' e vale 3 valores em 20.

'''Projectos que não estejam nas condições indicadas nos [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|critérios de avaliação]] não são considerados, conduzindo a reprovação. Não existem excepções.'''

Quaisquer dúvidas relativas a esta informação devem ser enviadas ao responsável pela disciplina.

== Pauta ==

Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazo de Revisão ==

Os resultados da avaliação dos diagramas UML podem ser revistos até à data da entrega intermédia do projecto.

Aconselha-se celeridade no processo de revisão, pois algumas questões têm impacto na qualidade do código.

As aulas teóricas podem ser utilizadas para esclarecer dúvidas sobre as anotações na pauta.

== Legenda ==

Existem factores aditivos positivos (colunas a verde) e negativos (coluna laranja). As colunas sombreadas indicam o grau de completude dos diagramas correspondentes a cada caso (0 indica diagrama em falta, 0.25 indica diagrama inadequado para o problema, 1 indica diagrama adequado para o problema).

'''NA''' na coluna "Nota" indica "não avaliado" (grupo excluído da avaliação da disciplina em época normal no lectivo actual).
{| class="mw-collapsible mw-collapsed wikitable" align="right" style="border-style: solid; border-width: 1px; border-color: #bbbbaa; background: #f7f8ff;"
! style="padding-left:10px; padding-right:10px; border-style: solid; border-width: 0px; border-bottom-width: 0px; border-color: #bbbbaa; background: #d7d8ed;" | '''Explicação dos testes automáticos'''
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 1px; border-color: #bbbbaa; " |
Ver avaliação automática no GitLab (RNL): https://gitlab.rnl.tecnico.ulisboa.pt/leic-a-po26/eval/po26
|}

{| class="mw-collapsible mw-collapsed wikitable" align="right" style="border-style: solid; border-width: 1px; border-color: #bbbbaa; background: #f7f8ff;"
! style="padding-left:10px; padding-right:10px; border-style: solid; border-width: 0px; border-bottom-width: 0px; border-color: #bbbbaa; background: #d7d8ed;" | '''Explicação das anotações'''
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 1px; border-color: #bbbbaa; " |
'''Conceitos:'''
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Herança:'''
* bind - problemas de representação de especializações de classes/interfaces genéricas
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Associações:'''
* assoc - associações em falta ou em excesso
* mult - multiplicidades erradas
* deps - uso incorrecto de dependências (deviam ser outra relação)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Atributos:'''
* app - atributos errados na app
* reps - atributos repetidos em classes hierarquicamente relacionadas (ou não colocados em superclasse)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Interface (métodos):'''
* core - interfaces do core incompletas
* (core) - interfaces do core com problemas potenciais
* manager - interface do manager com problemas
* [outras anotações] - consultar professor responsável (horário de dúvidas)
'''Problemas:'''
* notation - erros de desenho de UML (herança)
* nomenc - erros de nomenclatura (maus nomes para classes)
* [outras anotações] - consultar professor responsável (horário de dúvidas)
|}

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[category:Pautas de PO - Época Normal]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta Global da Disciplina

2026-08-26T07:04:24Z

Root: /* Pauta Global */

__NOTOC__
== Pauta Global ==

Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazo de Revisão ==

* '''Época Normal:''' ver prazo de revisão nas páginas correspondentes às provas em curso.  '''EM ACTUALIZAÇÃO'''
* '''Época Especial:''' provas a realizar em Julho de 2027 (ver datas na página da disciplina: Fénix) 

== Legenda ==

Não existem arredondamentos (excepto na coluna '''FINAL''').

Condições de aprovação: '''NOTA''', '''EXR''', '''PRJ''', '''EE''' têm de ser iguais ou superiores a 9.5.

Legenda:

* '''FINAL''' - resultado da avaliação (será lançado na secretaria)
* '''NOTA''' - resultado numérico da avaliação (quando aplicável)
* '''EXR''' - nota final dos exercícios de programação
* '''PRJ''' - nota final do projecto (inclui nota do teste prático)
* '''EE''' - época especial (6 exercícios de programação)

As notações especiais têm o seguinte significado:
* '''NA''' - "não avaliado"
* '''RE''' - "reprovado"

[[category: Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta das Aulas Práticas

2026-08-26T07:03:56Z

Root: /* Legenda */

__NOTOC__

'''EM ACTUALIZAÇÃO'''

A avaliação nestas aulas é obrigatória e não é repetível fora da semana em que cada exercício é realizado. 
Não se avaliam alunos fora do turno de inscrição.

Alunos que compareçam atrasados a estas aulas não são avaliados. 
É admitido um limite máximo de 20 minutos para entrada em cada aula, após a hora definida para a aula (i.e., já contabilizando os 10 minutos do início).

Não são considerados casos especiais na avaliação das aulas práticas. Alunos que considerem ter direito a tratamento especial e que não consigam comparecer com aproveitamento nestas aulas poderão requerer avaliação em época especial.

== Pauta ==

Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazos de revisão ==

Ver anúncio correspondente a cada semana no Fénix.

== Legenda ==
As colunas agregadas da pauta têm o seguinte significado:
* ''Nota'' indica a nota final (são contabilizados os 10 melhores exercícios)
* ''Média'' indica a média dos exercícios apresentados (são contabilizados todos os exercícios para a média: é meramente indicativa e não é usada na avaliação)

As classificações possíveis para cada exercício são:

* 0.00 - ignorância (quase) completa da matéria em avaliação
* 0.25 - erros graves ou solução muito incompleta ou inadequada
* 0.50 - erros importantes ou solução incompleta
* 0.75 - erros menos graves ou solução quase completa
* 1.00 - solução completa

Obter classificações abaixo de 0.75 deve constituir motivo de preocupação, especialmente nos casos 0 e 0.25, sendo os alunos fortemente encorajados a contactar o responsável pela disciplina para consulta dos exercícios em causa.

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta das Aulas Práticas

2026-08-26T07:03:16Z

Root:

__NOTOC__

'''EM ACTUALIZAÇÃO'''

A avaliação nestas aulas é obrigatória e não é repetível fora da semana em que cada exercício é realizado. 
Não se avaliam alunos fora do turno de inscrição.

Alunos que compareçam atrasados a estas aulas não são avaliados. 
É admitido um limite máximo de 20 minutos para entrada em cada aula, após a hora definida para a aula (i.e., já contabilizando os 10 minutos do início).

Não são considerados casos especiais na avaliação das aulas práticas. Alunos que considerem ter direito a tratamento especial e que não consigam comparecer com aproveitamento nestas aulas poderão requerer avaliação em época especial.

== Pauta ==

Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazos de revisão ==

Ver anúncio correspondente a cada semana no Fénix.

== Legenda ==
* ''Nota'' indica a nota final (são contabilizados os 10 melhores exercícios)
* ''Média'' indica a média dos exercícios apresentados (são contabilizados todos os exercícios para a média: é meramente indicativa e não é usada na avaliação)

As classificações possíveis para cada exercício são:

* 0.00 - ignorância (quase) completa da matéria em avaliação
* 0.25 - erros graves ou solução muito incompleta ou inadequada
* 0.50 - erros importantes ou solução incompleta
* 0.75 - erros menos graves ou solução quase completa
* 1.00 - solução completa

Obter classificações abaixo de 0.75 deve constituir motivo de preocupação, especialmente nos casos 0 e 0.25, sendo os alunos fortemente encorajados a contactar o responsável pela disciplina para consulta dos exercícios em causa.

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta das Aulas Práticas

2026-08-26T07:03:01Z

Root: Created page with "{{TOCright}}  '''EM ACTUALIZAÇÃO''' A avaliação nestas aulas é obrigatória e não é repetível fora da semana em que cada exercício é realizado. Não se avaliam alunos fora do turno de inscrição. Alunos que compareçam atrasados a estas aulas não são avaliados. É admitido um limite máximo de 20 minutos para entrada em cada aula, após a hora definida para a aula (i.e...."

{{TOCright}}

'''EM ACTUALIZAÇÃO'''

A avaliação nestas aulas é obrigatória e não é repetível fora da semana em que cada exercício é realizado. 
Não se avaliam alunos fora do turno de inscrição.

Alunos que compareçam atrasados a estas aulas não são avaliados. 
É admitido um limite máximo de 20 minutos para entrada em cada aula, após a hora definida para a aula (i.e., já contabilizando os 10 minutos do início).

Não são considerados casos especiais na avaliação das aulas práticas. Alunos que considerem ter direito a tratamento especial e que não consigam comparecer com aproveitamento nestas aulas poderão requerer avaliação em época especial.

== Pauta ==

Aqui: https://bit.ly/po26-pautas (Fénix)

== Prazos de revisão ==

Ver anúncio correspondente a cada semana no Fénix.

== Legenda ==
* ''Nota'' indica a nota final (são contabilizados os 10 melhores exercícios)
* ''Média'' indica a média dos exercícios apresentados (são contabilizados todos os exercícios para a média: é meramente indicativa e não é usada na avaliação)

As classificações possíveis para cada exercício são:

* 0.00 - ignorância (quase) completa da matéria em avaliação
* 0.25 - erros graves ou solução muito incompleta ou inadequada
* 0.50 - erros importantes ou solução incompleta
* 0.75 - erros menos graves ou solução quase completa
* 1.00 - solução completa

Obter classificações abaixo de 0.75 deve constituir motivo de preocupação, especialmente nos casos 0 e 0.25, sendo os alunos fortemente encorajados a contactar o responsável pela disciplina para consulta dos exercícios em causa.

[[category:Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027/Pauta Global da Disciplina

2026-08-26T07:01:20Z

Root: Created page with "__NOTOC__ == Pauta Global == Aqui: https://bit.ly/po26-pautas == Prazo de Revisão == * '''Época Normal:''' ver prazo de revisão nas páginas correspondentes às provas em curso.  '''EM ACTUALIZAÇÃO''' * '''Época Especial:''' provas a realizar em Julho de 2027 (ver datas na página da disciplina: Fénix)  == Legenda == Não existem arredo..."

__NOTOC__
== Pauta Global ==

Aqui: https://bit.ly/po26-pautas

== Prazo de Revisão ==

* '''Época Normal:''' ver prazo de revisão nas páginas correspondentes às provas em curso.  '''EM ACTUALIZAÇÃO'''
* '''Época Especial:''' provas a realizar em Julho de 2027 (ver datas na página da disciplina: Fénix) 

== Legenda ==

Não existem arredondamentos (excepto na coluna '''FINAL''').

Condições de aprovação: '''NOTA''', '''EXR''', '''PRJ''', '''EE''' têm de ser iguais ou superiores a 9.5.

Legenda:

* '''FINAL''' - resultado da avaliação (será lançado na secretaria)
* '''NOTA''' - resultado numérico da avaliação (quando aplicável)
* '''EXR''' - nota final dos exercícios de programação
* '''PRJ''' - nota final do projecto (inclui nota do teste prático)
* '''EE''' - época especial (6 exercícios de programação)

As notações especiais têm o seguinte significado:
* '''NA''' - "não avaliado"
* '''RE''' - "reprovado"

[[category: Ensino]]
[[category:PO]]
[[category:Pautas de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Pautas 2026-2027

2026-08-26T06:59:21Z

Root: Created page with "__NOTOC__ Além dos resultados de avaliação, as páginas das pautas contêm também os critérios de avaliação e aprovação. * {{PautaAberta}} indica avaliação em curso * {{PautaFechada}} indica avaliação terminada (classificações definitivas) * {{ProvaPorRealizar}} indica prova prevista == Pauta Global da Disciplina == * {{PautaAberta}} Pauta Global da Disciplina == Pauta das Aulas..."

__NOTOC__
Além dos resultados de avaliação, as páginas das pautas contêm também os critérios de avaliação e aprovação.
* {{PautaAberta}} indica avaliação em curso
* {{PautaFechada}} indica avaliação terminada (classificações definitivas)
* {{ProvaPorRealizar}} indica prova prevista

== Pauta Global da Disciplina ==

* {{PautaAberta}} [[Programação com Objectos/Pautas 2026-2027/Pauta Global da Disciplina|Pauta Global da Disciplina]]

== Pauta das Aulas Práticas ==

* {{PautaAberta}} [[Programação com Objectos/Pautas 2026-2027/Pauta das Aulas Práticas|Pauta das Aulas Práticas]]

== Pautas do Projecto (época normal) ==

* {{PautaAberta}} [[Programação com Objectos/Pautas 2026-2027/Pauta do Projecto: UML|Pauta do Projecto: UML]]
* {{ProvaPorRealizar}} [[Programação com Objectos/Pautas 2026-2027/Pauta do Projecto: Entrega Intermédia|Pauta do Projecto: Entrega Intermédia]]
* {{ProvaPorRealizar}} [[Programação com Objectos/Pautas 2026-2027/Pauta do Projecto: Entrega Final|Pauta do Projecto: Entrega Final]]
* {{PautaAberta}} [[Programação com Objectos/Pautas 2026-2027/Pauta Global do Projecto|Pauta Global do Projecto]]

[[category: Ensino]]
[[category:PO]]
[[category: Pautas de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Calendário do Teste Prático (Época Normal)

2026-08-26T06:55:17Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

= Condições =

O teste prático tem a duração de 50 minutos e é estritamente presencial.

As datas e locais de realização do teste prático são como indicado abaixo (todos os labs são na RNL, Pav. Informática I).

'''Recorda-se que a não realização do teste prático corresponde a uma classificação de 0 (zero) na componente de projecto e consequente reprovação à disciplina de Programação com Objectos no ano lectivo em curso (época normal).'''

'''O facto de um aluno aparecer na lista do teste prático não implica que tenha possibilidade de aprovação implícita à disciplina: as outras condições de aprovação continuam em vigor.'''

Alunos que realizem o projecto em grupos de 2 alunos têm de fazer o teste prático à mesma hora (incluindo o "early bird"). Se um dos alunos se apresentar isolado, o outro elemento está implicitamente reprovado.

Alunos que não realizem a entrega final não serão admitidos ao teste prático.

Alunos não apresentados, e que achem que deveriam estar incluídos, devem contactar o responsável pela disciplina.

'''É necessário e da responsabilidade dos alunos activar atempadamente (não pode ser no próprio dia) os serviços de Shell e AFS, para a realização do teste prático, tal como para a realização do projecto. A incapacidade de usar o PC do laboratório implica não avaliação e consequente exclusão da avaliação da disciplina. A activação não funciona no próprio dia.'''

= Teste Tipo =
Este teste tipo está previsto ser realizado sobre a aplicação bancária.

'''QUESTÃO AUTÓNOMA -- ELIMINATÓRIA'''

0. Compile e execute o programa contido em '''Simple.java''' (o ficheiro está localizado na directoria '''work'''). Não altere o ficheiro. Em caso de dúvidas, contacte o docente.

'''QUESTÕES A RESOLVER SOBRE O PROJECTO'''

1. (5 valores) Complete o comando que permite mudar o nome de um titular. O comando deve primeiro pedir o novo nome do titular.

2. (7 valores) Acrescente uma nova opção ao menu de gestão de contas (bankaccount) que permita mostrar a conta (current account) com maior saldo.

3. (8 valores) Acrescente ao programa o conceito de gestor de conta: um gestor pode gerir várias contas, partilha os atributos do titular da conta, mas não pode ser titular de contas. Cada conta tem apenas um gestor.

= Calendário =
(a definir)

= Realizados =
(a definir)

[[category: Ensino]]
[[category:PO]]
[[category:Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos

2026-08-26T06:53:26Z

Root: /* Projecto Exemplo: Rede Social (2011) */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

== Avaliação do Projecto ==
* [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|Avaliação do Projecto (Época Normal)]]
* [[Programação com Objectos/Projecto de Programação com Objectos/Calendário do Teste Prático (Época Normal)|Calendário do Teste Prático (Época Normal)]]

As pautas são acompanhadas pelos critérios de avaliação. 


== Projecto: Enunciado 2026-2027 (época normal) ==

* [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027|Enunciado do Projecto 2026-2027]]
* Enunciados de anos anteriores: [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2025-2026|2025-2026]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2024-2025|2024-2025]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2023-2024|2023-2024]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2022-2023|2022-2023]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2021-2022|2021-2022]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2020-2021|2020-2021]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2019-2020|2019-2020]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2018-2019|2018-2019]]

== Material de Apoio e Testes ==

* [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|Repositório GIT]] - informações de localização e acesso
* [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|Material de Apoio ao Desenvolvimento]]
* Testes automáticos: https://gitlab.rnl.tecnico.ulisboa.pt/leic-a-po26/eval/po26
* [[Programação com Objectos/Projecto de Programação com Objectos/Máquina Virtual|Máquina Virtual]]

== Projecto Exemplo: Aplicação Bancária ==

Para auxiliar o desenvolvimento do projecto, é fornecida uma [[Comando (padrão de desenho)/Banco, Conta, Titular (aplicação bancária)|aplicação bancária]] (banco, contas, titulares, etc.), que tem a mesma estrutura. Esta estrutura tem duas partes principais: "core" (o núcleo lógico da aplicação) e "app" (a interface textual, baseada no padrão de desenho [[Comando (padrão_de_desenho)|Command]]).

== Projecto Exemplo: Hotel Veterinário (2024) ==

Este projecto descreve um hotel veterinário.

O enunciado corresponde ao ano lectivo de 2024/2025 e refere aspectos de implementação compatíveis com 2025/2026.
* Enunciado: [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2024-2025|Hotel Veterinário]]
* Implementação (git snapshot): [[media:po24-hva-2025030036.tar.bz2]]
{{Aviso|O uso deste código deve ser feito de forma crítica, já que algumas das decisões nele tomadas podem ser alvo de descontos na avaliação do projecto.}}

== Projecto Exemplo: Rede Social (2011) ==

Este projecto descreve uma rede social com funcionalidade semelhante à das redes sociais actuais: relações entre agentes, publicação de vários tipos de media, envio de mensagens, etc.

Note-se que o enunciado corresponde ao ano lectivo de 2011/2012 e refere aspectos de implementação não disponíveis em anos seguintes. A implementação foi actualizada em 2022/2023, para ser compatível com o material de apoio dessa altura, mas não teve outras actualizações.
* Enunciado: [[media:social-network-201110241420.pdf]]
* Implementação (core): [[media:sonet-core-202111021419.tar.bz2]]
* Implementação (app: browser): [[media:sonet-app-browser-202111021419.tar.bz2]]
* Implementação (app: manager): [[media:sonet-app-manager-202111021419.tar.bz2]]
{{Aviso|O uso deste código deve ser feito de forma crítica, já que algumas das decisões nele tomadas podem ser alvo de descontos na avaliação do projecto.}}

== Linguagens de Programação ==

As seguintes linguagens são utilizadas nestas páginas:

* [http://www.java.com/ Java] -- [https://docs.oracle.com/en/java/javase/ Java Platform, Standard Edition Documentation] (os testes automáticos usam OpenJDK 25)
* [http://cplusplus.com/ C++] (C++23 ou superior) -- [http://cplusplus.com/reference/ Manual de Referência para C++ (biblioteca)]; STL: [http://cplusplus.com/reference/stl/ contentores], [http://cplusplus.com/reference/algorithm/ algoritmos] 


[[category:Ensino]]
[[category:PO]]
[[category:Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento

2026-08-26T06:51:26Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
__NOTOC__

== Material de Apoio ==

O projecto, escrito em Java, deve ser desenvolvido considerando os princípios de programação com objectos e os aspectos de arquitectura dos padrões de desenho aplicáveis. Alguns dos padrões estão presentes no material de apoio e condicionam parte do desenho da aplicação.

O código presente na biblioteca de apoio ao desenvolvimento do projecto é de uso obrigatório:

* Código de base ao desenvolvimento: [[media:po-uilib-202608310000.tar.bz2|po-uilib-202608310000.tar.bz2]] (já está instalado na máquina virtual) - [https://www.hlt.inesc-id.pt/~david/ist/docencia/po/2026/javadoc/po-uuilib javadoc]
* Código da lógica da aplicação e classes associadas (código esqueleto, parcialmente implementado, a completar): ('''erp-core''' via GIT)
* Código de interacção com o utilizador (código parcialmente implementado, a completar): ('''erp-app''' via GIT)

{{CVSCode|O [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|repositório GIT]] já contém uma versão incompleta do projecto. Isto significa que ''antes'' de se começar a programar, o projecto deve ser obtido a partir do repositório.}}

{{Aviso|Qualquer ficheiro do material de apoio (classes da biblioteca '''po-uilib''' ou código pré-implementado), ou com nome coincidente, será removido do projecto antes de cada teste.}}

== Pacotes Binários e Ambiente Oficial ==

Tanto o manterial de apoio, como a [[Comando_(padrão_de_desenho)/Banco,_Conta,_Titular_(aplicação_bancaria)|aplicação Bank]], estão disponíveis para instalação directa através do repositório (usar instalador favorito):

* https://download.opensuse.org/repositories/home:/d4vid:/po26/

Este repositório é para openSUSE (o ambiente de avaliação oficial), mas os JARs são compatíveis com outros sistemas.
Este repositório pode ser adicionado a um openSUSE Tumbleweed (por exemplo) previamente instalado através do comando

<nowiki>zypper ar https://download.opensuse.org/repositories/home:/d4vid:/po26/openSUSE_Tumbleweed/ PO26</nowiki>

Uma vez adicionado o repositório, os pacotes acima podem ser instalados através dos comandos (pode ser dado apenas um comando com todos os pacotes)

zypper install po-uilib
zypper install po-bank-core po-bank-app

{{Suggestion|Os pacotes do material de apoio estão pré-instalados na [[Programação com Objectos/Projecto de Programação com Objectos/Máquina Virtual|máquina virtual]]. Ver JARs em /usr/share/java.}}

[[category:Ensino]]
[[category:PO]]
[[category:Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos

2026-08-26T06:49:33Z

Root: /* Material de Apoio e Testes */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

== Avaliação do Projecto ==
* [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|Avaliação do Projecto (Época Normal)]]
* [[Programação com Objectos/Projecto de Programação com Objectos/Calendário do Teste Prático (Época Normal)|Calendário do Teste Prático (Época Normal)]]

As pautas são acompanhadas pelos critérios de avaliação. 


== Projecto: Enunciado 2026-2027 (época normal) ==

* [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027|Enunciado do Projecto 2026-2027]]
* Enunciados de anos anteriores: [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2025-2026|2025-2026]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2024-2025|2024-2025]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2023-2024|2023-2024]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2022-2023|2022-2023]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2021-2022|2021-2022]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2020-2021|2020-2021]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2019-2020|2019-2020]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2018-2019|2018-2019]]

== Material de Apoio e Testes ==

* [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|Repositório GIT]] - informações de localização e acesso
* [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|Material de Apoio ao Desenvolvimento]]
* Testes automáticos: https://gitlab.rnl.tecnico.ulisboa.pt/leic-a-po26/eval/po26
* [[Programação com Objectos/Projecto de Programação com Objectos/Máquina Virtual|Máquina Virtual]]

== Projecto Exemplo: Aplicação Bancária ==

Para auxiliar o desenvolvimento do projecto, é fornecida uma [[Comando (padrão de desenho)/Banco, Conta, Titular (aplicação bancária)|aplicação bancária]] (banco, contas, titulares, etc.), que tem a mesma estrutura. Esta estrutura tem duas partes principais: "core" (o núcleo lógico da aplicação) e "app" (a interface textual, baseada no padrão de desenho [[Comando (padrão_de_desenho)|Command]]).

== Projecto Exemplo: Hotel Veterinário (2024) ==

Este projecto descreve um hotel veterinário.

O enunciado corresponde ao ano lectivo de 2024/2025 e refere aspectos de implementação compatíveis com 2025/2026.
* Enunciado: [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2024-2025|Hotel Veterinário]]
* Implementação (git snapshot): [[media:po24-hva-2025030036.tar.bz2]]
{{Aviso|O uso deste código deve ser feito de forma crítica, já que algumas das decisões nele tomadas podem ser alvo de descontos na avaliação do projecto.}}

== Projecto Exemplo: Rede Social (2011) ==

Este projecto descreve uma rede social com funcionalidade semelhante à das redes sociais actuais: relações entre agentes, publicação de vários tipos de media, envio de mensagens, etc.

Note-se que o enunciado corresponde ao ano lectivo de 2011/2012 e refere aspectos de implementação não disponíveis em anos seguintes. A implementação foi actualizada em 2022/2023, para ser compatível com o material de apoio dessa altura, mas não teve outras actualizações.
* Enunciado: [[media:social-network-201110241420.pdf]]
* Implementação (core): [[media:sonet-core-202111021419.tar.bz2]]
* Implementação (app: browser): [[media:sonet-app-browser-202111021419.tar.bz2]]
* Implementação (app: manager): [[media:sonet-app-manager-202111021419.tar.bz2]]
'''O uso deste código deve ser feito de forma crítica, já que algumas das decisões nele tomadas podem ser alvo de descontos na avaliação do projecto.'''

== Linguagens de Programação ==

As seguintes linguagens são utilizadas nestas páginas:

* [http://www.java.com/ Java] -- [https://docs.oracle.com/en/java/javase/ Java Platform, Standard Edition Documentation] (os testes automáticos usam OpenJDK 25)
* [http://cplusplus.com/ C++] (C++23 ou superior) -- [http://cplusplus.com/reference/ Manual de Referência para C++ (biblioteca)]; STL: [http://cplusplus.com/reference/stl/ contentores], [http://cplusplus.com/reference/algorithm/ algoritmos] 


[[category:Ensino]]
[[category:PO]]
[[category:Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT

2026-08-26T06:46:20Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

Os repositórios GIT para os projectos (um por grupo) já contêm versões iniciais do projecto.

{{Aviso|'''O uso do repositório GIT é obrigatório.'''}}

{{Aviso|'''Não serão considerados projectos que não estejam no repositório oficial.'''}}

== Localização ==

Os repositórios estão disponíveis no Gitlab da RNL em '''[https://gitlab.rnl.tecnico.ulisboa.pt/leic-a-po26 https://gitlab.rnl.tecnico.ulisboa.pt/leic-a-po26]'''

O conteúdo do repositório pode ser manipulado com o comando '''git''' ou com qualquer outro cliente compatível.

== Modo de Acesso ==

O acesso ao serviço GitLab da RNL é realizado com as credenciais IST (à la Fénix)

Todos os alunos do IST têm de ter credenciais válidas para poderem ser avaliados na disciplina.

{{Aviso|Apenas é considerado para avaliação o ramo '''master'''. Alunos que não coloquem o projecto neste ramo serão excluídos da avaliação.}}
{{Aviso|Para o teste prático é necessário activar os serviços AFS e Shell no [https://selfservice.dsi.tecnico.ulisboa.pt/ self-service da DSI]. Sem isso, não é possível completar a avaliação do projecto, reprovando à disciplina.}}

== Conteúdo e Estrutura do Repositório ==

O código fornecido é de uso obrigatório e deve ser completado.

O projecto é constituído por dois módulos: '''erp-core''' e '''erp-app''' (o módulo '''po-uilib''' é exterior ao desenvolvimento).

{{CollapsedCode|Conteúdo inicial do repositório para o módulo bci-core|<syntaxhighlight lang="text">
erp-core
├── Makefile
└── src
└── erp
├── exceptions
│ ├── ImportFileException.java
│ ├── MissingFileAssociationException.java
│ ├── UnavailableFileException.java
│ └── UnrecognizedEntryException.java
├── Erp.java
└── ErpManager.java
</syntaxhighlight>
}}

{{CollapsedCode|Conteúdo inicial do repositório para o módulo bci-app|<syntaxhighlight lang="text">
(a definir)
</syntaxhighlight>
}}

Estes módulos podem ser obtidos em conjunto clonando o projecto com o número correspondente à inscrição no Fénix (ver abaixo).

O repositório já tem a seguinte estrutura:
* '''erp-core''' (directoria principal da biblioteca com a funcionalidade sem interface com o utilizador)
* '''erp-core/Makefile''' (makefile secundária, semelhante à disponibilizada na aplicação bancária)
* '''erp-core/src''' (directoria onde reside o código do "core", à semelhança do que acontece na aplicação bancária)
* '''erp-app''' (directoria correspondente à aplicação; contém a interface com o utilizador)
* '''erp-app/Makefile''' (makefile secundária, semelhante à disponibilizada na aplicação bancária)
* '''erp-app/src''' (directoria onde já reside o código da interface textual, tal como na biblioteca equivalente da aplicação bancária)

Esta estrutura já contém algumas classes parcialmente implementadas ('''erp-core''') (que devem ser adaptadas) e outras parcial ou completamente implementadas ('''erp-app''') (algumas das quais não podem ser alteradas).

{{Aviso|A estrutura do repositório não pode ser alterada.}}

{{Aviso|O código fornecido em '''erp-core''' e '''erp-app''' tem de ser completado.}}

{{Aviso|Os nomes das classes fornecidas em '''erp-core''' e '''erp-app''' não podem ser alterados.}}

{{Aviso|As seguintes classes e interfaces não podem ser alteradas: '''App.java''', todos os '''Label.java''', todos os '''Menu.java''', todos os '''Message.java''', todos os '''Prompt.java''' e todas as excepções fornecidas (tanto em '''erp-core''', como em '''erp-app''').}}

== Cuidados a ter na Utilização do Repositório GIT ==

=== NÃO FAZER ===

* '''git init''' (não é necessário: o repositório já existe)

=== FAZER ===

O repositório já contém uma versão preliminar do projecto e devem ser dados os seguintes passos, para continuar a desenvolver o projecto:

# '''git clone git@gitlab.rnl.tecnico.ulisboa.pt:leic-a-po26/prj/123.git''' (para obter uma cópia local, neste exemplo, do projecto do grupo '''123''');
# Editar/adicionar material do/ao projecto;
# Caso sejam criados ficheiros ou directórios novos, fazer '''git add ficheiro1 ficheiro2 ... ficheiroN''' (adicionar novos ficheiros/directorias ao projecto);
# '''git pull''' (antes de enviar alteração locais para o repositório, verificar se há actualizações remotas a incorporar na cópia local)
# '''git status''' (verificar a situação na cópia local e que não foi esquecido nenhum ficheiro importante: voltar a 3. até terem sido todos adicionados)
# '''git commit -am "Mensagem de commit."''' (registar alterações na cópia local)
# '''git push''' (enviar alterações para o GitLab -- '''sem este passo, não é realizada a entrega do projecto''')

=== Observações importantes ===

* Não adicionar cópias do material de apoio (po-uilib) ao projecto (serão removidas e quaisquer alterações perdidas -- além disso, lixo no repositório é penalizado).
* Pessoas sem área no AFS, ou sem login activado, não poderão aceder ao conteúdo do teste prático: para activar estes acessos, consultar o self-service do CIIST (DSI) (ver acima). Em caso de dificuldade, consultar atempadamente o corpo docente.
* A estrutura do projecto no GIT deve ser mantida como apresentado.
* Em caso de dúvidas, consultar o corpo docente.

{{Aviso|'''As activações de serviços não são instantâneas: activações no próprio dia de uma entrega ou de uma prova, estão condenadas a falhar e resultam necessariamente em reprovação. A activação atempada é da exclusiva responsabilidade do aluno.'''}}

== "Receita" para a Entrega de Diagramas UML ==

Tal como indicado no [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|método de avaliação]], os 3 diagramas a entregar -- '''UML-po-uilib.pdf''', '''UML-erp-app.pdf''', '''UML-erp-core.pdf''' -- devem ser colocados na directoria '''uml''' do projecto no repositório GIT.

Os comandos abaixo explicam como realizar essa operação a partir de um projecto no repositório (desde obter uma cópia local até completar a entrega). O passo de obter a cópia local pode ser omitido se o projecto já tiver sido obtido anteriormente. O passo de adicionar novos ficheiros pode ser omitido se as versões dos diagramas corresponderem a actualizações de adições anteriores. Nos exemplos dos comandos abaixo, '''123''' é o grupo de trabalho da pessoa a realizar a entrega.

* Obter o projecto do repositório (o projecto fica na directoria local '''123'''). Assume-se que os comandos subsequentes são dados dentro da directoria '''123''' (notar '''cd 123''' abaixo):
git clone git@gitlab.rnl.tecnico.ulisboa.pt:leic-a-po26/prj/123.git
cd 123
* Colocar os ficheiros com os diagramas na directoria '''uml''' (ficheiros novos ou actualizações). Esta operação depende de onde estão os diagramas ou de como foram digitalizados a partir da versão manuscrita (recorda-se que apenas são aceites diagramas manuscritos, devidamente acompanhados com a declaração de autoria). O comando apresentado é apenas um exemplo (assume que os diagramas estão originalmente na directoria principal do utilizador).
cp ~/UML-po-uilib.pdf ~/UML-bci-app.pdf ~/UML-bci-core.pdf uml
* Adicionar os ficheiros novos ao CVS (no comando a seguir, assume-se que os 3 ficheiros são adicionados, mas pode adicionar-se um de cada vez):
git add uml/UML-po-uilib.pdf uml/UML-erp-app.pdf uml/UML-erp-core.pdf
* Pode realizar-se neste ponto um pedido de actualização da cópia local (caso a outra pessoa do grupo também esteja a fazer alterações -- se não é o caso, este passo é opcional):
git pull
git status
* Registar as alterações (na cópia local) (a mensagem descreve o commit):
git commit -am "Adicionados diagramas UML."
* Finalmente, enviam-se os ficheiros novos para o repositório GIT:
git push

[[category: Projecto de PO]]
[[category:PO]]
[[category: Ensino]]

Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)

2026-08-26T06:42:15Z

Root: /* Entrega Final */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

=Método de Avaliação do Projecto =

A avaliação relativa à componente do Projecto processa-se em várias fases:

* [[#Entrega do Modelo UML|Entrega do modelo UML]] ('''obrigatória''': ver condições abaixo)
* [[#Entrega Intermédia|Entrega intermédia]] ('''obrigatória''': ver condições abaixo)
* [[#Entrega Final|Entrega final]] ('''obrigatória''': ver condições abaixo)
* [[#Teste Prático|Teste prático]] ('''obrigatório''': ver condições abaixo)

O Projecto (trabalho conducente às entregas acima mencionadas e abaixo descritas) é realizado em grupos de 2 elementos ou individualmente durante o período estabelecido.

'''TODAS AS ENTREGAS SÃO REALIZADAS ATÉ ÀS 12:00 ("meio-dia") DAS RESPECTIVAS DATAS'''

O Teste Prático é realizado individualmente, em data e local a agendar.

'''Considerando que todas as entregas são cruciais na concepção e realização do projecto, a não realização de qualquer entrega conduz automaticamente a uma classificação de 0 (zero) na componente de avaliação relativa ao Projecto e consequente exclusão da avaliação da disciplina no ano lectivo em curso.'''

= Cálculo da Nota do Projecto e Condições de Aprovação =

Componentes de avaliação:

* '''PRJ''' - nota final do projecto
* '''PU''' - nota da entrega do diagrama UML
* '''PI'''- nota da entrega intermédia
* '''PF'''- nota da entrega final
* '''TP''' - nota do teste prático

A nota do teste prático condiciona a distância ao mínimo entre as notas do teste prático e a do projecto: desde um mínimo de 12.5% de acréscimo à menor das duas (abaixo de 7.5 valores no TP), até um máximo de 25% (para 20 valores no TP). O acréscimo é linear entre 7.5 e 20.

Ou seja:

* '''PRJ = min(PU+PI+PF, TP) + | TP - PU - PI - PF | * max(12.5, TP+5) / 100'''

Condições necessárias para aprovação à disciplina -- '''necessárias todas''':

* '''PRJ >= 9.5''' (sem arredondamento)
* '''PRJ != NA'''
* '''TP > 0'''
* '''TP != NA'''

= Entrega do Modelo UML =

A Entrega do Modelo UML avalia o estado do projecto relativamente à concepção do modelo.

Esta entrega tem uma classificação máxima de 3 valores.

'''A não realização da Entrega do Modelo UML conduz automaticamente a uma classificação de 0 (zero) na componente do projecto.'''

Devem ser entregues diagramas de classes correspondentes a todos os conceitos da aplicação, mesmo que esses conceitos venham a ser revistos/alterados futuramente. Podem ainda ser incluídas anotações nos diagramas, por forma a clarificar outros aspectos relevantes. Não é necessária a inclusão de getters/setters/equals/toString (e outros métodos já definidos no Java).
* Diagrama 1: diagrama do pacote '''po-uilib''' (material de apoio que não pode ser alterado): '''UML-po-uilib.pdf''' (não é necessário representar o conteúdo de '''pt/tecnico/uilib/swing''')
* Diagrama 2: diagrama do pacote '''erp-app''' (material do projecto completo -- pode receber adições de código em métodos '''execute''', de atributos nas classes dos comandos e de classes auxiliares): '''UML-erp-app.pdf'''
* Diagrama 3: diagrama do pacote '''erp-core''' (material do projecto incompleto e que deve ser completado e desenvolvido -- ou seja, deve incluir adicionalmente partes que correspondem à interpretação do enunciado): '''UML-erp-core.pdf'''. Este diagrama é de entrega '''obrigatória''' (grupos que não o entreguem estão excluídos da avaliação).

A entrega dos diagramas '''obrigatoriamente manuscritos''' é feita em documentos PDF na directoria "uml" do projecto no GIT. O formato é A4 (cada diagrama pode ter várias páginas) e realiza-se até à data limite: 4ª feira, 2026/10/16, 12:00 (meio-dia). Documentos ilegíveis ou noutros formatos serão sumariamente ignorados, mesmo que isso resulte em reprovação dos alunos envolvidos: é da responsabilidade dos alunos produzir material de boa qualidade nas condições de avaliação.

Apenas são aceites diagramas manuscritos e posteriormente digitalizados (usando uma aplicação como nas aulas laboratoriais): serão recusados quaisquer diagramas produzidos com ferramentas informáticas, mesmo que isso resulte em reprovação dos alunos envolvidos: é da responsabilidade dos alunos produzir material de material de boa qualidade nas condições de avaliação.

Cada diagrama deve conter a seguinte declaração de autoria, assinada sob compromisso de honra (os diagramas entregues por grupos de 2 alunos devem conter duas declarações independentes com o mesmo texto e correspondente assinatura):
'''Declaro por minha honra que este diagrama foi realizado apenas pelos elementos que constituem o grupo de projecto. (assinatura)'''

'''Diagramas entregues sem declaração de autoria serão considerados indício de fraude e os alunos correspondentes excluídos da avaliação da disciplina, sendo comunicada a situação aos órgãos da Escola.'''

Serão aplicados os seguintes critérios na avaliação da entrega UML.

Factores aditivos '''positivos''':

* 0.80 - Conceitos
* 0.50 - Herança
* 0.70 - Associações
* 0.50 - Atributos
* 0.50 - Interface (métodos das classes, interfaces, etc.)

Factores aditivos '''negativos''':

* 0.50 - Erros de notação

A compreensão clara dos aspectos acima deve ser adquirida antes da entrega.

= Entrega Intermédia =

A Entrega Intermédia avalia o estado do projecto relativamente a um mínimo de funcionalidade.

Serão executados testes automáticos nesta entrega.

Esta entrega tem uma classificação máxima de 6 valores (2.5 valores para testes automáticos).

'''A não realização da Entrega Intermédia conduz automaticamente a uma classificação de 0 (zero) na componente do projecto.'''

== Funcionalidade a implementar ==

Os pormenores dos parâmetros de avaliação desta entrega serão anunciados em breve.

== Critérios de avaliação (não automática) ==

Serão aplicados os seguintes '''critérios na avaliação da entrega intermédia''' do projecto.

Factores aditivos '''positivos''':

* 0.40 - Atributos não públicos
* 0.30 - Atributos e métodos não "static" (excepto onde autorizado)
* 0.20 - Serialização
* 1.00 - Utilização correcta de herança
* 0.50 - Utilização das estruturas de dados correctas
* 0.60 - Separação app/core (pode haver descontos na parte automática)
* 0.30 - Qualidade do projecto
* 0.20 - Comentários Javadoc (a colocar necessariamente na classe '''Erp''')

Factores aditivos '''negativos''':

* 0.15 - Violação de regras de codificação Java

Será aplicado um desconto até 1.00 pela existência de lixo no repositório GIT. Este "lixo" é apenas considerado se aparecer na cópia local durante um "checkout".

= Entrega Final =

A Entrega Final pressupõe que todo o projecto foi completamente implementado.

Esta entrega tem uma classificação máxima de 11 valores:
* 5.50 valores para a qualidade do código
* 5.50 valores para testes automáticos

'''A não realização da Entrega Final conduz automaticamente a uma classificação de 0 (zero) na componente do projecto.'''

Os testes correspondem a uma série de entradas a processar pelo projecto de cada grupo e cuja execução deve corresponder a um conjunto de resultados padrão.

Serão aplicados os seguintes critérios na avaliação da entrega final do projecto.

Factores aditivos '''positivos''': (a definir)


Factores aditivos '''negativos''':

* até 1.00 - Violação de regras de codificação Java
* até 1.00 - Existência de lixo no repositório GIT (o "lixo" é apenas considerado se aparecer na cópia local durante um "checkout")
* até 1.00 - Uso directo dos tipos Object (excepto onde inevitável), Exception (excepto como superclasse), Throwable, Error
* até 0.50 - Atributos (qualidade e acesso)
* até 0.25 - Atributos e métodos "static" (excepto autorizados)

'''Note-se que não é considerada a entrega final se o repositório à data da entrega final contiver o mesmo código da entrega intermédia. Isso implica também a reprovação imediata dos alunos do grupo em causa (todas as entregas do projecto são obrigatórias).'''

= Teste Prático =

O Teste Prático consiste num conjunto de questões (correspondentes a pequenas alterações/extensões ao enunciado) a resolver com base na implementação submetida para a avaliação correspondente à entrega final.

Este teste avalia o conhecimento do aluno relativamente ao projecto entregue, assim como a sua capacidade de realizar alterações ao código do projecto.

O teste prático é como uma discussão de projecto, pelo que não existem repescagens como nos testes escritos. Alunos que faltem ao teste prático estão automaticamente reprovados à disciplina.

'''A não realização do Teste Prático conduz automaticamente a uma classificação de 0 (zero) na componente de avaliação relativa ao Projecto e consequente exclusão da avaliação da disciplina no ano lectivo em curso.'''

'''O teste prático contém uma prova eliminatória: o aluno deverá ser capaz de compilar e executar um pequeno programa em Java.'''

= Considerações Adicionais sobre a Avaliação do Projecto =

'''O projecto deverá ser desenvolvido atempadamente ao longo do período lectivo.'''

As versões intermédias registadas no GIT poderão ser testadas, pelo que deverão ser periodicamente actualizadas. O projecto é constituído por um projecto GIT designado pelo número do grupo que o executa. O repositório GIT disponibilizado já contém uma versão inicial do projecto. Apenas os ficheiros registados no projecto GIT serão considerados na avaliação.

'''Não serão consideradas quaisquer alterações a alguns dos ficheiros disponibilizados: eventuais cópias desses ficheiros serão automaticamente substituídas durante a avaliação da funcionalidade do código submetido. Ver página sobre o repositório, para mais pormenores.'''

A avaliação executa testes automáticos ao projecto a implementar: a nota reflectirá apenas os testes com sucesso. Chama-se especial atenção para o nome da classe que inicia a execução. As restantes componentes da nota são obtidas pela análise do código e resultado do teste prático (realizado individualmente). O código é avaliado quanto à sua correcção, simplicidade, extensibilidade e legibilidade: devem existir comentários das partes mais complexas, mas não devem ser excessivos, nem óbvios (diminuem a legibilidade), nem muito escassos (impedem a compreensão).

'''Qualquer alteração à especificação providenciada no enunciado é penalizada, mesmo que possa ser entendida como um melhoramento.'''

Notar que o facto de os testes automáticos terem sido superados não reflecte a qualidade do código, quer do ponto de vista de engenharia de software, quer do ponto de vista da correcta aplicação dos princípios leccionados na disciplina. A funcionalidade do projecto final é, no entanto, de extrema importância, pelo que '''é preferível um projecto que realize, correctamente, apenas parte da funcionalidade a um quase completo mas que nem sequer compile ou que não processe nenhuma entrada correctamente'''.

= Compromisso de Honra =

A entrega de quaisquer trabalhos pressupõe o compromisso de honra que foram realizados pelos autores referenciados e que resultam do esforço por cumprir os requisitos da entrega. A quebra deste compromisso, nomeadamente, a tentativa de apropriação de trabalhos alheios, terá como consequência a reprovação de todos os alunos envolvidos (incluindo os que possibilitaram a ocorrência) no ano lectivo actual, sem prejuízo de acções disciplinares previstas pelo IST.

[[category:Projecto de PO]]
[[category:PO]]
[[category:Ensino]]

Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)

2026-08-26T06:41:06Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

=Método de Avaliação do Projecto =

A avaliação relativa à componente do Projecto processa-se em várias fases:

* [[#Entrega do Modelo UML|Entrega do modelo UML]] ('''obrigatória''': ver condições abaixo)
* [[#Entrega Intermédia|Entrega intermédia]] ('''obrigatória''': ver condições abaixo)
* [[#Entrega Final|Entrega final]] ('''obrigatória''': ver condições abaixo)
* [[#Teste Prático|Teste prático]] ('''obrigatório''': ver condições abaixo)

O Projecto (trabalho conducente às entregas acima mencionadas e abaixo descritas) é realizado em grupos de 2 elementos ou individualmente durante o período estabelecido.

'''TODAS AS ENTREGAS SÃO REALIZADAS ATÉ ÀS 12:00 ("meio-dia") DAS RESPECTIVAS DATAS'''

O Teste Prático é realizado individualmente, em data e local a agendar.

'''Considerando que todas as entregas são cruciais na concepção e realização do projecto, a não realização de qualquer entrega conduz automaticamente a uma classificação de 0 (zero) na componente de avaliação relativa ao Projecto e consequente exclusão da avaliação da disciplina no ano lectivo em curso.'''

= Cálculo da Nota do Projecto e Condições de Aprovação =

Componentes de avaliação:

* '''PRJ''' - nota final do projecto
* '''PU''' - nota da entrega do diagrama UML
* '''PI'''- nota da entrega intermédia
* '''PF'''- nota da entrega final
* '''TP''' - nota do teste prático

A nota do teste prático condiciona a distância ao mínimo entre as notas do teste prático e a do projecto: desde um mínimo de 12.5% de acréscimo à menor das duas (abaixo de 7.5 valores no TP), até um máximo de 25% (para 20 valores no TP). O acréscimo é linear entre 7.5 e 20.

Ou seja:

* '''PRJ = min(PU+PI+PF, TP) + | TP - PU - PI - PF | * max(12.5, TP+5) / 100'''

Condições necessárias para aprovação à disciplina -- '''necessárias todas''':

* '''PRJ >= 9.5''' (sem arredondamento)
* '''PRJ != NA'''
* '''TP > 0'''
* '''TP != NA'''

= Entrega do Modelo UML =

A Entrega do Modelo UML avalia o estado do projecto relativamente à concepção do modelo.

Esta entrega tem uma classificação máxima de 3 valores.

'''A não realização da Entrega do Modelo UML conduz automaticamente a uma classificação de 0 (zero) na componente do projecto.'''

Devem ser entregues diagramas de classes correspondentes a todos os conceitos da aplicação, mesmo que esses conceitos venham a ser revistos/alterados futuramente. Podem ainda ser incluídas anotações nos diagramas, por forma a clarificar outros aspectos relevantes. Não é necessária a inclusão de getters/setters/equals/toString (e outros métodos já definidos no Java).
* Diagrama 1: diagrama do pacote '''po-uilib''' (material de apoio que não pode ser alterado): '''UML-po-uilib.pdf''' (não é necessário representar o conteúdo de '''pt/tecnico/uilib/swing''')
* Diagrama 2: diagrama do pacote '''erp-app''' (material do projecto completo -- pode receber adições de código em métodos '''execute''', de atributos nas classes dos comandos e de classes auxiliares): '''UML-erp-app.pdf'''
* Diagrama 3: diagrama do pacote '''erp-core''' (material do projecto incompleto e que deve ser completado e desenvolvido -- ou seja, deve incluir adicionalmente partes que correspondem à interpretação do enunciado): '''UML-erp-core.pdf'''. Este diagrama é de entrega '''obrigatória''' (grupos que não o entreguem estão excluídos da avaliação).

A entrega dos diagramas '''obrigatoriamente manuscritos''' é feita em documentos PDF na directoria "uml" do projecto no GIT. O formato é A4 (cada diagrama pode ter várias páginas) e realiza-se até à data limite: 4ª feira, 2026/10/16, 12:00 (meio-dia). Documentos ilegíveis ou noutros formatos serão sumariamente ignorados, mesmo que isso resulte em reprovação dos alunos envolvidos: é da responsabilidade dos alunos produzir material de boa qualidade nas condições de avaliação.

Apenas são aceites diagramas manuscritos e posteriormente digitalizados (usando uma aplicação como nas aulas laboratoriais): serão recusados quaisquer diagramas produzidos com ferramentas informáticas, mesmo que isso resulte em reprovação dos alunos envolvidos: é da responsabilidade dos alunos produzir material de material de boa qualidade nas condições de avaliação.

Cada diagrama deve conter a seguinte declaração de autoria, assinada sob compromisso de honra (os diagramas entregues por grupos de 2 alunos devem conter duas declarações independentes com o mesmo texto e correspondente assinatura):
'''Declaro por minha honra que este diagrama foi realizado apenas pelos elementos que constituem o grupo de projecto. (assinatura)'''

'''Diagramas entregues sem declaração de autoria serão considerados indício de fraude e os alunos correspondentes excluídos da avaliação da disciplina, sendo comunicada a situação aos órgãos da Escola.'''

Serão aplicados os seguintes critérios na avaliação da entrega UML.

Factores aditivos '''positivos''':

* 0.80 - Conceitos
* 0.50 - Herança
* 0.70 - Associações
* 0.50 - Atributos
* 0.50 - Interface (métodos das classes, interfaces, etc.)

Factores aditivos '''negativos''':

* 0.50 - Erros de notação

A compreensão clara dos aspectos acima deve ser adquirida antes da entrega.

= Entrega Intermédia =

A Entrega Intermédia avalia o estado do projecto relativamente a um mínimo de funcionalidade.

Serão executados testes automáticos nesta entrega.

Esta entrega tem uma classificação máxima de 6 valores (2.5 valores para testes automáticos).

'''A não realização da Entrega Intermédia conduz automaticamente a uma classificação de 0 (zero) na componente do projecto.'''

== Funcionalidade a implementar ==

Os pormenores dos parâmetros de avaliação desta entrega serão anunciados em breve.

== Critérios de avaliação (não automática) ==

Serão aplicados os seguintes '''critérios na avaliação da entrega intermédia''' do projecto.

Factores aditivos '''positivos''':

* 0.40 - Atributos não públicos
* 0.30 - Atributos e métodos não "static" (excepto onde autorizado)
* 0.20 - Serialização
* 1.00 - Utilização correcta de herança
* 0.50 - Utilização das estruturas de dados correctas
* 0.60 - Separação app/core (pode haver descontos na parte automática)
* 0.30 - Qualidade do projecto
* 0.20 - Comentários Javadoc (a colocar necessariamente na classe '''Erp''')

Factores aditivos '''negativos''':

* 0.15 - Violação de regras de codificação Java

Será aplicado um desconto até 1.00 pela existência de lixo no repositório GIT. Este "lixo" é apenas considerado se aparecer na cópia local durante um "checkout".

= Entrega Final =

A Entrega Final pressupõe que todo o projecto foi completamente implementado.

Esta entrega tem uma classificação máxima de 11 valores:
* 5.50 valores para a qualidade do código
* 5.50 valores para testes automáticos

'''A não realização da Entrega Final conduz automaticamente a uma classificação de 0 (zero) na componente do projecto.'''

Os testes correspondem a uma série de entradas a processar pelo projecto de cada grupo e cuja execução deve corresponder a um conjunto de resultados padrão.

Serão aplicados os seguintes critérios na avaliação da entrega final do projecto.

Factores aditivos '''positivos''': (a definir)

= Teste Prático =

O Teste Prático consiste num conjunto de questões (correspondentes a pequenas alterações/extensões ao enunciado) a resolver com base na implementação submetida para a avaliação correspondente à entrega final.

Este teste avalia o conhecimento do aluno relativamente ao projecto entregue, assim como a sua capacidade de realizar alterações ao código do projecto.

O teste prático é como uma discussão de projecto, pelo que não existem repescagens como nos testes escritos. Alunos que faltem ao teste prático estão automaticamente reprovados à disciplina.

'''A não realização do Teste Prático conduz automaticamente a uma classificação de 0 (zero) na componente de avaliação relativa ao Projecto e consequente exclusão da avaliação da disciplina no ano lectivo em curso.'''

'''O teste prático contém uma prova eliminatória: o aluno deverá ser capaz de compilar e executar um pequeno programa em Java.'''

= Considerações Adicionais sobre a Avaliação do Projecto =

'''O projecto deverá ser desenvolvido atempadamente ao longo do período lectivo.'''

As versões intermédias registadas no GIT poderão ser testadas, pelo que deverão ser periodicamente actualizadas. O projecto é constituído por um projecto GIT designado pelo número do grupo que o executa. O repositório GIT disponibilizado já contém uma versão inicial do projecto. Apenas os ficheiros registados no projecto GIT serão considerados na avaliação.

'''Não serão consideradas quaisquer alterações a alguns dos ficheiros disponibilizados: eventuais cópias desses ficheiros serão automaticamente substituídas durante a avaliação da funcionalidade do código submetido. Ver página sobre o repositório, para mais pormenores.'''

A avaliação executa testes automáticos ao projecto a implementar: a nota reflectirá apenas os testes com sucesso. Chama-se especial atenção para o nome da classe que inicia a execução. As restantes componentes da nota são obtidas pela análise do código e resultado do teste prático (realizado individualmente). O código é avaliado quanto à sua correcção, simplicidade, extensibilidade e legibilidade: devem existir comentários das partes mais complexas, mas não devem ser excessivos, nem óbvios (diminuem a legibilidade), nem muito escassos (impedem a compreensão).

'''Qualquer alteração à especificação providenciada no enunciado é penalizada, mesmo que possa ser entendida como um melhoramento.'''

Notar que o facto de os testes automáticos terem sido superados não reflecte a qualidade do código, quer do ponto de vista de engenharia de software, quer do ponto de vista da correcta aplicação dos princípios leccionados na disciplina. A funcionalidade do projecto final é, no entanto, de extrema importância, pelo que '''é preferível um projecto que realize, correctamente, apenas parte da funcionalidade a um quase completo mas que nem sequer compile ou que não processe nenhuma entrada correctamente'''.

= Compromisso de Honra =

A entrega de quaisquer trabalhos pressupõe o compromisso de honra que foram realizados pelos autores referenciados e que resultam do esforço por cumprir os requisitos da entrega. A quebra deste compromisso, nomeadamente, a tentativa de apropriação de trabalhos alheios, terá como consequência a reprovação de todos os alunos envolvidos (incluindo os que possibilitaram a ocorrência) no ano lectivo actual, sem prejuízo de acções disciplinares previstas pelo IST.

[[category:Projecto de PO]]
[[category:PO]]
[[category:Ensino]]

Programação com Objectos/Projecto de Programação com Objectos

2026-08-26T06:33:33Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
{{TOCright}}

== Avaliação do Projecto ==
* [[Programação com Objectos/Projecto de Programação com Objectos/Avaliação do Projecto (Época Normal)|Avaliação do Projecto (Época Normal)]]
* [[Programação com Objectos/Projecto de Programação com Objectos/Calendário do Teste Prático (Época Normal)|Calendário do Teste Prático (Época Normal)]]

As pautas são acompanhadas pelos critérios de avaliação. 


== Projecto: Enunciado 2026-2027 (época normal) ==

* [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2026-2027|Enunciado do Projecto 2026-2027]]
* Enunciados de anos anteriores: [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2025-2026|2025-2026]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2024-2025|2024-2025]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2023-2024|2023-2024]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2022-2023|2022-2023]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2021-2022|2021-2022]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2020-2021|2020-2021]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2019-2020|2019-2020]] [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2018-2019|2018-2019]]

== Material de Apoio e Testes ==

* [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|Repositório GIT]] - informações de localização e acesso
* [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|Material de Apoio ao Desenvolvimento]]
* Testes automáticos: https://gitlab.rnl.tecnico.ulisboa.pt/leic-a-po25/eval/po25




* [[Programação com Objectos/Projecto de Programação com Objectos/Máquina Virtual|Máquina Virtual]]

== Projecto Exemplo: Aplicação Bancária ==

Para auxiliar o desenvolvimento do projecto, é fornecida uma [[Comando (padrão de desenho)/Banco, Conta, Titular (aplicação bancária)|aplicação bancária]] (banco, contas, titulares, etc.), que tem a mesma estrutura. Esta estrutura tem duas partes principais: "core" (o núcleo lógico da aplicação) e "app" (a interface textual, baseada no padrão de desenho [[Comando (padrão_de_desenho)|Command]]).

== Projecto Exemplo: Hotel Veterinário (2024) ==

Este projecto descreve um hotel veterinário.

O enunciado corresponde ao ano lectivo de 2024/2025 e refere aspectos de implementação compatíveis com 2025/2026.
* Enunciado: [[Programação com Objectos/Projecto de Programação com Objectos/Enunciado do Projecto de 2024-2025|Hotel Veterinário]]
* Implementação (git snapshot): [[media:po24-hva-2025030036.tar.bz2]]
{{Aviso|O uso deste código deve ser feito de forma crítica, já que algumas das decisões nele tomadas podem ser alvo de descontos na avaliação do projecto.}}

== Projecto Exemplo: Rede Social (2011) ==

Este projecto descreve uma rede social com funcionalidade semelhante à das redes sociais actuais: relações entre agentes, publicação de vários tipos de media, envio de mensagens, etc.

Note-se que o enunciado corresponde ao ano lectivo de 2011/2012 e refere aspectos de implementação não disponíveis em anos seguintes. A implementação foi actualizada em 2022/2023, para ser compatível com o material de apoio dessa altura, mas não teve outras actualizações.
* Enunciado: [[media:social-network-201110241420.pdf]]
* Implementação (core): [[media:sonet-core-202111021419.tar.bz2]]
* Implementação (app: browser): [[media:sonet-app-browser-202111021419.tar.bz2]]
* Implementação (app: manager): [[media:sonet-app-manager-202111021419.tar.bz2]]
'''O uso deste código deve ser feito de forma crítica, já que algumas das decisões nele tomadas podem ser alvo de descontos na avaliação do projecto.'''

== Linguagens de Programação ==

As seguintes linguagens são utilizadas nestas páginas:

* [http://www.java.com/ Java] -- [https://docs.oracle.com/en/java/javase/ Java Platform, Standard Edition Documentation] (os testes automáticos usam OpenJDK 25)
* [http://cplusplus.com/ C++] (C++23 ou superior) -- [http://cplusplus.com/reference/ Manual de Referência para C++ (biblioteca)]; STL: [http://cplusplus.com/reference/stl/ contentores], [http://cplusplus.com/reference/algorithm/ algoritmos] 


[[category:Ensino]]
[[category:PO]]
[[category:Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Máquina Virtual

2026-08-26T06:32:56Z

Root: /* Curiosidade e Outras Aplicações */

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
__NOTOC__

== Máquina Virtual ==

A máquina virtual da disciplina é baseada em '''openSUSE Tumbleweed.''' Este ambiente é providenciado como conveniência e não é estritamente necessário: outros ambientes com as versões adequadas de Java e de clientes GIT poderão ser utilizados (mas ver avisos abaixo).

A versão mais recente da máquina virtual da disciplina, '''poo 2026.08''' está disponível em:

* https://download.opensuse.org/repositories/home:/d4vid:/po26/images/

A máquina virtual é fornecida nos formatos VMDK (VMware, VirtualBox), VHD (Microsoft HyperV) e qcow2 (KVM e outros).

A máquina permite configurações básicas (password de root, etc.) no primeiro arranque. Existe um utilizador normal chamado "poo" (password "linux").

A máquina vem sem ambiente gráfico, mas é simples instalar um com a ferramenta "yast".

{{Suggestion|Em caso de indisponibilidade da máquina virtual, ver em [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|Pacotes Binários e Ambiente Oficial]] como reproduzir o ambiente de teste a partir de openSUSE Tumbleweed.}}

{{Aviso|Tempo e esforço perdidos com ambientes ou ferramentas não recomendados ou não suportados é da inteira responsabilidade do aluno e quaisquer resultados negativos, incluindo possível reprovação, são igualmente da responsabilidade do aluno (i.e., não fazer parte da avaliação por ter usado material ou ambientes não recomendados não será aceite como justificação para qualquer falha de desempenho).}}

== Aplicação Exemplo/Tutorial: Banco ==

A máquina virtual contém os JARs da [[Comando (padrão de desenho)/Banco, Conta, Titular (aplicação bancária)|aplicação bancária]]: uma aplicação exemplo/tutorial completamente implementada e que tem a mesma estrutura do projecto.

== Curiosidade e Outras Aplicações ==

A máquina virtual pode ser útil noutros contextos e leitores interessados podem aceder às definições de construção no "build service":
* https://build.opensuse.org/package/show/home:d4vid:po26/poo

[[category: Ensino]]
[[category:PO]]
[[category:Projecto de PO]]
[[en:Object-Oriented Programming]]

Programação com Objectos/Projecto de Programação com Objectos/Máquina Virtual

2026-08-26T06:32:31Z

Root:

{{PRJPOAvisosEN20262027}}
{{PRJPOMandatory20262027}}
__NOTOC__

== Máquina Virtual ==

A máquina virtual da disciplina é baseada em '''openSUSE Tumbleweed.''' Este ambiente é providenciado como conveniência e não é estritamente necessário: outros ambientes com as versões adequadas de Java e de clientes GIT poderão ser utilizados (mas ver avisos abaixo).

A versão mais recente da máquina virtual da disciplina, '''poo 2026.08''' está disponível em:

* https://download.opensuse.org/repositories/home:/d4vid:/po26/images/

A máquina virtual é fornecida nos formatos VMDK (VMware, VirtualBox), VHD (Microsoft HyperV) e qcow2 (KVM e outros).

A máquina permite configurações básicas (password de root, etc.) no primeiro arranque. Existe um utilizador normal chamado "poo" (password "linux").

A máquina vem sem ambiente gráfico, mas é simples instalar um com a ferramenta "yast".

{{Suggestion|Em caso de indisponibilidade da máquina virtual, ver em [[Programação com Objectos/Projecto de Programação com Objectos/Material de Apoio ao Desenvolvimento|Pacotes Binários e Ambiente Oficial]] como reproduzir o ambiente de teste a partir de openSUSE Tumbleweed.}}

{{Aviso|Tempo e esforço perdidos com ambientes ou ferramentas não recomendados ou não suportados é da inteira responsabilidade do aluno e quaisquer resultados negativos, incluindo possível reprovação, são igualmente da responsabilidade do aluno (i.e., não fazer parte da avaliação por ter usado material ou ambientes não recomendados não será aceite como justificação para qualquer falha de desempenho).}}

== Aplicação Exemplo/Tutorial: Banco ==

A máquina virtual contém os JARs da [[Comando (padrão de desenho)/Banco, Conta, Titular (aplicação bancária)|aplicação bancária]]: uma aplicação exemplo/tutorial completamente implementada e que tem a mesma estrutura do projecto.

== Curiosidade e Outras Aplicações ==

A máquina virtual pode ser útil noutros contextos e leitores interessados podem aceder às definições de construção no "build service":
* https://build.opensuse.org/package/show/home:d4vid:po25/poo

[[category: Ensino]]
[[category:PO]]
[[category:Projecto de PO]]
[[en:Object-Oriented Programming]]

Template:PRJPOMandatory20262027

2026-08-26T06:31:37Z

Root:

{| class="mw-collapsible mw-collapsed wikitable" align="right" style="border-style: solid; border-width: 1px; border-color: #bbbbaa; background: #ffdb24;"
! style="padding-left:10px; padding-right:10px; border-style: solid; border-width: 0px; border-bottom-width: 0px; border-color: #bbbbaa; background: #ffdb24;" | '''Material de Uso Obrigatório'''
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 0px; border-color: #bbbbaa; " | As bibliotecas po-uilib e o conteúdo inicial do repositório GIT são de uso obrigatório:
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 0px; border-color: #bbbbaa; " |
* po-uilib (classes de base) [[media:po-uilib-202608310000.tar.bz2|po-uilib-202608310000.tar.bz2]] (não pode ser alterada) - [https://www.hlt.inesc-id.pt/~david/ist/docencia/po/2026-2027/javadoc/ javadoc]
* erp-core (classes do "core") (via GIT) (deve ser completada -- os nomes das classes fornecidas não podem ser alterados)
* erp-app (classes de interacção) (via GIT) (deve ser completada -- os nomes das classes fornecidas não podem ser alterados)
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 0px; border-color: #bbbbaa; " | A [[Programação com Objectos/Projecto de Programação com Objectos/Máquina Virtual|máquina virtual]], fornecida para desenvolvimento do projecto, já contém todo o material de apoio.
|-
! style="padding-left:10px; padding-right:10px; border-style: solid; border-width: 1px; border-bottom-width: 0px; border-color: #bbbbaa; background: #ffdb24;" | '''Uso Obrigatório: Repositório GIT'''
|-
! style="padding-left:10px; padding-right:10px; font-weight: normal; border-style: solid; border-width: 0px; border-color: #bbbbaa; " | '''Apenas se consideram para avaliação os projectos existentes no [[Programação com Objectos/Projecto de Programação com Objectos/Repositório GIT|repositório GIT oficial]]'''.

Trabalhos não presentes no repositório no final do prazo têm classificação 0 (zero) (não são aceites outras formas de entrega). Não são admitidas justificações para atrasos em sincronizações do repositório. A indisponibilidade temporária do repositório, desde que inferior a 24 horas, não justifica atrasos na submissão de um trabalho.
|}