InstancesContainer
pentaho.type. InstancesContainer
A class that holds configured named instances.
AMD Module
require(["pentaho/type/InstancesContainer"], function(InstancesContainer) { /* code goes here */ });
Constructor
Name | Description |
---|---|
new InstancesContainer(context, spec) |
Members
Name | Description |
---|---|
context : | Gets the associated type context. |
Methods
Name | Description |
---|---|
declare(id, typeId, instanceConfig) : pentaho.type.InstancesContainer | Declares an instance with a given identifier and container specification. |
get(instRef, instKeyArgs, typeBase) : pentaho.type.Instance | Resolves an instance reference. |
getAllByType(baseTypeId, keyArgs) : Array.<<code>!pentaho.type.Instance > | Gets all of the instances of the given type which are already successfully loaded and that, optionally, match a specified filter. |
getAllByTypeAsync(baseTypeId, keyArgs) : Promise.<<code>Array.<<code>!pentaho.type.Instance >> | Gets a promise for all of the instances of the given type and that, optionally, match a specified filter. |
getAsync(instRef, instKeyArgs, typeBase) : Promise.<<code>pentaho.type.Instance > | Resolves an instance reference, asynchronously. |
getById(id) : pentaho.type.Instance | Gets a loaded configured instance given its identifier. |
getByIdAsync(id) : Promise.<<code>pentaho.type.Instance > | Gets a promise for a configured instance given its identifier. |
getByType(baseTypeId, keyArgs) : pentaho.type.Instance | Gets the highest ranking instance among the instances of the given type which are successfully loaded and that, optionally, match a specified filter. |
getByTypeAsync(baseTypeId, keyArgs) : Promise.<<code>pentaho.type.Instance > | Gets a promise for the first instance of the given type and that, optionally, matches a specified filter. |
Constructor Details
new InstancesContainer(context, spec) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Source: javascript/web/pentaho/type/InstancesContainer.js, line 207
|
Members Details
context: |
---|
Gets the associated type context. Source: javascript/web/pentaho/type/InstancesContainer.js, line 257 |
Methods Details
declare(id, typeId, instanceConfig) : pentaho.type.InstancesContainer | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Declares an instance with a given identifier and container specification. Source: javascript/web/pentaho/type/InstancesContainer.js, line 271
|
get(instRef, instKeyArgs, typeBase) : pentaho.type.Instance | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Resolves an instance reference. This method can be used for:
Source: javascript/web/pentaho/type/InstancesContainer.js, line 756
See also: pentaho.type.InstancesContainer#getAsync , pentaho.type.Type#create |
getAllByType(baseTypeId, keyArgs) : Array.<<code>!pentaho.type.Instance > | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets all of the instances of the given type which are already successfully loaded and that, optionally, match a specified filter. Source: javascript/web/pentaho/type/InstancesContainer.js, line 509
|
getAllByTypeAsync(baseTypeId, keyArgs) : Promise.<<code>Array.<<code>!pentaho.type.Instance >> | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a promise for all of the instances of the given type and that, optionally, match a specified filter. Source: javascript/web/pentaho/type/InstancesContainer.js, line 415
|
getAsync(instRef, instKeyArgs, typeBase) : Promise.<<code>pentaho.type.Instance > | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Resolves an instance reference, asynchronously. This method can be used for:
Source: javascript/web/pentaho/type/InstancesContainer.js, line 689
See also: pentaho.type.InstancesContainer#get , pentaho.type.Type#createAsync |
getById(id) : pentaho.type.Instance | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a loaded configured instance given its identifier. An instance can only be requested synchronously if it has already been requested asynchronously before. Source: javascript/web/pentaho/type/InstancesContainer.js, line 339
|
getByIdAsync(id) : Promise.<<code>pentaho.type.Instance > | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a promise for a configured instance given its identifier. Source: javascript/web/pentaho/type/InstancesContainer.js, line 306
|
getByType(baseTypeId, keyArgs) : pentaho.type.Instance | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the highest ranking instance among the instances of the given type which are successfully loaded and that, optionally, match a specified filter. Source: javascript/web/pentaho/type/InstancesContainer.js, line 462
|
getByTypeAsync(baseTypeId, keyArgs) : Promise.<<code>pentaho.type.Instance > | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a promise for the first instance of the given type and that, optionally, matches a specified filter. Source: javascript/web/pentaho/type/InstancesContainer.js, line 383
|