IService

Last updated
Save as PDF

pentaho .module. IService

The IService interface represents a service that provides ways to load JavaScript modules depending on their type/instance relation to a given module.

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

See also: pentaho.module.IMetaService

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.

Methods Details

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.

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.

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.

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.

Pentaho+ documentation has moved!

The new product documentation portal is here. Check it out now at docs.hitachivantara.com.

Methods