mirror of
https://github.com/nasa/openmct.git
synced 2024-12-23 23:12:23 +00:00
[Persistence] Update developer guide
Replay changes to developer guide regarding identifier syntax and persistence spaces.
This commit is contained in:
parent
1d9b8f34e2
commit
647a1403d0
@ -677,6 +677,28 @@ If the provided capability has no invoke method, the return value here functions
|
||||
as `getCapability` including returning `undefined` if the capability is not
|
||||
exposed.
|
||||
|
||||
### Identifier Syntax
|
||||
|
||||
For most purposes, a domain object identifier can be treated as a purely
|
||||
symbolic string; these are typically generated by Open MCT Web and plug-ins
|
||||
should rarely be concerned with its internal structure.
|
||||
|
||||
A domain object identifier has one or two parts, separated by a colon.
|
||||
|
||||
* If two parts are present, the part before the colon refers to the space
|
||||
in which the domain object resides. This may be a persistence space or
|
||||
a purely symbolic space recognized by a specific model provider.
|
||||
* If only one part is present, the domain object has no space specified,
|
||||
and may presume to reside in the application-configured default space
|
||||
defined by the `PERSISTENCE_SPACE` constant.
|
||||
|
||||
```bnf
|
||||
<identifier> ::= <space> ":" <simple id> | <simple id>
|
||||
<space> ::= <id char>+
|
||||
<simple id> ::= <id char>+
|
||||
<id char> ::= <letter> | <digit> | "-" | "." | "_"
|
||||
```
|
||||
|
||||
## Domain Object Actions
|
||||
|
||||
An `Action` is behavior that can be performed upon/using a `DomainObject`. An
|
||||
@ -2328,6 +2350,11 @@ default paths to reach external services are all correct.
|
||||
|
||||
### Configuration Constants
|
||||
|
||||
The following constants have global significance:
|
||||
* `PERSISTENCE_SPACE`: The space in which domain objects should be persisted
|
||||
(or read from) when not otherwise specified. Typically this will not need
|
||||
to be overridden by other bundles, but persistence adapters may wish to
|
||||
consume this constant in order to provide persistence for that space.
|
||||
|
||||
The following configuration constants are recognized by Open MCT Web bundles:
|
||||
* Common UI elements - `platform/commonUI/general`
|
||||
|
Loading…
Reference in New Issue
Block a user