PARÁMETROS COMUNES DE OPERACIONES

Esta sección contiene una descripción detallada de las diferentes operaciones o métodos así como información sobre sus parámetros de entrada y resultados de ejecutar la operación. Esta información puede estar incompleta al momento de la escritura de este documento dado el caracter dinámico del desarrollo de esta herramienta. Es conveniente mantener actualizado el producto a fin de aprovechar las ventajas de los cambios y solución de posible bugs.

Objetos comunes

XXX_ParametroConsulta: Objeto genérico utilizado para pasar información a los métodos que retornan listas paginadas. Donde el prefijo ‘XXX’ corresponde a los tres primeros caracteres del nombre del módulo. Por ejemplo: Vta_ParametroConsulta (Ventas), Com_ParametroConsulta (Compras).

Sintaxis: C#

public class Vta_ParametroConsulta
{ 
   public string CampoOrden;
   public string ExpresionFiltro; 
   public string Orden; 
   public int RegistroInicial; 
   public int RegistrosPorPagina;
}

Leyenda:

  • CampoOrden: Nombre del campo por el cual se desea ordenar los resultados. Los nombres deben estar entre corchetes. Ejemplo: [Descripcion].
  • ExpresionFiltro: Expresión SQL que se desea aplicar a la consulta. Los nombres deben estar entre corchetes. Ejemplo: [Descripcion] like ‘{2f5bc80c01d0ad239bef5beaa57e8f1c1427c65721f35ec3c4697a835f4d8eaa}algo{2f5bc80c01d0ad239bef5beaa57e8f1c1427c65721f35ec3c4697a835f4d8eaa}’
  • Orden: Dirección del ordenamiento de los resultados. (0=asc. por defecto) (1=desc).RegistrosPorPagina: Cantidad de registros en una página. (50 por defecto)
  • RegistroInicial: Numero de fila a partir del cual se devolverán los registros. (1 por defecto).
  • RegistrosPorPagina; Número de registros por llamada.
  • Selector (a veces): Especifica el tipo de consulta. Si es falso (false) devuelve todos los campos de la tabla. Si es verdadero (true) devuelve solo los campos principales. (Ejemplo: Codigo, Descripción, Clase, Activo) estos campos a menudo son utilizados para mostrar listados de selección, búsqueda entre otros. (False por defecto)

SaintResult: Objeto genérico devuelto por los métodos del servidor de reglas de negocios.
Sintaxis: C#

public class SaintResult
{ 
   public int Status; 
   public string Message;
   public <T> Data;
}

Leyenda:

  • Status: Código del estado de la operación (0 = éxito)
  • Message: Mensaje de información.
  • <T>: Modelo de datos (Ver la página de Modelos de datos)
  • Data: Datos devueltos.