Modelo Técnico: ItemStyle

Ubicación SSoT: com.neosystima.app.modules.tenant.data.model.ItemStyle

Campo API: description

String? REQUIRED

1. Definición de Negocio

Atributo	Detalle
Etiqueta	Descripción Detallada
Descripción	Proporciona detalles adicionales sobre la categoría para aclarar a qué se refiere el nombre.
Dominio	Controlado, por ejemplo [A-Za-z0-9 ]
Público	🟢

2. Capa de Interfaz (Frontend)

Requerimiento	Reglas Visuales
Grilla: 🟢 Forms: 🟢	Formato: Estándar Regla UI: Un campo de texto estándar de una sola línea. Incluir botón eliminar contenido.

3. Seguridad y Auditoría

Parámetro	Valor
Sensibilidad	LOW
Encriptado	🔴
Indexado	🟢
Auditado	🟢

4. Especificaciones Técnicas

• Valor Default: N/A
• Fuente / Dueño: Ingreso manual del usuario / Sistema
• Validaciones Raw: Ninguna adicional.
• Longitud Max: 100

Ejemplo de Integración:

{
  "description": "Categoría principal de bebidas, Solo para uso interno"
}

---

Campo API: itemGroup

ItemGroup?

1. Definición de Negocio

Atributo	Detalle
Etiqueta	Grupo de Ítems Asociado
Descripción	Referencia al Grupo de Ítems al que pertenece este estilo. Define la jerarquía del menú.
Dominio	Tabla ItemGroup
Público	🟢

2. Capa de Interfaz (Frontend)

Requerimiento	Reglas Visuales
Grilla: 🟢 Forms: 🟢	Formato: Estándar Regla UI: En formularios de edición, se muestra como un campo de texto de solo lectura (deshabilitado)

3. Seguridad y Auditoría

Parámetro	Valor
Sensibilidad	LOW
Encriptado	🔴
Indexado	🟢
Auditado	🟢

4. Especificaciones Técnicas

• Valor Default: N/A
• Fuente / Dueño: Generado por el sistema. / Sistema
• Validaciones Raw: El registro foráneo debe existir en la base de datos.
• Longitud Max: 255

Ejemplo de Integración:

{
  "itemGroup": "1, 2, 3, 4"
}

---

Campo API: menuItems

MenuItem>

1. Definición de Negocio

Atributo	Detalle
Etiqueta	Ítems Asociados
Descripción	Colección de ítems (Nivel 4) que pertenecen a este estilo.
Dominio	Tabla MenuItem
Público	🔴

2. Capa de Interfaz (Frontend)

Requerimiento	Reglas Visuales
Grilla: 🔴 Forms: 🔴	Formato: Lista Regla UI: Grilla anidada (Master-Detail).

3. Seguridad y Auditoría

Parámetro	Valor
Sensibilidad	LOW
Encriptado	🔴
Indexado	🔴
Auditado	🔴

4. Especificaciones Técnicas

• Valor Default: Lista vacía
• Fuente / Dueño: Sistema / Sistema
• Validaciones Raw: N/A
• Longitud Max: 255

Ejemplo de Integración:

{
  "menuItems": "[]"
}

---

Campo API: name

String? REQUIRED

1. Definición de Negocio

Atributo	Detalle
Etiqueta	Nombre del Estilo
Descripción	Nombre corto y descriptivo del estilo (ej: Picante, Vegano, Familiar).
Dominio	Controlado, por ejemplo [A-Za-z0-9 ]
Público	🟢

2. Capa de Interfaz (Frontend)

Requerimiento	Reglas Visuales
Grilla: 🟢 Forms: 🟢	Formato: Estándar Regla UI: Un campo de texto estándar de una sola línea. Incluir botón eliminar contenido.

3. Seguridad y Auditoría

Parámetro	Valor
Sensibilidad	LOW
Encriptado	🔴
Indexado	🟢
Auditado	🟢

4. Especificaciones Técnicas

• Valor Default: N/A
• Fuente / Dueño: Ingreso manual del usuario / Sistema
• Validaciones Raw: Único junto con grupo y descripción.
• Longitud Max: 50

Ejemplo de Integración:

{
  "name": "Gaseosas, Jugo, Agua"
}

---

Campo API: sortOrder

Int REQUIRED

1. Definición de Negocio

Atributo	Detalle
Etiqueta	Orden de Visualización
Descripción	Número que define la posición en la que se mostrará un registro en una lista.
Dominio	Controlado, por ejemplo [0-9]. Rango de 0 a 99.
Público	🟢

2. Capa de Interfaz (Frontend)

