Skip to content

Methods - cDataDictionary

Include: Use Db\cDataDictionary.pkg

Methods exposed by cDataDictionary, including metadata lookup, buffer management, find, save, delete, validation, relation, constraint, DEO, adapter, and operation helpers.

Type: Methods

Summary

Symbol Purpose
FieldAttribute Reads field metadata attributes.
FieldDefinition Returns field definition data.
FieldName Returns a field's display/source name.
FieldType Returns a field's data type.
TableAttribute Reads table metadata attributes.
TableDbName Returns the database table name.
TableLogicalName Returns the logical table name.
TableFieldCount Returns the field count.
TableDefinition Returns table definition data.
TablePrimaryKeyFields Returns primary-key fields.
IsPrimaryKeyField Reports whether a field is in the primary key.
IsFieldIndexed Reports whether a field participates in an index.
BufferChanged Reports whether any local field is changed.
HasRecord Reports whether the DD currently has a found or saved record.
GetRowID Returns the current row id.
PushBuffer Saves the DDO structure buffer state.
PopBuffer Restores the DDO structure buffer state.
UpdateAllFields Copies current buffer values through field update logic.
ParentsChanged Reports parent-switch state.
Parent_Changed_State Reads or sets parent changed state.
Clear Clears the DD's local buffer.
ClearForTable Clears buffer state for a table/entity path.
Clear_Main_File Compatibility clear entry point.
Clear_All Clears the DDO structure.
Find Finds using current ordering.
FindByField Finds through a field's preferred index.
FindByIndex Finds through an explicit index.
FindByRowId Finds by row id or clears for a null row id.
FindByRowIdEx Finds by row id and returns success.
FindByRowIdExNoAutoFill Finds by row id without auto-fill.
Field_Index Returns a field's preferred index.
File_Field_Index Compatibility field-index lookup.
Request_Save Validates and saves through the DD.
SaveRecord Creates or updates the current record.
CreateRecord Creates a new database record.
UpdateRecord Updates the current database record.
Should_Save Reports whether DD or parent changes need saving.
Should_Save_Row Reports whether one row should save.
UpdateForeignKeys Copies active parent keys into child foreign keys.
Request_Delete Deletes the current record through the DD.
DeleteRecord Lower-level delete path.
ZeroFile Clears records from the selected storage.
Can_Delete Reports whether delete is allowed.
CreateDatabase Creates selected database storage.
ExistsInDb Checks whether selected storage exists.
ForeignFieldCategory Resolves a field's foreign-field category.
Request_Validate Validates the DD and required parent path.
Request_Validate_All Collects validation across the DDO structure.
Validate_Field Validates one field.
FieldError Raises a validation error for a field.
OnValidate_Add Adds a DD-level validation handler.
OnValidate_Del Removes a DD-level validation handler.
OnValidate_Has Reports whether a DD-level validation handler is registered.
OnFieldValidate_Add Adds a field validation handler.
OnFieldValidate_Del Removes a field validation handler.
OnFieldValidate_Has Reports whether a field validation handler is registered.
OnForeignFieldValidate_Add Adds a foreign-field validation handler.
OnForeignFieldValidate_Del Removes a foreign-field validation handler.
OnForeignFieldValidate_Has Reports whether a foreign-field validation handler is registered.
DDO_Server Registers a parent Data Dictionary.
DefineRelation Defines relation metadata for DD behavior.
Parents Returns direct parent DDs.
ParentsAll Returns all parent DDs.
ParentsAllDepthFirst Returns all parent DDs depth-first.
ParentsAllButConstrained Returns parent DDs except the constrained parent.
Children Returns direct child DDs.
ChildrenAllDepthFirst Returns all child DDs depth-first.
AllDDOsChildrenBreathFirst Returns child DDOs breadth-first.
AllDDOsBottomUp Returns DDOs bottom-up.
Data_Set Finds a DD for an entity in the DDO structure.
Which_Data_Set Resolves applicable server paths.
Data_Set_Server_Count Returns server count.
Data_Set_Server Returns a server by index.
Add_Value_Constraint Adds a value constraint.
Add_Field_Value_Constraint Adds a field-value constraint.
Add_Relates_To_Constraint Adds a relation constraint.
RebuildConstraints Rebuilds constraints for one DD.
RebuildAllConstraints Rebuilds constraints for a DDO structure.
CascadeDeleteAllowed Reports whether relation cascade delete is allowed.
CascadeDeleteNull Reports whether cascade delete can null the relation.
ParentNullAllowed Reports whether a null parent is allowed.
ParentNoSwitchIfCommitted Reports committed child parent-switch behavior.
AllowParentFind Reports whether a parent DD can switch records.
Add_User_Interface Attaches a DEO to DD refresh notifications.
Remove_User_Interface Detaches a DEO from DD refresh notifications.
OperationName Returns a display name for an operation mode.

See also