Skip to main content
Pentaho Documentation

IService

pentaho.typeInfo.IService

The typeInfo.IService interface represents a service from which basic type information can be obtained without loading the types' class' AMD modules.

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

See also:  pentaho.typeInfo.service

Methods

Name Description
configure(configSpec)

Declares multiple types, possibly interrelated.

declare(id, decl)

Declares a type.

getAliasOf(idOrAlias) : string | undefined | null

Gets the alias of a type given its id (or alias).

getBaseOf(idOrAlias) : string | undefined | null

Gets the base id of a type given its id or alias.

getIdOf(aliasOrId) : string | undefined

Gets the id of a type given its alias (or id).

getSubtypesOf(idOrAliasBase) : Array.<string> | undefined

Gets an array of the identifiers of known subtypes of a given base type, optionally including itself.

isSubtypeOf(idOrAliasSub, idOrAliasBase) : boolean | undefined

Determines if one type is a subtype of another.

Methods Details

configure(configSpec)

Declares multiple types, possibly interrelated.

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

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

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

declare(id, decl)

Declares a type.

Source: doc-js/pentaho/typeInfo/IService.jsdoc, line 39

Parameters:
Name Default Value Summary
id : string
 
Optional

The id of the type.

decl : pentaho.typeInfo.spec.IDeclaration
 
Optional

The declaration of the type.

Throws:
Name Description
pentaho.lang.ArgumentInvalidError

When a type with the given id is already defined.

getAliasOf(idOrAlias) : string | undefined | null

Gets the alias of a type given its id (or alias).

Source: doc-js/pentaho/typeInfo/IService.jsdoc, line 51

Parameters:
Name Default Value Summary
idOrAlias : string
 
Optional

The id or alias of the type.

Returns:
Name Description
string | undefined | null

The alias of the type or, undefined if the type is not known, or null if the type is known but does not have an alias.

getBaseOf(idOrAlias) : string | undefined | null

Gets the base id of a type given its id or alias.

Source: doc-js/pentaho/typeInfo/IService.jsdoc, line 75

Parameters:
Name Default Value Summary
idOrAlias : string
 
Optional

The id or alias of the type.

Returns:
Name Description
string | undefined | null

The id of the base type or, undefined if the type is not known, or null if the type is known but does not have a base type.

getIdOf(aliasOrId) : string | undefined

Gets the id of a type given its alias (or id).

Source: doc-js/pentaho/typeInfo/IService.jsdoc, line 64

Parameters:
Name Default Value Summary
aliasOrId : string
 
Optional

The alias or id of the type.

Returns:
Name Description
string | undefined

The id of the type if it is known under the given alias (or id), or undefined if not.

getSubtypesOf(idOrAliasBase) : Array.<string> | undefined

Gets an array of the identifiers of known subtypes of a given base type, optionally including itself.

Source: doc-js/pentaho/typeInfo/IService.jsdoc, line 88

Parameters:
Name Default Value Summary
idOrAliasBase : string
 
Optional

The id or alias of the base type.

keyArgs.includeDescendants : boolean
 
Optional
false

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

keyArgs.includeSelf : boolean
 
Optional
false

Indicates that the base type should be included in the result.

Returns:
Name Description
Array.<string> | undefined

The ids of known subtypes or undefined, if the base type is not known.

isSubtypeOf(idOrAliasSub, idOrAliasBase) : boolean | undefined

Determines if one type is a subtype of another.

Source: doc-js/pentaho/typeInfo/IService.jsdoc, line 102

Parameters:
Name Default Value Summary
idOrAliasSub : string
 
Optional

The id or alias of the subtype.

idOrAliasBase : string
 
Optional

The id or alias of the base type.

Returns:
Name Description
boolean | undefined

true if idOrAliasSub is a subtype of idOrAliasBase; false, if not; undefined if either type is not known.