Requerimiento	Reglas Visuales
Grilla: 🟢 Forms: 🟢	Formato: Estándar Regla UI: Un campo de entrada numérico pequeño (spinner).

3. Seguridad y Auditoría

Parámetro	Valor
Sensibilidad	LOW
Encriptado	🔴
Indexado	🟢
Auditado	🟢

4. Especificaciones Técnicas

• Valor Default: 0
• Fuente / Dueño: Ingreso manual del usuario / Sistema
• Validaciones Raw: Debe ser un número entero positivo.
• Longitud Max: 255

Ejemplo de Integración:

{
  "sortOrder": "1, 2, 20, 100, 999"
}

---

Campo API: status

Status?

1. Definición de Negocio

Atributo	Detalle
Etiqueta	Estado
Descripción	Identificador numérico foráneo del estado.
Dominio	Tabla Status
Público	🟢

2. Capa de Interfaz (Frontend)

Requerimiento	Reglas Visuales
Grilla: 🟢 Forms: 🟢	Formato: Estándar Regla UI: Debe ser un select que ofrezca el name de todos los registros en la tabla status filtrados por los scopes correspondientes.

3. Seguridad y Auditoría

Parámetro	Valor
Sensibilidad	LOW
Encriptado	🔴
Indexado	🟢
Auditado	🟢

4. Especificaciones Técnicas

• Valor Default: N/A
• Fuente / Dueño: Sistema / Sistema
• Validaciones Raw: Debe ser un ID válido del dominio de estados.
• Longitud Max: 255

Ejemplo de Integración:

{
  "status": "1 (Activo), 2 (Inactivo)"
}

---

Campo API: code

String? REQUIRED

1. Definición de Negocio

Atributo	Detalle
Etiqueta	Código de Referencia
Descripción	Identificador único de negocio para el registro.A diferencia del ID numérico interno, este código está pensado para ser expuesto y facilitar búsquedas o referencias.
Dominio	Secuencia controlada o formato prefijado
Público	🟢

2. Capa de Interfaz (Frontend)

Requerimiento	Reglas Visuales
Grilla: 🟢 Forms: 🟢	Formato: Alfanumérico Regla UI: Se muestra como referencia (usualmente entre paréntesis) junto al título del formulario. No es un campo editable en el flujo estándar.

3. Seguridad y Auditoría

Parámetro	Valor
Sensibilidad	LOW
Encriptado	🔴
Indexado	🟢
Auditado	🟢

4. Especificaciones Técnicas

• Valor Default: Generado por secuencia
• Fuente / Dueño: Generado automáticamente por el motor de secuencias del sistema / Sistema
• Validaciones Raw: Debe ser estrictamente único en toda la tabla.
• Longitud Max: 20

Ejemplo de Integración:

{
  "code": "000001, CLI-005, STY-20"
}

---

Campo API: createdAt

Instant? REQUIRED

1. Definición de Negocio

Atributo	Detalle
Etiqueta	Fecha de Creación
Descripción	Fecha y hora exacta en la que se insertó el registro por primera vez.
Dominio	Fechas válidas pasadas o presentes
Público	🟢

2. Capa de Interfaz (Frontend)

Requerimiento	Reglas Visuales
Grilla: 🔴 Forms: 🟢	Formato: Timestamp (ISO 8601) Regla UI: Selector de fecha/hora. En creación está oculto, en edición se muestra como solo lectura.

3. Seguridad y Auditoría

Parámetro	Valor
Sensibilidad	LOW
Encriptado	🔴
Indexado	🔴
Auditado	🔴

4. Especificaciones Técnicas

• Valor Default: CURRENT_TIMESTAMP
• Fuente / Dueño: Generado automáticamente por el framework de auditoría / Sistema
• Validaciones Raw: No modificable tras su creación (updatable = false).
• Longitud Max: 255

Ejemplo de Integración:

{
  "createdAt": "2025-10-15T14:30:00Z"
}

---

Campo API: createdBy

String?

1. Definición de Negocio

Atributo	Detalle
Etiqueta	Creado Por
Descripción	Identificador principal del usuario que creó originalmente el registro.
Dominio	Usuarios válidos en el contexto de seguridad
Público	🟢

2. Capa de Interfaz (Frontend)

Requerimiento	Reglas Visuales
Grilla: 🔴 Forms: 🟢	Formato: Alfanumérico Regla UI: Campo de texto estándar. En creación está oculto, en edición se muestra como solo lectura.

3. Seguridad y Auditoría

Parámetro	Valor
Sensibilidad	MEDIUM
Encriptado	🔴
Indexado	🔴
Auditado	🔴

4. Especificaciones Técnicas

