RelationType

new RelationType()

Represents a type of relations

Extends

$k.PropertyType

Methods

addSupertype(type)

Add a supertype

Parameters:

Name	Type	Description
`type`		Type or internal name

Inherited From: $k.Type#addSupertype

Throws:

If the argument is not a valid supertype
Type
$k.exception.TypeError
If the argument cannot be added as supertype
Type
$k.exception.SchemaError
If adding the type is not allowed
Type
$k.exception.AccessDenied
If no write transaction is active
Type
$k.exception.TransactionError

allInstances() → {Array.<$k.Instance>}

Returns all instances of this type and all subtypes. Avoid using this function if possible, use queries instead

Inherited From: $k.Type#allInstances

Returns:

Type:: Array.<$k.Instance>

allowsMultipleOccurrences() → {boolean}

Returns true if multiple occurrences per semantic element are possible

Inherited From: $k.PropertyType#allowsMultipleOccurrences

Returns:

Type:: boolean

allSubtypes() → {Array.<$k.Type>}

Returns all subtypes

Inherited From: $k.Type#allSubtypes

Returns:

Type:: Array.<$k.Type>

allSupertypes() → {Array.<$k.Type>}

Returns all supertypes

Inherited From: $k.Type#allSupertypes

Returns:

Type:: Array.<$k.Type>

attribute(type) → {$k.Attribute}

Returns the attribute of the type (including sub-attributes), or undefined if no attribute exists

Parameters:

Name	Type	Description
`type`		AttributeType or internal name

Inherited From: $k.SemanticElement#attribute

Throws:

If there is more than one attribute of this type
Type $k.exception.NotUnique

Returns:

Type:: $k.Attribute

attributes(typeopt) → {Array.<$k.Attribute>}

Returns all attributes of the type (including sub-attributes). Returns all attributes if the type is undefined

Parameters:

Name	Type	Attributes	Description
`type`		<optional>	AttributeType or internal name or undefined

Inherited From: $k.SemanticElement#attributes

Throws:

If type is not an attribute
Type $k.exception.SchemaError

Returns:

Type:: Array.<$k.Attribute>

attributeValue(type, languageopt)

Returns the value of the attribute, or undefined if there is no such attribute

Parameters:

Name	Type	Attributes	Description
`type`			AttributeType or internal name
`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.

Inherited From: $k.SemanticElement#attributeValue

Throws:

If there is more than one attribute of this type
Type $k.exception.NotUnique

Returns:

The value of the attribute

attributeValueString(type, languageopt) → {string}

Returns the value string of the attribute, or undefined if there is no such attribute

Parameters:

Name	Type	Attributes	Description
`type`			AttributeType or internal name
`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.

Since: 4.1.0
Inherited From: $k.SemanticElement#attributeValueString

Throws:

If there is more than one attribute of this type
Type $k.exception.NotUnique

Returns:

The value string of the attribute

Type:: string

callBehaviour(method, argsopt)

Calls an internal behavior method

Parameters:

Name	Type	Attributes	Description
`method`	string		Name of the method
`args`	Array.<object>	<optional>	Arguments of the call

Inherited From: $k.SemanticElement#callBehaviour

Throws:

When the behavior method raises an exception
Type $k.exception.RuntimeError

canCreateExtensions() → {boolean}

Returns true if instances of this type can be created as extensions of instances. Only either canCreateExtensions() or canCreateInstances() can be true. isAbstract() is true if neither canCreateExtensions() nor canCreateInstances() is true.

Inherited From: $k.Type#canCreateExtensions
See: $k.Instance#createExtension
$k.Type#canCreateInstances
$k.Type#isAbstract

Returns:

Type:: boolean

canCreateInstances() → {boolean}

Returns true if instances / properties of this type can be created. Only either canCreateExtensions() or canCreateInstances() can be true. isAbstract() is true if neither canCreateExtensions() nor canCreateInstances() is true.

Inherited From: $k.Type#canCreateInstances
See: $k.Type#canCreateExtensions
$k.Type#isAbstract

Returns:

Type:: boolean

changeLog() → {Array.<object>}

Get the change log object of this SemanticElement as object

Inherited From: $k.SemanticElement#changeLog

Returns:

A list of change log entries, each an conforming the below schema. Null if no change log is present for the SemanticElement.

