Métodos Generales

La manipulación de datos de una entidad en ZetaSoftware se lleva a cabo a través de una serie de Métodos. Cada uno de estos métodos tiene funciones específicas que describiremos en detalle.

Método Query

Obtiene una lista de registros de una entidad específica. A continuación, explicamos las subestructuras y campos que se pueden incluir en una consulta utilizando este método:

Datos de envío

Búsqueda Genérica

El campo ‘Search’ permite la realización de búsquedas genéricas dentro de una serie de campos predefinidos, generalmente de formato texto. Este mecanismo resulta útil para hallar registros que incluyan una palabra específica. Por ejemplo, al introducir una palabra en el campo Search de la sección de clientes, el sistema buscará esa palabra en el Nombre del cliente y en su Razón Social.

Filtros

Los filtros sirven para segmentar o restringir los resultados de la consulta, enfocándose en campos específicos de la entidad consultada. Los filtros soportan tres tipos de condiciones de búsqueda:

• Búsqueda por rango: En este caso, se utilizarán dos campos (Desde/Hasta) para definir un rango de valores, que pueden ser numéricos o de fechas, dentro del cual se buscará.
• Búsqueda por contenido o ‘like’: Este filtro buscará el texto ingresado en cualquier segmento del campo específico. Si, por ejemplo, se introduce la palabra ‘Juan’ en un campo destinado a nombres de clientes, se obtendrán todos los registros donde ‘Juan’ aparezca en el nombre.
• Búsqueda por igualación: Este filtro busca registros que coincidan exactamente con el valor especificado. Es particularmente útil para encontrar, por ejemplo, todas las facturas asociadas a un código de cliente en particular.

Paginado (Page)

Para evitar la saturación de los servicios, toda consulta devuelve un máximo de 500 registros. El campo ‘Page’ permite acceder a conjuntos adicionales de registros, indicando el número de la página de resultados deseada. Si, por ejemplo, se introduce el valor 3, se accederán a los registros del 1500 al 1999. La omisión de este campo resultará en la devolución de la primera página de resultados, es decir, los primeros 500 registros.

Datos de Devolución

Success y Error

Al finalizar la consulta, el sistema devolverá un valor booleano bajo el campo ‘Success’, que indica si la operación fue exitosa o no. Un valor negativo (False) generalmente está relacionado con problemas en los datos de conexión. En caso de fallo, el sistema proporciona información detallada sobre el motivo del error en una subestructura que incluye:

• ‘Code’: Un código interno que identifica el error.
• ‘Message’: Un mensaje textual que detalla la naturaleza del error.

Response

Este es el campo donde se listará el conjunto de registros obtenidos como resultado de la consulta, facilitando así la interpretación y posterior manipulación de los datos.

Método Load

El Método Load es especialmente útil cuando se requiere obtener información detallada de un registro específico de una entidad. Este método es fundamental cuando se planifica modificar algún valor de la entidad y es necesario asegurarse de contar con todos los campos relevantes antes de hacerlo. Aquí abordamos sus principales características y estructura:

Datos de envío

Clave de la Entidad

Para utilizar este método, los datos de envío serán exclusivamente las claves que identifican la entidad en cuestión. Estas claves son fundamentales para acceder a la información precisa y completa del registro deseado.

Resultados Compuestos

En ciertos casos, el método Load no se limita a devolver los datos de la tabla principal de la entidad. Puede incluir también registros de una o más tablas subordinadas. Esta funcionalidad es relevante cuando se busca efectuar una Unidad de Transacción Lógica (UTL), donde se necesite consolidar la información de diversas tablas en una única operación o «commit».

Datos de Devolución

Success y Error

Similar al Método Query, el sistema indicará si la operación fue exitosa mediante un valor booleano en el campo ‘Success’. Un resultado negativo usualmente se debe a problemas relacionados con los datos de conexión. Si el resultado es negativo, se proporcionará una estructura detallada del error, que incluye:

• ‘Code’: Código interno que identifica el tipo de error.
• ‘Message’: Descripción detallada del error para facilitar su diagnóstico y resolución.

Response

El campo ‘Response’ es donde se encuentra la información solicitada. Aquí se devolverán todos los campos de la tabla principal de la entidad consultada. Si la entidad trabaja con tablas subordinadas que también requieren ser actualizadas en la misma UTL, el ‘Response’ incluirá igualmente todos los registros de dichas tablas subordinadas.

