Skip to content

REF-60-A: Mapeamento de Enums do Domínio Engine

REF-60-A: Mapeamento de Enums do Domínio Engine

ADR: ADR-60 Status: Aceito Data: 2026-04-23

Contexto

O domínio engine usa enums técnicos para status, causas, ciclos e tipos de componentes. Este REF mapeia cada enum ao term canônico correspondente em .vigim/ddd/terms/terms-engine.yaml.

Os enums de flow_type, block_type e activities já estão mapeados no REF-50-A (referem-se à Sequence do plan, domínio product). Este REF cobre os enums exclusivos do engine.


roadmap_status

Enum Term canônico Uso
not_started Não Iniciado Plano criado no Primeiro Acesso, execução não começou
in_progress Em Execução Aluno está executando Blocos/Fluxos ativamente
completed Concluído Critério de Conclusão Pedagógica satisfeito
blocked Bloqueado Indisponível — ver roadmap_block_cause
terminated Encerrado Vigência expirada ou revogação total
interrupted Interrompido Pausa administrativa ou excepcional

roadmap_block_cause

Enum Term canônico Uso
access_expiration Expiração de Acesso Vigência da Matrícula expirou naturalmente
temporal_unavailability Indisponibilidade Temporal Regra de Disponibilidade impede acesso temporariamente
access_rule Regra de Acesso Pré-requisito ou condição de acesso não satisfeita
access_revocation Revogação de Acesso Decisão comercial/administrativa encerrou acesso

study_flow_status

Enum Term canônico Uso
future Futuro Fluxo ainda não acessível pelo Aluno
current Atual Fluxo vigente — ponteiro do Motor
completed Concluído Todos os Blocos do Fluxo concluídos

study_block_status

Enum Term canônico Uso
future Futuro Bloco ainda não elegível para execução
current Atual Bloco em execução — ponteiro do Motor
completed Concluído Regra de Conclusão satisfeita para este Bloco

cda_cycle_status

Enum Term canônico Uso
not_started Não Iniciado Bloco CDA criado mas DI não iniciado
di_in_progress DI em Andamento Aluno respondendo Questionário VF do DI
di_completed DI Concluído Classificação do DI registrada; atividades em execução
svd_in_progress SVD em Andamento Aluno respondendo Questionário VF do SVD
svd_completed SVD Concluído Reclassificação registrada; Leitura de Reforço se necessário
completed Concluído Ambos Segmentos finalizados
exempted Dispensado Ciclo CDA não aplicável (preset sem CDA)

conclusion_type

Enum Term canônico Uso
full_plan_completion Conclusão Total do Plano Plano só é concluído quando 100% das atividades forem executadas
minimum_execution_percentage Percentual Mínimo de Execução Plano concluído ao atingir % mínimo configurado na Trilha
minimum_time_compliance Cumprimento de Prazo Mínimo Plano concluído quando prazo mínimo de execução for atingido
maximum_time_compliance Cumprimento de Prazo Máximo Plano concluído ao esgotar o prazo máximo configurado
final_assessment_approval Aprovação em Avaliação Final Plano concluído quando Avaliação Final for aprovada
product_specific_criterion Critério Específico por Produto Critério customizado definido no Produto, avaliado por regra própria

enrolment_status

Enum Term canônico Uso
active Ativa Aluno pode acessar e executar o estudo
suspended Suspensa Acesso temporariamente bloqueado (reversível)
inactive Inativa Acesso encerrado (expiração, revogação, cancelamento)

enrolment_inactivation_reason

Enum Term canônico Uso
access_expiration Expiração de Acesso Vigência expirou naturalmente
commercial_cancellation Cancelamento Comercial Pedido cancelado pelo sistema de pagamento
access_revocation Revogação de Acesso Decisão administrativa de encerramento
administrative Administrativa Outro motivo operacional/excepcional

questionnaire_status

Enum Term canônico Uso
created Criado Sessão criada, aguardando início
started Iniciado Aluno respondendo perguntas
paused Pausado Sessão interrompida, pode retomar
completed Finalizado Todas as respostas submetidas
evaluated Avaliado Resultado processado e classificação feita

flashcard_session_status

Enum Term canônico Uso
created Criados Flashcards montados, sessão pronta
started Iniciados Aluno praticando
paused Pausados Sessão interrompida
completed Finalizados Prática concluída, resultado salvo

Regras de uso

  1. Os enums acima são os únicos valores válidos nos contracts JSON do engine
  2. O código PHP deve usar constantes derivadas destes enums (padrão MIDDAG)
  3. Novos valores devem ser adicionados primeiro nos terms, depois neste REF, depois nos contracts
  4. O mapeamento term → enum é 1:1 — não criar aliases
  5. Enums de flow_type, block_type e activities estão no REF-50-A — não duplicar aqui
Navigation

Type to search…

↑↓ navigate↵ selectEsc close