business-rule

Regra de Negocio (@BusinessRule) — Addon Studio 2.0

@BusinessRule implementa logica automatica disparada por eventos do ciclo de vida comercial — principalmente confirmacao e faturamento de documentos (Pedidos, Notas de Venda). Disponivel a partir do Addon Studio 2.0.

Referencias complementares:

• dependency-injection — Injecao de dependencia (Guice)

---

1. Quando usar — @BusinessRule vs @Callback vs @Listener

Hook	Escopo	Quando usar
@BusinessRule	Notas de Saida e Mov. Interna (Vendas, Remessas, etc.)	Logica que interage com barramento de regras (ContextoRegra): liberacoes de limite, validacoes complexas na confirmacao/faturamento.
@Callback	Todos documentos comerciais, incluindo Notas de Entrada	Eventos de negocio onde @BusinessRule nao atua (ex: notas de compra) ou quando barramento nao e necessario.
@Listener	Operacoes CRUD (insert/update/delete) em qualquer entidade	Validacoes e modificacoes de campo disparadas ao salvar/excluir. Preferir para CRUD simples.

Regra rapida:

• Liberacao de limite em nota de venda? @BusinessRule.
• Validar nota de compra na confirmacao? @Callback.
• Logica ao salvar/excluir qualquer registro? @Listener.

---

2. Anatomia de um @BusinessRule

import br.com.sankhya.jape.vo.DynamicVO;
import br.com.sankhya.modelcore.comercial.Regra;
import br.com.sankhya.modelcore.comercial.ContextoRegra;
import br.com.sankhya.studio.annotations.hooks.BusinessRule;
import com.google.inject.Inject;

@BusinessRule(description = "Valida desconto na confirmacao")
public class ValidacaoDescontoRegra implements Regra {

    private final DescontoService descontoService;

    @Inject
    public ValidacaoDescontoRegra(DescontoService descontoService) {
        this.descontoService = descontoService;
    }

    @Override
    public void beforeUpdate(ContextoRegra ctx) throws Exception {
        DynamicVO notaVO = (DynamicVO) ctx.getPrePersistEntityState().getNewVO();
        // logica de negocio delegada ao Service
        descontoService.validar(notaVO, ctx.getBarramentoRegra());
    }

    // A interface exige os 6 metodos (sem default) — deixe vazios os que nao usar
    @Override public void beforeInsert(ContextoRegra ctx) throws Exception {}
    @Override public void afterInsert(ContextoRegra ctx) throws Exception {}
    @Override public void afterUpdate(ContextoRegra ctx) throws Exception {}
    @Override public void beforeDelete(ContextoRegra ctx) throws Exception {}
    @Override public void afterDelete(ContextoRegra ctx) throws Exception {}
}