{ "$schema" : "http://json-schema.org/draft-04/schema#", "type" : "object", "properties" : { "tag" : { "type" : "string", "enum" : ["AttributeEvent", "RelationEvent"], "description" : "is this a change for an attribute or a relation" }, "type" : { "type" : "string", "enum" : ["modify", "create", "delete", "executeMapping"], "description" : "what kind of change is logged in this event" }, "timestamp" : { "type" : "string", "description" : "time of the change; format: ISO 8601 timestamp string without timezone", }, "topic" : { "type" : "object", "description" : "id and label of the changed object", "properties" : { "label" : { "type" : "string" }, "id" : { "type" : "string" } } }, "user" : { "type" : "object", "description" : "id and name of the user object which performed the change", "properties" : { "label" : { "type" : "string" }, "id" :{ "type" : "string" } } }, "property" : { "type" : "object", "description" : "id and label of the changed property type", "properties" : { "conceptId" : { "type" : "string" }, "label" : { "type" : "string" } } }, "value" : { "type" : "string", "description" : "string representation of the new value" }, "language" : { "type" : "string", "description" : "language of the changed value; format: ISO639 3-letter code" }, "oldValue" : { "type" : "string", "description" : "string representation of the previous value" }, "target" : { "type" : "object", "description" : "id and label of the relation target object", "properties" : { "id" : { "type" : "string" }, "label" : { "type" : "string" } } }, "required" : [ "type", "tag", "timestamp", "topic" ] } }

Type:: Array.<object>

core() → {$k.SemanticElement}

Returns the extended element, if this is an extension. Returns the element itself otherwise

Inherited From: $k.SemanticElement#core

Returns:

Type:: $k.SemanticElement

createAttribute(type, value, languageopt) → {$k.Attribute}

Creates a new attribute with the given value

Parameters:

Name	Type	Attributes	Description
`type`			AttributeType or internal name
`value`			Value of the attribute. Pass undefined for attribute types without value.
`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.

Inherited From: $k.SemanticElement#createAttribute

Throws:

If the value is not in the range of allowed values of the attribute
Type
$k.exception.InvalidValue
If type is not a possible attribute of the element, or if no additional attributes can be created, or if language is not declared in attribute schema.
Type
$k.exception.SchemaError
If there is more than one attribute of this type
Type
$k.exception.NotUnique
If creating an attribute is not allowed
Type
$k.exception.AccessDenied
If no write transaction is active
Type
$k.exception.TransactionError

Returns:

Type:: $k.Attribute

Example

person.createAttribute("alias", "Tester");

createAttributeFromString(type, valueString, languageopt) → {$k.Attribute}

Creates a new attribute and set the value from the string representation

Parameters:

Name	Type	Attributes	Description
`type`			AttributeType or internal name
`valueString`	string		String represantation of the value
`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.

Inherited From: $k.SemanticElement#createAttributeFromString
Deprecated: Use setAttributeValue($k.ValueString(valueString), language) instead

Throws:

If the value is not in the range of allowed values of the attribute
Type
$k.exception.InvalidValue
If type is not a possible attribute of the element, or if no additional attributes can be created, or if language is not declared in attribute schema.
Type
$k.exception.SchemaError
If there is more than one attribute of this type
Type
$k.exception.NotUnique
If creating an attribute is not allowed
Type
$k.exception.AccessDenied
If no write transaction is active
Type
$k.exception.TransactionError

Returns:

Type:: $k.Attribute

Example

person.createAttributeFromString("dateOfBirth", "2.3.1968", "de");

createRelation(type, target, inverseopt) → {$k.Relation}

Creates a new relation

Parameters:

Name	Type	Attributes	Description
`type`			RelationType or internal name
`target`	$k.SemanticElement		The relation target.
`inverse`		<optional>	RelationType or internal name of the inverse Relation. The default inverse relation type will be used if this parameter is undefined.

Inherited From: $k.SemanticElement#createRelation

Throws:

If type is not a possible relation of the element, or if no additional relations can be created.
Type
$k.exception.SchemaError
If creating a relation is not allowed
Type
$k.exception.AccessDenied
If no write transaction is active
Type
$k.exception.TransactionError

Returns:

Type:: $k.Relation

definedDomains() → {Array.<$k.Domain>}

Returns the defined domains of the property.

Inherited From: $k.PropertyType#definedDomains

Returns:

Type:: Array.<$k.Domain>

domain() → {$k.Domain}

Returns the domain of the instances of this type

Inherited From: $k.Type#domain

Returns:

