Objects

Introduction

To Code provides the ability to define an Object based on defining the properties.

In a Code Model, the term "objects" generally represent real-world concepts or systems that you want to model within your Code Model.

Each object can have properties and behaviors related to the concept it represents.

Here’s a general definition and explanation for objects in a code model.

Note: To Code provide by default the models of defined entities in your Data Model.

Syntax

Craft custom objects that serve the unique needs of your application, from supporting Code Model operations to enriching your business logic.

LogicalId

{
  "LogicalId": "LocalizedObject",
}

• Description: A unique identifier for the object within the code model, often used to reference the object from other parts of the Code Model.

Description

{
  "Description": "for multiple localization field",
}

• Description: A textual explanation of the object's purpose or role within the system, providing context to developers or users.

Properties

{
  "Properties": [
        {
            "DataType": "String",
            "MaxLength": 150,
            "DefaultValue": null,
            "RegularExpression": null,
            "LogicalId": "Code",
            "Description": "code name and it is unique",
            "Required": true,
            "IsUnique": false,
            "AutoGenerate": false
        }
    ],
}

• Description: A list of attributes that define the data structure of the object. Each property has its own metadata, including:

  • DataType: The type of data expected, the defined types listed as following:
    • Char:

      {
          "DataType": "Char",
          "DefaultValue": null,
          "LogicalId": "Code",
          "Description": "code name and it is unique",
          "Required": true,
          "IsUnique": false,
          "AutoGenerate": false
      }
    • String:
      • Refer to the above example.
    • Integer number as following:
      • Int16:
      • UInt16:
      • Int32:
      • UInt32:
      • Int64:
      • UInt64:

        {
            "DataType": "Int16",
            "DefaultValue": null,
            "LogicalId": "Age",
            "Description": "Age",
            "Required": true,
            "IsUnique": false,
            "AutoGenerate": false,
            "MaxValue" = 120,
            "MinValue" = 0  
        }
    • Float number as following:
      • Decimal:
      • Double:

        {
            "DataType": "Decimal",
            "DefaultValue": null,
            "LogicalId": "Cost",
            "Description": "Cost of item",
            "Required": true,
            "IsUnique": false,
            "AutoGenerate": false,
            "MaxValue":10000,
            "MinValue": 0,
            "Format": null, 
        }
    • DateTime:

      {
          "DataType": "DateTime",
          "DefaultValue": null,
          "LogicalId": "CreatedDate",
          "Description": "Created Date",
          "Required": true,
          "IsUnique": false,
          "AutoGenerate": false,
          "Format":null, 
          "DateAndTime": true
      }
    • TimeSpan:

      {
          "DataType": "TimeSpan",
          "DefaultValue": null,
          "LogicalId": "TimeSpan",
          "Description": "TimeSpan",
          "Required": true,
          "IsUnique": false,
          "AutoGenerate": false,
      }
    • Boolean:

       {
           "DataType": "Boolean",
           "DefaultValue": null,
           "LogicalId": "IsActive",
           "Description": "Is Active",
           "Required": true,
           "IsUnique": false,
           "AutoGenerate": false
       }
    • Guid:

       {
           "DataType": "Guid",
           "DefaultValue": null,
           "LogicalId": "IsActive",
           "Description": "Is Active",
           "Required": true,
           "IsUnique": false,
           "AutoGenerate": false,
           "Format":null, 
       }
    • Enum:

       {
           "DataType": "Enum",
           "EnumTyeLogicalId": "RoleType",
           "DefaultValue": null,
           "LogicalId": "RoleType",
           "Description": "Role Type",
           "Required": true,
           "IsUnique": false,
           "AutoGenerate": false,
       }
    • Object:

      {
          "DataType": "Object",
          "ObjectTyeLogicalId": "Tag",
          "DefaultValue": null,
          "LogicalId": "Tag",
          "Description": "Tag",
          "Required": true,
          "IsUnique": false,
          "AutoGenerate": false,
      }
    • Array:

      {
          "DataType": "Array",
          "ObjectTyeLogicalId": "Tag",
          "LogicalId": "Tags",
          "Description": "Tags",
          "Required": true,
          "IsUnique": false,
          "AutoGenerate": false,
      }
    • PrimitiveArray:

      {
          "DataType": "PrimitiveArray",
          "ObjectTyeLogicalId": null,
          "LogicalId": "TagsNames",
          "Description": "TagsNames",
          "Required": true,
          "IsUnique": false,
          "AutoGenerate": false,
          "ValueType": "String"
      }
  • MaxLength: For string types only, the maximum length allowed.
  • DefaultValue: A default value for the property if not otherwise specified depend on the DataType.
  • RegularExpression: For string types only, A pattern that the property's value must match, if applicable.
  • LogicalId: A unique identifier for the property within the object.
  • Description: A brief description of the property’s role or constraints.
  • Required: Indicates if the property is mandatory.
  • IsUnique: Specifies whether the property value must be unique across all instances of the object.
  • AutoGenerate: Specifies whether the property’s value should be auto-generated by the system.
  • MinValue: For Integer And Float types, indicate the minimum value.
  • MaxValue: For Integer And Float types, indicate the maximum value.
  • Format: For Float, DateTime and Guid types, indicate the format value.
  • DateAndTime: For DateTime types only, indicate the date value is with time or not.
  • EnumTyeLogicalId: For Enums types only, indicate the Enum Type Logical Id that refers.
  • ObjectTyeLogicalId: For Object and Array types, indicate the object Logical Id that refers.
  • ValueType: For ArrayPrimitive types only, indicate the value type of the defined Array it's can be all the above DataType.

Example

This document describes the setup and functionality of the object LocalizedObject configuration used for modeling.

{
    "LogicalId": "LocalizedObject",
    "Description": "for multiple localization field",
    "Properties": [
        {
            "DataType": "String",
            "MaxLength": 150,
            "DefaultValue": null,
            "RegularExpression": null,
            "LogicalId": "Code",
            "Description": "code name and it is unique",
            "Required": true,
            "IsUnique": false,
            "AutoGenerate": false
        },
        {
            "DataType": "Int64",
            "DefaultValue": null,
            "RegularExpression": null,
            "LogicalId": "Id",
            "Description": "Primary Id",
            "Required": true,
            "IsUnique": false,
            "AutoGenerate": true
        }
    ]
}

The JSON structure describes a Model LocalizedObject.

Output

To Code you provided is a C# class named LocalizedObject.

{
    public class LocalizedObject
    {
 
        /// <summary>
        /// Primary Id
        /// </summary>
        [Required]
        [JsonRequired]
        public Int64 Id { get; set; }
 
        /// <summary>
        /// code name and it is unique
        /// </summary>
        [Required]
        [JsonRequired]
        public string Code { get; set; }
    }
}