IMetaService

Last updated
Save as PDF

pentaho .module. IMetaService

The IMetaService interface represents a service that provides metadata information about JavaScript modules.

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

Methods

Name	Description
configure(moduleSpecMap) : `pentaho.module.IMetaService`	Configures the modules metadata service by defining new modules or configuring existing modules.
get(idOrAlias, keyArgs) : `pentaho.module.IMeta`	Gets the metadata of the module having a given identifier or alias.
getId(idOrAlias) : `string`	Gets the identifier of a module given its identifier or alias.
getInstanceOf(typeIdOrAlias) : `pentaho.module.IInstanceMeta`	Gets the metadata of the highest `ranking` module which is a known instance of a given type module.
getInstancesOf(typeIdOrAlias) : `Array.<!pentaho.module.IInstanceMeta>`	Gets the metadata of the modules which are known instances of a given type module.
getSubtypeOf(baseTypeIdOrAlias) : `pentaho.module.ITypeMeta`	Gets the metadata of the highest `ranking` module which is a known descendant type of a given type module.
getSubtypesOf(baseTypeIdOrAlias) : `Array.<!pentaho.module.ITypeMeta>`	Gets the metadata of the modules which are known descendant types of a given type module.

Methods Details

configure(moduleSpecMap) : pentaho.module.IMetaService

Configures the modules metadata service by defining new modules or configuring existing modules.

Source: doc-js/pentaho/module/IMetaService.jsdoc, line 26

Parameters:
Name	Default Value	Summary
moduleSpecMap : `pentaho.module.spec.MetaMap`		A map of modules metadata.

Returns:
Name	Description
`pentaho.module.IMetaService`	The value of `this`.

get(idOrAlias, keyArgs) : pentaho.module.IMeta

Gets the metadata of the module having a given identifier or alias.

Source: doc-js/pentaho/module/IMetaService.jsdoc, line 39

Name Default Value Summary

idOrAlias : string

The identifier or alias of the module.

keyArgs : Object

Optional

The keyword arguments.

Parameters:
Name	Default Value	Summary
createIfUndefined : `boolean` Optional	false	Indicates if an instance module of `null` type should be created and returned when the module has not been explicitly defined. In this case, note, `idOrAlias` should really contain the identifier of the module.
assertDefined : `boolean` Optional	false	Indicates that an error should be thrown if the a module with the specified identifier or alias is not defined.

Returns:
Name	Description
`pentaho.module.IMeta`	A module metadata, if the module is defined; `null`, otherwise.

Throws:
Name	Description
`pentaho.lang.ArgumentInvalidError`	When `keyArgs.assertDefined` is `true` and a module with the specified identifier or alias is not defined.

getId(idOrAlias) : string

Gets the identifier of a module given its identifier or alias.

If a module with the given identifier or alias is not defined, null is returned.

Source: doc-js/pentaho/module/IMetaService.jsdoc, line 62

Parameters:
Name	Default Value	Summary
idOrAlias : `string`		The identifier or alias of the module.

Returns:
Name	Description
`string` \| `null`	The identifier of a defined module; `null`, otherwise.

getInstanceOf(typeIdOrAlias) : pentaho.module.IInstanceMeta

Gets the metadata of the highest ranking module which is a known instance of a given type module.

Source: doc-js/pentaho/module/IMetaService.jsdoc, line 89

Parameters:
Name	Default Value	Summary
typeIdOrAlias : `string`		The identifier or alias of the type module.

Returns:
Name	Description
`pentaho.module.IInstanceMeta`	The metadata of an instance module, if any, or `null`, if none.

getInstancesOf(typeIdOrAlias) : Array.<!pentaho.module.IInstanceMeta>

Gets the metadata of the modules which are known instances of a given type module.

The modules are returned ordered descendingly by their ranking.

Source: doc-js/pentaho/module/IMetaService.jsdoc, line 76

Parameters:
Name	Default Value	Summary
typeIdOrAlias : `string`		The identifier or alias of the type module.

Returns:
Name	Description
`Array.<!pentaho.module.IInstanceMeta>`	An array of metadata of instance modules, possibly empty.

getSubtypeOf(baseTypeIdOrAlias) : pentaho.module.ITypeMeta

Gets the metadata of the highest ranking 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/IMetaService.jsdoc, line 118

Parameters:
Name	Default Value	Summary
baseTypeIdOrAlias : `string`		The identifier or alias of the base type module.

Returns:
Name	Description
`pentaho.module.ITypeMeta`	The metadata of a type module, if any, or `null`, if none.

getSubtypesOf(baseTypeIdOrAlias) : Array.<!pentaho.module.ITypeMeta>

Gets the metadata 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.

Source: doc-js/pentaho/module/IMetaService.jsdoc, line 103

Parameters:
Name	Default Value	Summary
baseTypeIdOrAlias : `string`		The identifier or alias of the base type module.

Returns:
Name	Description
`Array.<!pentaho.module.ITypeMeta>`	An array of metadata of type modules, possibly empty.