Type:: $k.Domain

domains() → {Array.<$k.Domain>}

Returns the effective domains of the property.

If the property is defined as mixin, extended domains are substituted by all possible extensions.
Domains that are sub-domains of other domains are discarded.
If the domain is a relation, and symmetric properties are enabled, all possible inverse relations are also included.

Inherited From: $k.PropertyType#domains

Returns:

Type:: Array.<$k.Domain>

element() → {$k.SemanticElement}

Returns this element. Allows to send element() either to a $k.Hit or a semantic element

Since: 4.3.0
Inherited From: $k.SemanticElement#element

Returns:

Type:: $k.SemanticElement

ensureAttributeValue(type, value, languageopt) → {$k.Attribute}

Returns an existing attribute with the given value. Otherwise creates and returns an additional attribute with the given value, or returns an existing attribute with modified value if the schema does not allow multiple occurrences.

Parameters:

Name	Type	Attributes	Description
`type`			AttributeType or internal name
`value`			The value that should be set.
`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.

Since: 4.3.0
Inherited From: $k.SemanticElement#ensureAttributeValue

Throws:

If the value is not in the range of allowed values of the attribute
Type
$k.exception.InvalidValue
If an invalid language was specified
Type
$k.exception.InvalidLanguage
If type is not a possible attribute of the element, or if language is not declared in attribute schema
Type
$k.exception.SchemaError
If modifying is not allowed
Type
$k.exception.AccessDenied
If no write transaction is active
Type
$k.exception.TransactionError

Returns:

Type:: $k.Attribute

ensureRelationTarget(type, target, inverseopt) → {$k.Relation}

Returns a existing relation to the target. Otherwise creates and returns an additional relation to the target, or returns an existing relation relocateded to the target if the schema does not allow multiple occurrences

Parameters:

Name	Type	Attributes	Description
`type`			RelationType or internal name
`target`	$k.SemanticElement		The relation target.
`inverse`		<optional>	RelationType or internal name of the inverse Relation. Only applies, if a new relation will be created. The default inverse relation type will be used if this parameter is undefined.

Since: 4.3.0
Inherited From: $k.SemanticElement#ensureRelationTarget

Throws:

If type is not a possible relation of the element, or if no additional relations can be created.
Type
$k.exception.SchemaError
If creating a relation is not allowed
Type
$k.exception.AccessDenied
If no write transaction is active
Type
$k.exception.TransactionError
If deleting the existing relation is not possible
Type
$k.exception.RemoveNotPossible

Returns:

Type:: $k.Relation

estimatedNumberOfInstances() → {number}

Returns the estimated number of instances of this type

Inherited From: $k.Type#estimatedNumberOfInstances

Returns:

Type:: number

getCounter() → {number}

Returns the value of the counter associated with this type.

Inherited From: $k.Type#getCounter

Returns:

Type:: number

hasPossibleAttribute(type) → {boolean}

Returns true if the type is a possible attribute of this element

Parameters:

Name	Type	Description
`type`		AttributeType or internal name

Inherited From: $k.SemanticElement#hasPossibleAttribute

Returns:

Type:: boolean

hasPossibleRelation(type) → {boolean}

Returns true if the type is a possible relation of this element

Parameters:

Name	Type	Description
`type`		RelationType or internal name

Inherited From: $k.SemanticElement#hasPossibleRelation

Returns:

Type:: boolean

icon(sizeopt, languageopt) → {blob}

Returns the icon of the element as blob

Parameters:

Name	Type	Attributes	Description
`size`	array	<optional>	Size of icon as array
`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.

Since: 4.1.0
Inherited From: $k.SemanticElement#icon

Returns:

Type:: blob

iconAttribute(sizeopt, languageopt) → {attribute}

Returns the icon of the element as blob attribute

Parameters:

