Files
openmct/platform/policy/src/PolicyViewDecorator.js
Victor Woeltjen c08a460d30 [JSDoc] Add annotations
Bulk-add JSDoc annotations, WTD-1482.
2015-08-07 11:44:54 -07:00

62 lines
2.5 KiB
JavaScript

/*****************************************************************************
* Open MCT Web, Copyright (c) 2014-2015, United States Government
* as represented by the Administrator of the National Aeronautics and Space
* Administration. All rights reserved.
*
* Open MCT Web is licensed under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0.
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
* Open MCT Web includes source code licensed under additional open source
* licenses. See the Open Source Licenses file (LICENSES.md) included with
* this source code distribution or the Licensing information page available
* at runtime from the About dialog for additional information.
*****************************************************************************/
/*global define*/
define(
[],
function () {
"use strict";
/**
* Filters out views based on policy.
* @param {PolicyService} policyService the service which provides
* policy decisions
* @param {ViewService} viewService the service to decorate
* @constructor
* @memberof platform/policy
*/
function PolicyActionDecorator(policyService, viewService) {
return {
/**
* Get views which are applicable to this domain object.
* These will be filtered to remove any views which
* are deemed inapplicable by policy.
* @param {DomainObject} the domain object to view
* @returns {View[]} applicable views
* @memberof platform/policy.PolicyViewDecorator#
*/
getViews: function (domainObject) {
// Check if an action is allowed by policy.
function allow(view) {
return policyService.allow('view', view, domainObject);
}
// Look up actions, filter out the disallowed ones.
return viewService.getViews(domainObject).filter(allow);
}
};
}
return PolicyActionDecorator;
}
);