Skip to main content
Pentaho Documentation

IService

pentaho.instanceInfo.IService

The instanceInfo.IService interface represents a service from which basic metadata information can be obtained about instances without loading the their AMD modules.

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

See also:  pentaho.instanceInfo.service

Methods

Name Description
configure(configSpec)

Declares multiple instances.

declare(id, decl)

Declares an instance.

getAllByType(typeIdOrAlias) : Array.<string>

Gets an array of the identifiers of known instances of a given type.

getTypeOf(instanceId) : string | undefined | null

Gets the type identifier of an instance given its identifier.

Methods Details

configure(configSpec)

Declares multiple instances.

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

Parameters:
Name Default Value Summary
configSpec : pentaho.instanceInfo.spec.Declarations
 
Optional

A map of instance declarations whose keys are the corresponding instance identifiers.

declare(id, decl)

Declares an instance.

Source: doc-js/pentaho/instanceInfo/IService.jsdoc, line 37

Parameters:
Name Default Value Summary
id : string
 
Optional

The id of the instance.

decl : pentaho.instanceInfo.spec.IDeclaration
 
Optional

The declaration of the instance.

Throws:
Name Description
pentaho.lang.ArgumentInvalidError

When an instance with the given id is already defined.

getAllByType(typeIdOrAlias) : Array.<string>

Gets an array of the identifiers of known instances of a given type.

Source: doc-js/pentaho/instanceInfo/IService.jsdoc, line 61

Parameters:
Name Default Value Summary
typeIdOrAlias : string

The identifier or alias of the type.

keyArgs.includeDescendants : boolean
 
Optional
false

Indicates that instances of all descendant types should be part of the result.

Returns:
Name Description
Array.<string>

The ids of known instances.

getTypeOf(instanceId) : string | undefined | null

Gets the type identifier of an instance given its identifier.

Source: doc-js/pentaho/instanceInfo/IService.jsdoc, line 49

Parameters:
Name Default Value Summary
instanceId : string

The identifier of the instance

Returns:
Name Description
string | undefined | null

The identifier of the instance's type or, undefined if the instance is not known.