Name	Type	Attributes	Description
`size`	array	<optional>	Size of icon as array
`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.

Since: 5.3.0
Inherited From: $k.SemanticElement#iconAttribute

Returns:

Type:: attribute

idNumber()

Inherited From: $k.SemanticElement#idNumber
Deprecated: Use idString() instead
See: idString

Throws:

$k.exception.HardDeprecationError

idString() → {string}

Returns the element ID as string (ID123_456). Returns undefined for non-persistent elements (system relations etc.)

Inherited From: $k.SemanticElement#idString

Returns:

Type:: string

increaseCounter() → {number}

Increases and returns the value of the counter associated with this type. The counter can be increased concurrently.

Inherited From: $k.Type#increaseCounter

Returns:

Type:: number

inheritedAttribute(type) → {$k.Attribute}

Returns the own attribute or the inherited attribute of the supertype(s). If there is more than one supertype, the attribute must be unique. If this is not a type, then this function is equivalent to attribute().

Parameters:

Name	Type	Description
`type`		AttributeType or internal name

Inherited From: $k.SemanticElement#inheritedAttribute

Throws:

If there is more than one value of this type
Type $k.exception.NotUnique

Returns:

The inherited attribute, or undefined if there is no attribute

Type:: $k.Attribute

inheritedAttributeValue(type, languageopt)

Returns the value of the own attribute or of the inherited value of the supertype(s). If there is more than one supertype, the value must be unique. If this is not a type, then this function is equivalent to attribute(value).

Parameters:

Name	Type	Attributes	Description
`type`			AttributeType or internal name
`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.

Inherited From: $k.SemanticElement#inheritedAttributeValue

Throws:

If there is more than one value of this type
Type $k.exception.NotUnique

Returns:

The inherited value, or undefined if there is no attribute

instances() → {Array.<$k.Instance>}

Returns all direct instances of this type. Avoid using this function if possible, use queries instead

Inherited From: $k.Type#instances

Returns:

Type:: Array.<$k.Instance>

internalName() → {string}

Returns the internal name

Inherited From: $k.Type#internalName

Returns:

Type:: string

intrafindConvertAndTagDocument(urlopt) → {object}

Converts a document blob or URL located document to an object containing metadata and tags using intrafinds API functions

Parameters:

Name	Type	Attributes	Description
`url`	string	<optional>	Url to convert a document from instead of the semantic element this function was called for

Inherited From: $k.SemanticElement#intrafindConvertAndTagDocument

Throws:

If the configuration is missing or incomplete
Type $k.exception.RuntimeError

Returns:

Type:: object

intrafindConvertDocument(urlopt) → {object}

Converts a document blob or URL located document to an object containing the meta data using intrafinds API functions

Parameters:

Name	Type	Attributes	Description
`url`	string	<optional>	Url to convert a document from instead of the semantic element this function was called for

Inherited From: $k.SemanticElement#intrafindConvertDocument

Throws:

If the configuration is missing or incomplete
Type $k.exception.RuntimeError

Returns:

Type:: object

inverseRelationType() → {$k.RelationType}

Returns the inverse relation type

Returns:

Type:: $k.RelationType

isAbstract() → {boolean}

Returns true if this is an abstract type (cannot create properties/instances/extensions). isAbstract() is true if neither canCreateExtensions() nor canCreateInstances() is true.

Inherited From: $k.Type#isAbstract

Returns:

Type:: boolean

isInvalid() → {boolean}

