Registry

Global object registry API for accessing objects by internal name / ID

Methods

(static) element(internalName) → {$k.SemanticElement}

Gets the semantic element with the internal name

Parameters:

Name	Type	Description
`internalName`	string	The internal name of the element

Throws:

If no such element exists
Type $k.exception.ObjectNotFound

Returns:

The element identified by the internal name

Type:: $k.SemanticElement

(static) elementAtValue(type, value, languageopt) → {$k.SemanticElement}

Returns the semantic element with an attribute with the specified value, or undefined if there is either no such attribute or more than one

Parameters:

Name	Type	Attributes	Description
`type`			AttributeType or internal name
`value`			The value to search for
`language`	string	<optional>	Either an ISO 639-1 or ISO 639-2B language code (e.g. "en" or "eng"), or a locale name without encoding (e.g. "en_US"). Locale names and language codes are not interchangeable, e.g. the values for "de" and "de_DE" are separated. If not defined, the locale/language of the process will be used. Ignored if the attribute is not translated.

Throws:

If the value is not in the range of allowed values of the attribute
Type $k.exception.InvalidValue

Returns:

Type:: $k.SemanticElement

(static) elementByLocator(locator) → {$k.SemanticElement|$k.Domain}

Get the semantic element / domain with the element locator

Parameters:

Name	Type	Description
`locator`	string

Since: 4.0.2
See: $k.SemanticElement#locatorString

Throws:

If no element with the locator exists
Type
$k.exception.ObjectNotFound
If the locator is not valid
Type
$k.exception.InvalidValue

Returns:

Type:: $k.SemanticElement | $k.Domain

(static) elementWithID(id) → {$k.SemanticElement}

Get the semantic element with the element ID

Parameters:

Name	Type	Description
`id`	string	ID string, e.g. the return value of idString(). Do not pass ID numbers returned by idNumber() anymore, due to representation problems for numbers larger than 2^53 in JavaScript.

See: $k.SemanticElement#idString

Throws:

If no element with the ID exists
Type
$k.exception.ObjectNotFound
If the ID is not valid
Type
$k.exception.InvalidValue
If the ID argument is not an ID
Type
Type

Returns:

Type:: $k.SemanticElement

(static) folder(folderID) → {$k.Folder}

Get the registered folder

Parameters:

Name	Type	Description
`folderID`	string	Registered ID

Throws:

If no folder with the ID exists
Type $k.exception.ObjectNotFound

Returns:

Type:: $k.Folder

(static) mapping(mappingID) → {$k.Mapping}

Get the registered mapping

Parameters:

Name	Type	Description
`mappingID`	string	A registered ID

Throws:

If no mapping with the ID exists
Type $k.exception.ObjectNotFound

Returns:

The found mapping

Type:: $k.Mapping

(static) query(queryID) → {$k.Query}

Get the registered query

Parameters:

Name	Type	Description
`queryID`	string	Registered ID

Throws:

If no expert query with the ID exists
Type $k.exception.ObjectNotFound

Returns:

Type:: $k.Query

(static) registeredFolders() → {Array.<$k.Folder>}

Returns all registered folders

Returns:

Type:: Array.<$k.Folder>

(static) registeredMappings() → {Array.<$k.Mapping>}

Returns all registered mappings

Since: 5.6.1

Returns:

Type:: Array.<$k.Mapping>

(static) registeredObject(registryType, objectID) → {object}

Get the registered folder element with the ID from the registry

Parameters:

Name	Type	Description
`registryType`	string	Name of the registry. Corresponds to the value returned by registryType()
`objectID`	string

Deprecated: Use specific registry accessors, like query() or folder()
See: $k.FolderElement#registryType

Throws:

If no object with the ID exists
Type $k.exception.ObjectNotFound

Returns:

Type:: object

(static) registeredQueries() → {Array.<$k.Query>}

Returns all registered queries

Returns:

Type:: Array.<$k.Query>

(static) registeredScriptIDs() → {Array.<string>}

Returns the IDs of all registered scripts

Version: Experimental feature, might be removed at any time
Since: 5.1.1

Returns:

Type:: Array.<string>

(static) registeredSemanticCollections() → {Array.<$k.SemanticCollection>}

Returns all registered semantic collections

Returns:

Type:: Array.<$k.SemanticCollection>

(static) semanticCollection(collectionID) → {$k.SemanticCollection}

Get the registered semantic collection

Parameters:

Name	Type	Description
`collectionID`	string	Registered ID

Throws:

If no topic collection with the ID exists
Type $k.exception.ObjectNotFound

Returns:

Type:: $k.SemanticCollection

(static) type(type) → {$k.Type}

Gets the type with the internal name

Parameters:

Name	Type	Description
`type`	string	The internal name of the type

Throws:

If no such type exists
Type $k.exception.ObjectNotFound

Returns:

The type identified by the internal name

Type:: $k.Type