home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-2.iso / Developer / webobjects / resources / CRUDLayer.1.2.README < prev    next >
Encoding:
Text File  |  1996-08-19  |  3.5 KB  |  91 lines
  1.  
  2.  
  3. CRUD Objects Layer (COL) 
  4. ========================
  5.  
  6. Introduction
  7. ------------
  8. The COL's goal is to reduce development time and maintenance requirements for WOF apps based on Enterprise Objects Framework.
  9.  
  10. EOF and WOF are general frameworks for information handling:
  11.  
  12.     EOF for relational to object handling
  13.     WOF for object to HTML
  14.  
  15.     
  16. EOF is split into three layers:
  17.  
  18.     Access (RDB <-> Object)
  19.     Control (Object management) [available in EOF 2.0]
  20.     Interface (Object <-> Interface). [For web apps, this is ~WOF]
  21.  
  22.     
  23. The CRUD Layer simply extends each of these layers to provide the general code one typically writes when dealing Enterprise Objects (EOGenericRecord, and subclasses).  COL's intendment is to allow users to perform the basic database operations on Enterprise Objects:  Create, Read, Update, and Delete.
  24.  
  25. With a few underlying assumptions about application requirements and complexity, the CRUD Objects Layer can replace a large amount of infrastructure necessary to maintain information based on Enterprise Objects.
  26.  
  27. Again, the code to support this behavior can be generalized to a large degree.  The CRUD Layer is that generalization.
  28.  
  29. Additionally, for EO's with "state", the COL includes Entity Life Cycle (ELC) support.  [Most reference data (Building, Location, CustomerType, etc.) is stateless, however, many core entities (PurchaseRequisition, BugReport, WorkOrder, etc.) have the need for state management and ELC support.]
  30.  
  31. These abilities, and offering a means of building qualifiers (e.g. Query By Example), can provide a large amount of core application logic that no longer needs to be developed or maintained.
  32.  
  33. A typical drawback to this approach is lack of extensibility.  COL addresses this issue by providing numerous opportunities in which to extend the CRUD Object Layer in a structured manner.
  34.  
  35. [Currently, the CRUD Layer is specific to Web Objects Framework, but with the convergence of WebObjects and OpenStep in Q3 of '96, the CRUD Layer will be extended to support OpenStep (traditional Client/Server) apps with ease.]
  36.  
  37.  
  38. Basic CRUD Objects Layer Flow
  39. -----------------------------
  40. In it's most basic form, COL works as follows:
  41.  
  42.     [MainMenu.wo]
  43.     - An Entity is selected (e.g. Customer)
  44.       and passed to the QualifierBuilderPage.
  45.  
  46.     [CRUDQualifierBuilderPage.wo]
  47.     - A Qualifier is built for the Entity (Customer)
  48.       and passed to the PickList.
  49.  
  50.     [CRUDPickListPage.wo]
  51.     - Customer(s) matching the Qualifer are shown.
  52.       Customers are selected and passed to the Editor.
  53.  
  54.     [CRUDEditorPage.wo]
  55.     - Detailed editing and updating are performed.
  56.  
  57.  
  58.  
  59. Behind the Scene
  60. ----------------
  61. Much of the power of CRUD Objects Layer is contained in the reusable pages
  62. that can be tailored to specific needs.  The page level API is as follows:
  63.  
  64.     CRUDQualifierBuilderPage.wo
  65.     -initWithEntity:(EOEntity*)anEntity
  66.  
  67.     CRUDPickListPage.wo
  68.     -initWithQualifier:(EOQualifier*)q andFetchOrder:(NSArray*)fetchOrder
  69.     
  70.     CRUDEditorPage.wo
  71.     -initWithEntity:(EOEntity*)anEntity
  72.     -initWithObject:(id)anEO editable:(BOOL)editable
  73.  
  74.  
  75. Inspection of the API above indicates an expicit mechanism for data handling of any/all Enterpise Objects.  In addition, this movement is not constricting, as any Enterpise Object may easily override this behavior.
  76.  
  77.  
  78.  
  79. How to Use the CRUD Objects Layer
  80. ---------------------------------
  81. To make use of the CRUD Layer in its most basic form, simply do the following:
  82.     
  83.     - Create a .eomodel
  84.  
  85.     - Access the URL:  http://<host>/cgi-bin/WebObjects/CRUDLayer
  86.       ...and type in the name of your .eomodel file (e.g. "MyModel")
  87.       
  88.     (Yes, it's that tough :-)
  89.     
  90.       
  91.