True if the semantic element was deleted (e.g. by a rollback or remove()

Inherited From: $k.SemanticElement#isInvalid

Returns:

Type:: boolean

isKindOf(type) → {boolean}

Returns true if this is equal to or a direct or indirect type of the other type

Parameters:

Name	Type	Description
`type`		Type or internal name

Inherited From: $k.Type#isKindOf

Throws:

If the argument is not a type
Type
$k.exception.TypeError
If the argument is an unknown internal name
Type
$k.exception.SchemaError

Returns:

Type:: boolean

isMainDirection() → {boolean}

Returns true if this is the main direction for the relation type.

Returns:

Type:: boolean

isSingleSided() → {boolean}

Returns true if this is a single sided relation type (i.e. only the main direction of the relation is stored in the volume).

Returns:

Type:: boolean

isSymmetric() → {boolean}

Returns true if this is a symmetric relation.

Returns:

Type:: boolean

kPathEvaluate(pathString)

Parameters:

Name	Type	Description
`pathString`

Inherited From: $k.SemanticElement#kPathEvaluate

locatorString(locatorTypesopt) → {string}

Returns the element locator as string

Parameters:

Name	Type	Attributes	Description
`locatorTypes`	array	<optional>

Since: 4.0.2
Inherited From: $k.SemanticElement#locatorString

Returns:

Type:: string

maxOccurrencesGuideline() → {number}

Returns max occurrences guideline of property type definition

Inherited From: $k.PropertyType#maxOccurrencesGuideline

Returns:

Type:: number

minOccurrencesGuideline() → {number}

Returns min occurrences guideline of property type definition

Inherited From: $k.PropertyType#minOccurrencesGuideline

Returns:

Type:: number

modificationNumber() → {number}

Returns the modification number for the cluster conatining as 64 bit integer. Returns 0 for newly created topics that are not yet assigned to a cluster. Returns undefined for non-persistent elements (system relations etc.). An unchanged modification number indicates that the element is unchanged. A changed modification number does not necessarily indicate that the topic changed, because there might have been changes in other objects contained in the same cluster.

Inherited From: $k.SemanticElement#modificationNumber

Returns:

Type:: number

name(languageopt) → {string}

Returns the name of the element

Parameters:

Name	Type	Attributes	Description
`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.

Inherited From: $k.SemanticElement#name

Returns:

Type:: string

numberOfInstances() → {number}

Returns the exact number of instances of this type

Inherited From: $k.Type#numberOfInstances

Returns:

Type:: number

openInKnowledgeBuilder(user)

Parameters:

Name	Type	Description
`user`	$k.User

Version: Experimental feature, might be removed at any time
Inherited From: $k.SemanticElement#openInKnowledgeBuilder

possibleProperties(filteropt) → {Array.<$k.PropertyType>}

Returns the possible properties of this element.

Parameters:

Name	Type	Attributes	Description
`filter`	string \| $k.PropertyFilter	<optional>	Optional filter that defines which properties are returned

Inherited From: $k.SemanticElement#possibleProperties
See: $k.PropertyFilter

Returns:

Type:: Array.<$k.PropertyType>

Examples

// Possible properties, excluding shortcut / system relations
possibleProperties();

// Possible properties, including system relations
possibleProperties($k.PropertyFilter.setSystemRelations());

// Same as above, using a literal object to define the filter
possibleProperties({ systemRelations: true });

primaryCore() → {$k.SemanticElement}

Returns the primary element.

if the receiver is an instance or type, then the receiver itself is returned.
if the receiver is an extension, then the extended instance is returned.
if the receiver is a property, then the primary core of the source is returned.

Since: 4.2.0
Inherited From: $k.SemanticElement#primaryCore

Returns:

Type:: $k.SemanticElement

properties(filteropt) → {Array.<$k.Property>}

Returns all properties of the property type

Parameters:

Name	Type	Attributes	Description
`filter`	string \| $k.PropertyFilter	<optional>	Filter that defines which properties are returned

Inherited From: $k.SemanticElement#properties

Returns:

Type:: Array.<$k.Property>

Examples

// All properties 
properties();

// All relations with internal name "contains", including sub-relations
properties(new $k.PropertyFilter().setType("contains"));

// All relations with internal name "contains", without sub-relations
properties(new $k.PropertyFilter().setExact().setType("contains"));

// Same as above, using a literal object to define the filter
properties({ exact: true, type: "contains" });

ranges() → {Array.<$k.Domain>}

Returns the possible ranges of the relation, which are the domains of the inverse relation

Returns:

Type:: Array.<$k.Domain>

relation(type) → {$k.Relation}

Returns the relation of the type (including sub-relations), or undefined if no relation exists

Parameters:

Name	Type	Description
`type`		RelationType or internal name

Inherited From: $k.SemanticElement#relation

Throws:

If type is not a possible relation of the topic
Type
$k.exception.SchemaError
If type is not a relation type
Type
$k.exception.TypeError
If there is more than one relation of this type
Type
$k.exception.NotUnique

Returns:

Type:: $k.Relation

relations(typeopt) → {Array.<$k.Relation>}

Returns all relations of the type (including sub-relations). If type is undefined, all user relations (excluding inverse one way relations) are returned.

Parameters:

Name	Type	Attributes	Description
`type`		<optional>	RelationType or internal name or undefined

Inherited From: $k.SemanticElement#relations

Throws:

If type is not a relation type
Type $k.exception.TypeError

Returns:

Type:: Array.<$k.Relation>

relationTarget(type) → {$k.SemanticElement}

Returns the target of the relation of the relation type, or undefined if there is no such relation

Parameters:

Name	Type	Description
`type`		RelationType or internal name

Inherited From: $k.SemanticElement#relationTarget

Throws:

If there is more than one relation of this type
Type
$k.exception.NotUnique
If type is not a relation type
Type
$k.exception.TypeError

Returns:

Type:: $k.SemanticElement

relationTargets(type) → {Array.<$k.SemanticElement>}

Returns the targets of the relations of the relation type. Each target is only returned once, even if multiple relations point to the same target. Returns all relation targets if the type is undefined

Parameters:

Name	Type	Description
`type`		RelationType or internal name or undefined

Inherited From: $k.SemanticElement#relationTargets

Throws:

If type is not a relation type
Type $k.exception.TypeError

Returns:

Type:: Array.<$k.SemanticElement>

relationTargetSearch(searchStringopt, contextopt) → {$k.SemanticElement}

Parameters:

Name	Type	Attributes	Description
`searchString`	string	<optional>	Search string for the target element
`context`	$k.SemanticElement	<optional>	Context of the relationTargetSearch

Version: Experimental feature, might be removed at any time

Returns:

Type:: $k.SemanticElement

remove()

Deletes the element and all attached properties

Inherited From: $k.SemanticElement#remove

Throws:

If deleting the element or any property not allowed
Type
$k.exception.AccessDenied
If deleting the element is not possible, e.g. when trying to delete a system element
Type
$k.exception.RemoveNotPossible

removeProperties(filteropt)

Removes all properties of the property type

Parameters:

Name	Type	Attributes	Description
`filter`	string \| $k.PropertyFilter	<optional>	Filter that defines which properties are removed

Since: 5.4.0
Inherited From: $k.SemanticElement#removeProperties

Throws:

If deleting one of the properties is not allowed
Type $k.exception.AccessDenied

removeSupertype()

Remove a supertype

Inherited From: $k.Type#removeSupertype

Throws:

If the argument is not a valid supertype
Type
$k.exception.TypeError
If removing the type is not allowed
Type
$k.exception.AccessDenied
If no write transaction is active
Type
$k.exception.TransactionError

render(contextopt, keyFilteropt, detailFilteropt) → {object}

Renders the element as a literal object using the associated view configuration. Uses the optional context topic to detect a suitable configuration

Parameters:

Name	Type	Attributes	Description
`context`	object	<optional>	Element that defines the context.
`keyFilter`	object	<optional>	Alternative 1 (preferred): a $k.JSONRenderContext Alternative 2 (compatibility only): A filter. See $k.JSONRenderContext.prototype.setFilters().
`detailFilter`	object	<optional>	Only used if the key filter is not a $k.JSONRenderContext. See $k.JSONRenderContext.prototype.setLevelsOfDetail()

Inherited From: $k.SemanticElement#render

Returns:

The rendered object

Type:: object

renderJSON(contextopt, excludedKeysopt, detailFilteropt) → {object}

Render the element as a JavaScript object using the associated view configuration. Uses the optional context topic to detect a suitable configuration

Parameters:

Name	Type	Attributes	Description
`context`	$k.SemanticElement	<optional>	Element that defines the context.
`excludedKeys`	Array.<string>	<optional>	Collection of property names that are excluded
`detailFilter`	object	<optional>	Only used if the key filter is not a $k.JSONRenderContext. See $k.JSONRenderContext.prototype.setLevelsOfDetail()

Inherited From: $k.SemanticElement#renderJSON
Deprecated: Use render(context, {"exclude": excludedKeys}) instead

Returns:

The rendered JSON object

Type:: object

renderTemplate(template, entity, conversionopt, variablesopt)

Render a document based on a given print template

Parameters:

Name	Type	Attributes	Description
`template`	$k.SemanticElement		the template that will be applied
`entity`	$k.NetEntity		The render target
`conversion`	$k.SemanticElement	<optional>	The semantic element representing the document conversion
`variables`	object	<optional>	Additional variables to pass to the template

Since: 4.4.0
Inherited From: $k.SemanticElement#renderTemplate

Throws:

When the element could not be rendered
Type $k.exception.RuntimeError

schemaReportOn(context)

Parameters:

Name	Type	Description
`context`		A $k.XMLWriter

Inherited From: $k.Type#schemaReportOn
Deprecated: This function is deprecated and might be removed in future releases

setAttributeFromString(type, valueString, languageopt)

Sets the value of the attribute from the string representation. Creates a new attribute if no such attribute exists

Parameters:

Name	Type	Attributes	Description
`type`			AttributeType or internal name
`valueString`	string		String represantation of the value
`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.

Inherited From: $k.SemanticElement#setAttributeFromString
Deprecated: Use setAttributeValue(type, $k.ValueString(valueString), language) instead

Throws:

If the value is not in the range of allowed values of the attribute
Type
$k.exception.InvalidValue
If an invalid language was specified
Type
$k.exception.InvalidLanguage
If type is not a possible attribute of the element, or if language is not declared in attribute schema
Type
$k.exception.SchemaError
If there is more than one attribute of this type
Type
$k.exception.NotUnique
If modifying is not allowed
Type
$k.exception.AccessDenied
If no write transaction is active
Type
$k.exception.TransactionError

setAttributeValue(type, value, languageopt)

Sets the value of the attribute. Creates a new attribute if no such attribute exists

Parameters:

Name	Type	Attributes	Description
`type`			AttributeType or internal name
`value`			The value that should be set.
`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.

Inherited From: $k.SemanticElement#setAttributeValue

Throws:

If the value is not in the range of allowed values of the attribute
Type
$k.exception.InvalidValue
If type is not a possible attribute of the element, or if language is not declared in attribute schema
Type
$k.exception.SchemaError
If an invalid language was specified
Type
$k.exception.InvalidLanguage
If there is more than one attribute of this type
Type
$k.exception.NotUnique
If modifying is not allowed
Type
$k.exception.AccessDenied
If no write transaction is active
Type
$k.exception.TransactionError

setCanCreateExtensions(canCreate)

Set to true if it should be possible to extend other instances with instances of this tyoe. The flag cannot be set to false if extensions exist. Only either canCreateExtensions() or canCreateInstances() can be true.

Parameters:

Name	Type	Description
`canCreate`	boolean

Inherited From: $k.Type#setCanCreateExtensions
See: $k.Type#canCreateExtensions
$k.Type#setCanCreateInstances

Throws:

If it is not possible to change the schema, e.g. when the type already allows to create instances
Type $k.exception.SchemaError

setCanCreateInstances(canCreate)

Set to true if it should be possible to create instances / properties this type. The flag cannot be set to false if instances exist. Only either canCreateExtensions() or canCreateInstances() can be true.

Parameters:

Name	Type	Description
`canCreate`	boolean

Inherited From: $k.Type#setCanCreateInstances
See: $k.Type#canCreateInstances
$k.Type#setCanCreateExtensions

Throws:

If it is not possible to change the schema, e.g. when the type already allows to create extensions
Type $k.exception.SchemaError

setCounter(counterValue) → {number}

Set the initial value of the counter associated with this type. Note: this cannot be done concurrently. Use increaseCounter() instead.

Parameters:

Name	Type	Description
`counterValue`	number	Must be an integer

Inherited From: $k.Type#setCounter
See: $k.Type#increaseCounter

Returns:

The counter value

Type:: number

setInternalName(name)

Sets the internal name, or removes the internal name if null is passed

Parameters:

Name	Type	Description
`name`		New internal name or null

Inherited From: $k.Type#setInternalName

Throws:

If the argument is not a valid internal name
Type
$k.exception.TypeError
If modifying the type is not allowed
Type
$k.exception.AccessDenied
If the internal name is not unique
Type
$k.exception.NotUnique
If no write transaction is active
Type
$k.exception.TransactionError

setName(name, languageopt)

Sets the name of the element

Parameters:

Name	Type	Attributes	Description
`name`	string		The name
`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.

Inherited From: $k.SemanticElement#setName

Throws:

If the name is not a string
Type
$k.exception.TypeError
If no write transaction is active
Type
$k.exception.TransactionError
If an invalid language was specified
Type
$k.exception.InvalidLanguage
If language is not declared in name attribute schema
Type
$k.exception.SchemaError

setRelationTarget(type, target, inverseopt)

Sets the target of the relation. Creates a new relation if no such relation exists

Parameters:

Name	Type	Attributes	Description
`type`			RelationType or internal name
`target`	$k.SemanticElement		The relation target.
`inverse`		<optional>	RelationType or internal name of the inverse Relation. Only applies, if a new relation will be created. The default inverse relation type will be used if this parameter is undefined.

Since: 4.3.0
Inherited From: $k.SemanticElement#setRelationTarget

Throws:

If type is not a possible relation of the element, or if no additional relations can be created.
Type
$k.exception.SchemaError
If there is more than one relation of this type
Type
$k.exception.NotUnique
If creating a relation is not allowed
Type
$k.exception.AccessDenied
If no write transaction is active
Type
$k.exception.TransactionError
If deleting the existing relation is not possible
Type
$k.exception.RemoveNotPossible