El Método Load ofrece una forma eficiente y detallada de acceder a la información completa de un registro, siendo una herramienta esencial para cualquier operación que requiera modificaciones o análisis profundos.

Método Save

El Método Save es central para cualquier sistema de gestión de datos, ya que permite tanto la inserción de nuevos registros como la actualización de registros existentes en una entidad. Este método se distingue por su versatilidad y profundidad, ya que puede abordar tanto la tabla principal como tablas subordinadas de una entidad. A continuación, se describen sus características fundamentales:

Datos de Envío

Totalidad de Campos

A diferencia de otros métodos que podrían requerir solo claves o subconjuntos de campos, el Método Save exige el envío de la totalidad de campos de la entidad. Esto es crucial para asegurar la integridad y completitud de la operación, especialmente cuando se trata de actualizaciones.

UTL (Unidad de Transacción Lógica)

Al igual que con el método Load, el Save puede manejar Unidades de Transacción Lógica. Esto significa que es posible no solo actualizar la tabla principal de la entidad sino también una o más tablas subordinadas en un único «commit». La utilidad de esto radica en la posibilidad de efectuar operaciones complejas y relacionadas de manera atomizada, asegurando la integridad de los datos a través de todas las tablas implicadas.

Datos de Devolución

Success y Error

El campo ‘Success’ devolverá un valor booleano que señala si la operación de inserción o actualización se realizó con éxito. Si el resultado es negativo, el sistema generará una estructura de error compuesta por:

• ‘Code’: Representa el código interno para tipificar el error.
• ‘Message’: Ofrece un mensaje detallado que describe el tipo de error ocurrido.

Detalle del Error

En el caso de un resultado negativo, el campo ‘Detail’ proveerá una lista de errores detallados con la siguiente estructura:

• ‘Id’: Identificación interna del error específico.
• ‘Tipo’: Se clasifica si es un Error o un Warning.
• ‘Descripcion’: Brinda un detalle específico sobre la naturaleza del error o advertencia.

Esta estructura minuciosa en la devolución de errores facilita la tarea de diagnóstico y resolución, permitiendo una intervención rápida y efectiva.

El Método Save, por lo tanto, es una herramienta robusta y completa para la manipulación de datos, que ofrece un control detallado y la posibilidad de realizar operaciones complejas y relacionadas en una única transacción.

Método Delete

El Método Delete es esencial en cualquier sistema de manejo de datos, ya que facilita la eliminación segura y precisa de registros específicos en una entidad. Aunque podría parecer una operación sencilla, es crucial entender que este método conlleva una serie de aspectos importantes que necesitan ser manejados con cuidado. A continuación se detallan sus características:

Datos de Envío

Clave de la Entidad

Para iniciar el proceso de eliminación, es necesario enviar las claves correspondientes a la entidad en cuestión. Estas claves actúan como identificadores únicos que permiten al sistema localizar y eliminar el registro específico, asegurando así que la operación sea precisa y segura.

Datos de Devolución

Valor Boolean ‘Success’

Una vez ejecutada la operación, el sistema devolverá un valor booleano a través del campo ‘Success’, que indicará si la eliminación se ha realizado con éxito o no. Este mecanismo de confirmación es esencial para validar que la acción se ha completado como se esperaba.

Estructura de Error

Si la operación no se puede completar exitosamente, el sistema generará un informe detallado sobre la falla. Este informe incluirá:

• ‘Code’: Un código interno que clasifica el tipo de error.
• ‘Message’: Un mensaje textual que proporciona detalles adicionales sobre el error.

Detalles Adicionales del Error

Para un diagnóstico más profundo, el campo ‘Detail’ suministrará una lista de errores más específicos que pueden haber ocurrido durante la operación, estructurada de la siguiente manera:

• ‘Id’: La identificación interna del error particular.
• ‘Tipo’: Clasificación del evento como Error o Warning.
• ‘Descripcion’: Explicación detallada del error o advertencia que se ha producido.

El nivel de detalle en la retroalimentación de errores está diseñado para facilitar el diagnóstico y la corrección rápida de problemas, lo que es crucial dado que estamos tratando con la eliminación de datos, una operación irreversible y de alta sensibilidad.

En suma, el Método Delete no es solo una función de eliminación, sino una herramienta cuidadosamente diseñada para asegurar que este proceso delicado se maneje con la máxima precisión y seguridad.