Cl.Core.Structures 1.2.0-alpha

Acerca de Cl.Core.Structures

Contiene todas aquellas estructuras que se han considerado estandar en todos los procesos que pueden presentar las aplicaciones.

¿Qué resuelve?

Cada vez que tenemos que lidiar con la creación de esctructuras de datos, como clases, interfaces, exisite un conjunto de estos que son muy similiar en cuanto comportamiento y al no existir un estandar los desarrolladores declaran clases como por ejemplo user o User y con las propiedades Nombre o nombre, incluso en inglés Name o name. La idea con este nuget es poder agrupar todas estas estructuras para que en la mayoría de proyectos tengamos esta consistencia al momento de implementar nuevas funcionalidades.

Resumen de versión

Cambios (Changes)

• Se realiza un mapeo especial de la excepción solamente si es Newtonsoft.Json.JsonSerializationException

Clases

Response<T>

• T Data: Va a contener la información que deseamos retornar.
• System.String Message: Variable opcional para indicar algún evento que queramos comunicar.
• Reponse(): Contructor base de la base
• Reponse(System.Exception): Contructor que nos permite de manera automática mapear una excepción y retornarla al ui.

Usada generalmente para contener tanto la información como el detalle de un error que queramos indicar.

Ejemplo:

// Este método retorna un objeto de tipo Context<T>, pero se accede a la propiedad response al final
var user = Execute<User, AppContext, System.Int16>("spGetUserById", 5).Response;

Context<T>

• Cl.Core.Structures.Classes.Response<T> Response: Objeto genérico que contiene la información a retornar.
• System.Net.HttpStatusCode Code: Estatus de la petición tras haber sido ejecutada.

Esta clase representa el estado final de una transacción que hayamos intentado hacer en nuestro backend, la cual debe ser evaluda según el código http.

Ejemplo:

// Este método retorna un objeto de tipo context
var user = Execute<User, AppContext, System.Int16>("spGetUserById", 5);

Interfaces

ICLMaster

Usada para definir límites en funciones, por ejemplo en contraints

Ejemplo:

// Usada en una función para indicar que solo podemos usar objetos que implementes esta interfaz
where V : Cl.Core.Structures.Interfaces.ICLMaster

ICLInclude

Usada para indicar que se deben incluir los elementos según en el contexto en el que se use.

Ejemplo:

// Incluyendo la propiedad "Id" en la la lista.
var users = Execute<User, AppContext, Cl.Core.Structures.Interfaces.ICLInclude>("spGetUsers", user, new System.String[] { "Id" });

ICLExclude

Usada para indicar que se deben excluir los elementos según en el contexto en el que se use.

Ejemplo:

// Excluyendo la propiedad "Id" en la lista.
// var users= Execute<User, AppContext, Cl.Core.Structures.Interfaces.ICLExclude>("spGetUsers", user, new System.String[] { "Id" });

Enums

EmailDomains

Nos permite conocer los dominios que podría procesar una aplicación

Ejemplo:

// Uso del enum
var valor = Cl.Core.Structures.Enums.EmailDomains.Gmail;

DaysOfWeek

Contiene los días de la semana, el primer día es el Domingo.

Ejemplo:

// Uso del enum
var valor = Cl.Core.Structures.Enums.DaysOfWeek.Sunday;

UdfType

Nos informa sobre el tipo de datos que permiten los UDFs.

Ejemplo:

// Uso del enum
var valor = Cl.Core.Structures.Enums.UdfType.Numeric;

ObjectStatus

Indica el estado en el que se encuentra un objeto.

Ejemplo:

// Uso del enum
var valor = Cl.Core.Structures.Enums.ObjectStatus.Stashed;

ObjectTypes

Representa todos los objetos que sap puede manejar a nivel del sdk.

Ejemplo:

// Uso del enum
var valor = Cl.Core.Structures.Enums.ObjectTypes.Items;

Clavis Consultores ©