Skip to main content
Hitachi Vantara Lumada and Pentaho Documentation

Service

.module. Service

The Service class is the implementation of the IService interface.

Implements

Constructor

Name Description
new Service(metaService)

Constructs a module service instance.

Methods

Name Description
getInstanceOfAsync(typeIdOrAlias) : Promise

Gets a promise for the value of the highest ranking, successfully loaded module which is a known instance of a given type module.

getInstancesOfAsync(typeIdOrAlias) : Promise.<!Array>

Gets a promise for the values of the modules which are known instances of a given type module.

getSubtypeOfAsync(baseTypeIdOrAlias) : Promise

Gets the value of the highest ranking, successfully loaded module which is a known descendant type of a given type module.

getSubtypesOfAsync(baseTypeIdOrAlias) : Promise.<!Array>

Gets a promise for the values of the modules which are known descendant types of a given type module.

Constructor Details

new Service(metaService)

Constructs a module service instance.

Source: javascript/web/pentaho/_core/module/Service.js, line 31

Parameters:
Name Default Value Summary
metaService : pentaho.module.IMetaService

The modules' metadata service.

Methods Details

Implements:
getInstanceOfAsync(typeIdOrAlias) : Promise

Gets a promise for the value of the highest ranking, successfully loaded module which is a known instance of a given type module.

Source: doc-js/pentaho/module/IService.jsdoc, line 44

Parameters:
Name Default Value Summary
typeIdOrAlias : string

The identifier or alias of the type module.

Returns:
Name Description
Promise

A promise for the value of a module, if any, or undefined, if none.

See also: pentaho.module.IMetaService#getInstanceOf

Implements:
getInstancesOfAsync(typeIdOrAlias) : Promise.<!Array>

Gets a promise for the values of the modules which are known instances of a given type module.

The modules' values are returned ordered descendingly by their ranking.

Modules which fail loading do not cause the operation to fail and are excluded from the result.

Source: doc-js/pentaho/module/IService.jsdoc, line 27

Parameters:
Name Default Value Summary
typeIdOrAlias : string

The identifier or alias of the type module.

Returns:
Name Description
Promise.<!Array>

A promise to an array of module values, possibly empty.

See also: pentaho.module.IMetaService#getInstancesOf

Implements:
getSubtypeOfAsync(baseTypeIdOrAlias) : Promise

Gets the value of the highest ranking, successfully loaded module which is a known descendant type of a given type module.

The specified base type module is not a possible result.

Source: doc-js/pentaho/module/IService.jsdoc, line 79

Parameters:
Name Default Value Summary
baseTypeIdOrAlias : string

The identifier or alias of the base type module.

Returns:
Name Description
Promise

A promise for the value of a module, if any, or undefined, if none.

See also: pentaho.module.IMetaService#getSubtypeOf

Implements:
getSubtypesOfAsync(baseTypeIdOrAlias) : Promise.<!Array>

Gets a promise for the values of the modules which are known descendant types of a given type module.

The modules are returned ordered descendingly by their ranking.

The specified base type module is not included in the result.

Modules which fail loading do not cause the operation to fail and are excluded from the result.

Source: doc-js/pentaho/module/IService.jsdoc, line 60

Parameters:
Name Default Value Summary
baseTypeIdOrAlias : string

The identifier or alias of the base type module.

Returns:
Name Description
Promise.<!Array>

A promise to an array of module values, possibly empty.

See also: pentaho.module.IMetaService#getSubtypesOf