Introduction

This guide describes the conventions for working with EDL models.

Related Documents

• Concept - EDL Modeling
• Cookbook - EDL Modeling
• Guide - Java Source Code Style Guide

Conventions

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

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.

Naming Conventions

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

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