Chapter 31. Core developer reference
Prev
Part IV. Developer documentation
Next
Chapter 31. Core developer reference
Table of Contents
31.1. Publishing a new release
31.2. Subversion / building BASE
31.3. Coding rules and guidelines
31.3.1. Development process and other important procedures
31.3.2. General coding style guidelines
31.3.3. API changes and backwards compatibility
Does the changes affect the Public API?
Contract compatibility
Binary compatibility
Internal data structure compatibility
Source code compatibility
31.3.4. Data-layer rules
Attributes and methods order
Class and interface names
Extend/implement the basic classes and interfaces
Define a public no-argument constructor
Object identity
No final methods
Second-level cache
Proxies
Hibernate mappings
Documentation
31.3.5. Item-class rules
31.3.6. Batch-class rules
31.3.7. Test-class rules
31.4. Internals of the Core API
31.4.1. Authentication and sessions
31.4.2. Access permissions
31.4.3. Data validation
31.4.4. Transaction handling
31.4.5. Create/read/write/delete operations
31.4.6. Batch operations
31.4.7. Quota
31.4.8. Plugin execution / job queue