Versions Compared

Key

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

Overview

Documents the .internal service APIs..

This is a placeholder page with basic information and will be developed to fully document this aspect of the system.

...

In general, methods that find data return search result objects with identifiers (with display labels) that can be used to perform subsequent lookups to retrieve the underlying model objects. These methods typically also take a paging/sorting/filtering parameter to allow for controlled access to the desired amount of data.

General Design

  • getXXX methods return objects (and don't take PFS)
  • findXXX methods return Lists (and take PFS - and  need to fully support it - or throw exceptions).

 

Security Service

TODO: more details, including use cases

...