ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-01-18 10:46:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[Core] Add JSDoc to PersistenceCapability

Browse Source 
Add JSDoc to PersistenceCapability, to continue
satisfying code standards in preparation for
integration of the platform/core bundle.
WTD-573.
This commit is contained in:
Victor Woeltjen 2014-11-20 14:05:13 -08:00
parent b9651b45d0
commit 299f78f73f
1 changed files with 35 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
platform/core/src/capabilities/PersistenceCapability.js
View File

@ -1,20 +1,35 @@
/*global define*/
/**
* Defines the "persistence" capability, used to indicate
* that changes to an object should be written to some
* underlying store.
*
* Current implementation is a stub that simply triggers
* a refresh on modified views, which is a necessary
* side effect of persisting the object.
*/
define(
function () {
'use strict';
/**
* Defines the `persistence` capability, used to trigger the
* writing of changes to a domain object to an underlying
* persistence store.
*
* @param {PersistenceService} persistenceService the underlying
* provider of persistence capabilities.
* @param {string} SPACE the name of the persistence space to
* use (this is an arbitrary string, useful in principle
* for distinguishing different persistence stores from
* one another.)
* @param {DomainObject} the domain object which shall expose
* this capability
*
* @constructor
*/
function PersistenceCapability(persistenceService, SPACE, domainObject) {
var self = {
return {
/**
* Persist any changes which have been made to this
* domain object's model.
* @returns {Promise} a promise which will be resolved
* if persistence is successful, and rejected
* if not.
*/
persist: function () {
return persistenceService.updateObject(
SPACE,
@ -22,15 +37,20 @@ define(
domainObject.getModel()
);
},
/**
* Get the space in which this domain object is persisted;
* this is useful when, for example, decided which space a
* newly-created domain object should be persisted to (by
* default, this should be the space of its containing
* object.)
*
* @returns {string} the name of the space which should
* be used to persist this object
*/
getSpace: function () {
return SPACE;
},
invoke: function () {
return self;
}
};
return self;
}
return PersistenceCapability;