Entities

  • An Entity represents a business object that contains some methods and its properties. Entities are similar to objects in Object Oriented Programming, they are the basic fundamental block of Nebula framework
  • Entities are denoted by an entity name
  • Entities are represented by entity methods which are responsible for carrying out CRUD operations on entity method tables
  • Entity table methods are defined by entity fields which are used to represent columns of the data table in database

In this article

Entities

A normal simple page can be done using only one entity. Whereas complex pages which get data from several places, will be using more than one entity. Each of the Entity, will be having one or more Entity Methods.

Field's Description

  • Has Error? This is internal field. If there is any inconsistency/improper in the setting of the entity/entity table/entity field, or if the steps that need to be followed in creating the entity is not followed, then “Has Error” will be highlighted in red color. Clicking it will provide the details of what that error was, with suggestions to fixing the error.

  • Entity Name Name of the Entity. It should be unique for that module (database).

  • Enable ? It’s Used to set whether that Entity is enabled or disabled. When disabled, details of that entity will not be get used.By default this option is true.

  • Is Locked? To avoid unnecessary edits, entity can be locked. Currently this is not yet implemented.

  • Usage This will show the places where the Entity is been currently used.

  • Description A short explanation of what that Entity is created for, what it will do.

  • Comments A little longer explanation of what that Entity object will do.

  • Allow MultiInstance? Multiple working instances of an entity is allowed by default. If only one instance is allowed set this value to false.

  • Is Quick Searchable? When set to true, quick search will be enabled for that Entity. By default this option is true.

  • Simple Searchable ?

  • Allow Complex Search? When set to true, complex search will be enabled for that Entity. By default this option is true.

  • Default Search Option 0=None, 1=QuickSearch, 2=SimpleSearch, 3=ComplexSearch

  • Row Identifier Internal field.

  • Created User User who created that Entity object.

  • Created Date Date in which Entity object was created.

  • Updated User User who updated that Entity object lastly.

  • Updated Date Date in which Entity object was last modified.

Entity Initializer

NF Tool helps the user to automatically create entities with the Entity Initializer feature. The tool will take care of creating entities along with the entity methods for the various CRUD operations. Entities will be created based on the target database table specified by the user.

Field's Description

  • Db Table Name A dropdown list of SQL tables and Views that are in that database will be shown. Need to pick an item in which the Entity need to be created on.

  • Table Name Need to provide the Entity Table name. If not provided, initializer will use the name from the selected Db Table Name.

  • Entity Name Need to provide the name of the Entity. If not provided, initializer will use the name from the selected Db Table Name.

  • Read Method Name Need to provide the name of the read method for that Entity. If not provided, initializer will use the name from the selected Db Table Name.

  • Cud Method Name Need to provide the name of Create/Update/Delete method for that Entity. If not provided, initializer will use the name from the selected Db Table Name.

  • Prefix Any term like Application/Module name that need to prefixed with the Entity/Method/Table names can be provided.