Skip to main content
Hitachi Vantara Lumada and Pentaho Documentation

Service

Service

The Service class is an in-memory implementation of the pentaho.config.IService interface.

Extends

Implements

Constructor

Name Description
new Service(environment)
Static

Creates a configuration service instance for a given environment.

Members

Name Description
__environment : pentaho.environment.IEnvironment

The environment used to select configuration rules.

base : function
Protected

If a method has been overridden, then the base method provides access to the overridden method.

selectAsync

Selects, asynchronously, the configuration of a module given its identifier.

Methods

Name Description
add(ruleSet)

Adds a configuration rule set.

addRule(rule, contextId)

Adds a configuration rule.

extend(source, keyArgs) : Object

Extend an object with the properties of another.

Constructor Details

new Service(environment)
Static

Creates a configuration service instance for a given environment.

Source: javascript/web/pentaho/_core/config/Service.js, line 79

Parameters:
Name Default Value Summary
environment : pentaho.environment.IEnvironment

The environment used to select configuration rules.

Members Details

__environment: pentaho.environment.IEnvironment

The environment used to select configuration rules.

Source: javascript/web/pentaho/_core/config/Service.js, line 86

base: function
Protected

If a method has been overridden, then the base method provides access to the overridden method.

Can also be called from within a constructor function.

Source: javascript/web/pentaho/lang/Base.js, line 299

Inherited From: pentaho.lang.Base#base

Implements:
selectAsync:

Selects, asynchronously, the configuration of a module given its identifier.

Source: doc-js/pentaho/config/IService.jsdoc, line 96

Methods Details

add(ruleSet)

Adds a configuration rule set.

Source: javascript/web/pentaho/_core/config/Service.js, line 103

Parameters:
Name Default Value Summary
ruleSet : pentaho.config.spec.IRuleSet

A configuration rule set to add.

addRule(rule, contextId)

Adds a configuration rule.

The insertion order is used as the fallback rule order. For more information on the specificity of rules, see config.spec.IRuleSet.

Note that the specified rule object may be slightly modified to serve the service's internal needs.

Source: javascript/web/pentaho/_core/config/Service.js, line 132

Parameters:
Name Default Value Summary
rule : pentaho.config.spec.IRule

The configuration rule to add.

contextId : string
Optional

The module identifier to which rule modules and deps are relative to. Also, this module determines any applicable AMD/RequireJS mappings.

extend(source, keyArgs) : Object

Extend an object with the properties of another.

Methods that are overridden are accessible through this.base.

This object is extended, but its class doesn't change.

Source: javascript/web/pentaho/lang/Base.js, line 1037

Inherited From: pentaho.lang.Base#extend

Parameters:
Name Default Value Summary
source : Object

The instance specification.

keyArgs : Object
Optional

The keyword arguments.

Parameters:
Name Default Value Summary
exclude : Object
Optional

A map of property names to exclude from source.

Returns:
Name Description
Object

This object.