• Valor Default: N/A
• Fuente / Dueño: Extraído del contexto de seguridad (SecurityContext) / Sistema
• Validaciones Raw: No modificable tras la creación.
• Longitud Max: 50

Ejemplo de Integración:

{
  "createdBy": "admin, guest, USR-001"
}

---

Campo API: id

Long? REQUIRED

1. Definición de Negocio

Atributo	Detalle
Etiqueta	Identificador del Sistema
Descripción	Identificador numérico interno y clave primaria (Primary Key) del registro en la base de datos.
Dominio	Números enteros positivos mayores a 0
Público	🔴

2. Capa de Interfaz (Frontend)

Requerimiento	Reglas Visuales
Grilla: 🔴 Forms: 🔴	Formato: Numérico (BigInt) Regla UI: Campo oculto o deshabilitado. No se expone directamente al usuario final para edición.

3. Seguridad y Auditoría

Parámetro	Valor
Sensibilidad	LOW
Encriptado	🔴
Indexado	🟢
Auditado	🔴

4. Especificaciones Técnicas

• Valor Default: Asignación automática
• Fuente / Dueño: Autoincrementable y asignado por el motor de BD al insertar (INSERT). / Sistema
• Validaciones Raw: Único e irrepetible. De solo lectura tras su creación.
• Longitud Max: 255

Ejemplo de Integración:

{
  "id": "1, 2, 1054"
}

---

Campo API: isSystem

Boolean REQUIRED

1. Definición de Negocio

Atributo	Detalle
Etiqueta	Registro de Sistema
Descripción	Marca técnica que indica si el registro fue creado por el sistema y posee restricciones (ej: no se puede borrar o editar su código).
Dominio	{true, false}
Público	🔴

2. Capa de Interfaz (Frontend)

Requerimiento	Reglas Visuales
Grilla: 🔴 Forms: 🟢	Formato: Booleano Regla UI: Casilla de verificación (Checkbox) o Interruptor (Toggle). En formularios se muestra deshabilitado (solo lectura).

3. Seguridad y Auditoría

Parámetro	Valor
Sensibilidad	LOW
Encriptado	🔴
Indexado	🔴
Auditado	🟢

4. Especificaciones Técnicas

• Valor Default: false
• Fuente / Dueño: Generado por el sistema / Sistema
• Validaciones Raw: No modificable por el usuario final (bloqueado a nivel de servicio).
• Longitud Max: 255

Ejemplo de Integración:

{
  "isSystem": "true, false"
}

---

Campo API: lastModifiedBy

String?

1. Definición de Negocio

Atributo	Detalle
Etiqueta	Modificado Por
Descripción	Identificador principal del usuario que realizó la última modificación al registro.
Dominio	Usuarios válidos en el contexto de seguridad
Público	🟢

2. Capa de Interfaz (Frontend)

Requerimiento	Reglas Visuales
Grilla: 🔴 Forms: 🟢	Formato: Alfanumérico Regla UI: Campo de texto estándar. En creación está oculto, en edición se muestra como solo lectura.

3. Seguridad y Auditoría

Parámetro	Valor
Sensibilidad	LOW
Encriptado	🔴
Indexado	🔴
Auditado	🔴

4. Especificaciones Técnicas

• Valor Default: N/A
• Fuente / Dueño: Extraído del contexto de seguridad (SecurityContext) / Sistema
• Validaciones Raw: Ninguna adicional.
• Longitud Max: 50

Ejemplo de Integración:

{
  "lastModifiedBy": "admin, manager"
}

---

Campo API: updatedAt

Instant?

1. Definición de Negocio

Atributo	Detalle
Etiqueta	Última Actualización
Descripción	Fecha y hora de la última modificación del registro.
Dominio	Fechas válidas pasadas o presentes
Público	🟢

2. Capa de Interfaz (Frontend)

Requerimiento	Reglas Visuales
Grilla: 🔴 Forms: 🟢	Formato: Timestamp (ISO 8601) Regla UI: Selector de fecha/hora. En creación está oculto, en edición se muestra como solo lectura.

3. Seguridad y Auditoría

Parámetro	Valor
Sensibilidad	LOW
Encriptado	🔴
Indexado	🔴
Auditado	🔴

4. Especificaciones Técnicas

• Valor Default: CURRENT_TIMESTAMP
• Fuente / Dueño: Generado automáticamente por el framework de auditoría / Sistema
• Validaciones Raw: Se actualiza automáticamente en cada operación de modificación (UPDATE).
• Longitud Max: 255

Ejemplo de Integración:

{
  "updatedAt": "2025-10-16T09:15:00Z"
}

---