FoxDataObjects

Object-Relational Mapping Tool for Visual FoxPro®

 API Reference

This section provides a comprehensible reference on classes, objects, methods, properties and events available in the FoxDataObjects Persistence Services API.

Server object
  It is the first object to be instantiated, and serves as a Session objects factory. It is normally used to set up default information for new sessions and to call its NewSession() method for getting connected or disconnected session objects.

 

Session object
  It represents a connection to the database and provides access to all of the persistence and mapping services. It is used to manage database connections, save and retrieve business objects, update database schema definitions, Select , Insert, Update and Delete records in the database, perform object and SQL queries, and so on.

 

Errors collection
 

Stack all errors occurred and messages raised during a persistence method call. Both, Server and Session objects, has an error collection on their respective Error properties. It is normally used to get detailed information on persistence method calls results.

 

DataSource objects
  DataSource objects are used to encapsulate all the information needed to connect to a given data store. It can be viewed as an easy to use wrapper around supported ODBC drivers, that provides meaningful information to the persistence engine, not only on how to connect with the database layer, but also on what to do at the first connection time.

 

Query objects
 

Query objects are used to retrieve a set of persisted instances from the database. They work much like database queries, but instead of retrieving simple table records, they retrieves complete objects that fulfill a query condition.

 

fdoCollection object
 

It is an easy to use collection class specially designed to implement one-to-many and many-to-many relationships  as of collection of simple values on your business classes. Although Visual FoxPro 8 (and up) features a basic Collection class, the fdoCollection class provides an extra number of functions and features that simplifies object relationships management, implement collection-level events, provides a way to easily access modified/added and even removed items,  optimizes memory usage and accelerate referenced instances loading with a powerful collection-level lazy loading mechanism.

 

Persistence events
 

When the Persistence Engine saves, retrieves or removes business objects from the data store, it can "fire" events on your business objects at specific points. Use of "Persistence Events" allows you to package all the business objects and rules in a compact, robust and efficient object model.

 

Functions
 

The FDO.FLL C++ FoxPro Link Library provides a suite of Private and Public functions. Private functions are accessed and used by the Persistence and Mapping Engines. However there are a set of Public functions you can use within your Business Classes code to access extra functionality provided by FoxDataObjects.
Those functions are extensions to the Visual FoxPro language and are mostly related to the Persistence Engine and instance persistence tracking that you can use as native Visual FoxPro functions.

 

 

Send feedback on this topic to RunAhead Technologies

For Technical support and product issues please contact us at support@foxdataobjects.com or visit http://www.foxdataobjects.com

Copyright (c) 2000-2005 RunAhead Technologies