Document Properties
Kbid25P919
Last Modified15-Mar-2016
Added to KB18-Aug-2014
Public AccessEveryone
StatusOnline
Doc TypeGuidelines, Concepts & Cookbooks
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

Guide - EDL Modeling Style Guide

1 Introduction

This guide describes the conventions for working with EDL models.

1.1 Related Documents

2 Conventions

2.1 Model Files

  • Define every complex type (e.g. orm class, capi interface, ...) in its own *.edl file.
  • Store the *.edl files in a separate folder in the cartridge, e.g., in the edl folder.
  • Create a folder structure according to the namespace of the EDL types, like:
    {cartridgename}/edl/com/intershop/beehive/core/capi/domain/ExtensibleObjectPO.edl

2.2 Formatting Conventions

  • Use 4 spaces instead of tabs.
  • Do not use special characters in comments (use plain english).
  • Use a coding style similar to the Java programming conventions, see Guide - Java Source Code Style Guide.

2.3 Naming Conventions

  • Use the suffix PO for ORM classes (stands for persistent object).

2.4 Order of Elements

Arrange the members of a class in the following order, from top to bottom:

  1. Contraints: primary key, alternate key, semantic key, index declarations
  2. Attributes: all attributes
  3. Relations: all relations
  4. Operations: all operations

Note

The order of attributes and relations matters. This is important for the generated code in several places, like the order of mandatory parameters in the create-methods of ORM factories.

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets