Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


PackageScopeNotes
1apiall classes that are required for northbound interfacesclasses that are directly used by the REST interface (or controllers)
2api\featureall API classes that are specific to a given feature
3api\feature\modelsall data-holder type classes for the API specific to the featuredo NOT add data objects that are only used in the impl!
4api\feature\exceptionsall exception classes that are specific to a given featuredo think 'ahead': is the exception rally going to be unique for this feature! 
If in doubt it probably should go into api\exception. Because moving it later would be a backward incompatible change!
5api\modelsall data-holder type classes for the API that can be shared between features
6api\feature\exceptionsall exception classes that can be shared between features and at least oen feature exposes on the API
7implall classes that are NOT exposed on the northbound interface and are unique to just one featuresince these classes are NOT exposed on the API it is OK to move them to the common utils\ package only when needed (i.e. later) since this would not be backward incompatible
8impl\featureall implementation classes that are specific to a given featurea feature could be NOT direct used by a API feature but maybe api features can depend on a common implementation feature such as 'trustlevel' or 'sync/data' and 'sync/module'
9exceptionsall exception classes that are can be shared between given features and are NOT exposed on any API
10utilsall  implementation classes that can be shared between features but don't belong to a specific featureeven if classes are used by several API feature that doesn't mean thry have to go here. They can stull be part of a common (impl. only) feature e.g. TrustLevel
11modelsall data-holder type classes used in impl only that can be shared between features

...