Wtx ~ Wt Extension Library
WtxLib
Public Member Functions | Public Attributes | List of all members
Wtx::Dbo::BaseTableDef Class Reference
+ Inheritance diagram for Wtx::Dbo::BaseTableDef:

Public Member Functions

 BaseTableDef (const char *tn)
 
- Public Member Functions inherited from Wtx::Dbo::TableDef
 TableDef (const char *tn)
 ctor More...
 
const char * tableName () const
 
void push_back (FieldDefBase &fd)
 
FieldDefBasefieldDef (const std::string &fieldName) const
 
const std::vector< FieldDefBase * > & fieldDefs () const
 
std::string toJson () const
 

Public Attributes

Wtx::Dbo::FieldDefLineEdit XidFieldDef
 External-ID. More...
 
Wtx::Dbo::FieldDefIntSpin VersionSyncFieldDef
 Version-Sync. More...
 
Wtx::Dbo::FieldDefCheckBox IsActiveFieldDef
 Item is Active. More...
 
Wtx::Dbo::FieldDefCheckBox IsVisibleFieldDef
 Item is Active. More...
 
Wtx::Dbo::FieldDefCheckBox IsDeletedFieldDef
 Item is Deleted. More...
 
Wtx::Dbo::FieldDefLineEdit KeyFieldDef
 Item KEY field. More...
 
Wtx::Dbo::FieldDefLineEdit CfyFieldDef
 Item Clarify Field. More...
 
Wtx::Dbo::FieldDefTextArea VarFieldDef
 Variable Field Value. More...
 
Wtx::Dbo::FieldDefLineEdit TagFieldDef
 TAG field. More...
 

Detailed Description

Definition at line 59 of file BaseTableDef.h.

Member Data Documentation

Wtx::Dbo::FieldDefLineEdit Wtx::Dbo::BaseTableDef::CfyFieldDef

Item Clarify Field.

This is a general-purpose "clarify" field. In many cases, such as within Companies and Persons, there are duplicate names allowed. This can make a big mess, so this 'clarify' field can be used to distinguish one Person/Company from another.

Definition at line 140 of file BaseTableDef.h.

Wtx::Dbo::FieldDefCheckBox Wtx::Dbo::BaseTableDef::IsActiveFieldDef

Item is Active.

This is simply a general-purpose flag that indicates if an item is active or not.

Definition at line 101 of file BaseTableDef.h.

Wtx::Dbo::FieldDefCheckBox Wtx::Dbo::BaseTableDef::IsDeletedFieldDef

Item is Deleted.

This is a flag that indicates an item has been 'flagged-for-deletion'.

Definition at line 119 of file BaseTableDef.h.

Wtx::Dbo::FieldDefCheckBox Wtx::Dbo::BaseTableDef::IsVisibleFieldDef

Item is Active.

This is simply a general-purpose flag that indicates if an item is active or not.

Definition at line 110 of file BaseTableDef.h.

Wtx::Dbo::FieldDefLineEdit Wtx::Dbo::BaseTableDef::KeyFieldDef

Item KEY field.

This is a generic 'key' field, used on most everything. Usually items (like Person and Company) all have a key-field value that is used in table-views and whatnot.

Definition at line 129 of file BaseTableDef.h.

Wtx::Dbo::FieldDefLineEdit Wtx::Dbo::BaseTableDef::TagFieldDef

TAG field.

This is a general-purpose tag-field that can be used to 'tag' items with things that can searched for later. For instance, a user might be cleaning up a contacts database, and wants to tag varound items so that they can be dealt with later.

Definition at line 162 of file BaseTableDef.h.

Wtx::Dbo::FieldDefTextArea Wtx::Dbo::BaseTableDef::VarFieldDef

Variable Field Value.

This field is used like a 'memo' field to store a variety of things. It can store any text value, but the system uses it to store JSON string-values. This allows variable values to be stored freely without having to change the schema of the database.

Definition at line 151 of file BaseTableDef.h.

Wtx::Dbo::FieldDefIntSpin Wtx::Dbo::BaseTableDef::VersionSyncFieldDef

Version-Sync.

This field can be used during db-to-db sync processes where-by it is important to record the version of the item that it was at when the sync was performed. If the item is updated, then the internal item's version() value will be different than this version-sync value, and it will be possible to detect changes in the system that need to get re-synced.

Definition at line 92 of file BaseTableDef.h.

Wtx::Dbo::FieldDefLineEdit Wtx::Dbo::BaseTableDef::XidFieldDef

External-ID.

This field is used when synchronizing the database with an external foreign database. These databases usually use integer-based ID numbers, so this field acts as a 'external-id' value. Duing import/sync processes, this value can be set with that external reference ID so that future sync processes can insure they are grabbing the correct item.

Definition at line 78 of file BaseTableDef.h.


The documentation for this class was generated from the following files: