| Auszug |
|---|
|
Nuclos API conventions: naming, insert, update, delete, Id, UID, exception, dispatch thread, code style. |
Language: Deutsch · English
Conventions for Nuclos API development
Conventions for the Nuclos API – naming of methods/ids and rules for error handling.
| Status |
|---|
| colour | Green |
|---|
| title | Stand: Jul 2026 |
|---|
|
| Status |
|---|
| colour | Grey |
|---|
| title | gilt fuer Nuclos 4.2026.x |
|---|
|
Binding conventions for developing with the Nuclos API – for consistent, maintainable code.
Naming
| Rule | Example |
|---|
Collections: suffix ...All() | insert(BusinessObject) vs. insertAll(Collection<BusinessObject>) |
Delete: delete | not remove, drop … |
Insert: insert | not new, create … |
Update: update | not modify … |
Ids: Id instead of ID | getId(), returning methods end in ...Id() |
| Id data type | always Long or UID |
Error handling
- Never swallow exceptions silently – write at least a warning to the log.
- Do not throw a
RuntimeException (e.g. CommonFatalException) on the dispatch thread – it crashes/freezes the GUI. - Avoid catching generic
Exception/RuntimeException; if necessary, keep it minimal. - Avoid long method chains – they are hard to debug and produce unhelpful stack traces.
Related pages
