Search

• $jni

  Provides Java native interface in Javascript

  • getClass(className)
    Returns a class
  • toJava(object)
    Returns a Java represantation of the object
  • use(className, useNamespace)
    Imports the class(es) as a constructor of the same name

• $jni.char

  Represents a primitive character (char)

  • codePoint()
    Returns the code point of the character
  • toJS()
    Returns a JavaScript representation of the object
  • toString()
    Returns a string containing the character

• $jni.JavaClass

  Represents a Java class

  • getStatic(name)
    Returns the static member of the class
  • name()
    Returns the name of the class
  • toJS()
    Returns a JavaScript representation of the object

• $jni.JavaObject

  Represents a Java instance

  • toJS()
    Returns a JavaScript representation of the object

• $jni.JavaPrimitiveArray

  Represent an array of primitive types (byte[], char[] etc.

  • toJS()
    Returns a JavaScript representation of the object

• $k

  The K-Infinity namespace

  • LOG_DEBUG
    Log level [DEBUG]
  • LOG_ERROR
    Log level [ERROR]
  • LOG_NORMAL
    Normal log level
  • LOG_WARNING
    Log level [WARNING]
  • out
    Returns the document that represents the output stream of some script environments. The kind of object depends on the environment, but is usually an instance of $k.TextDocument.
  • define(id, dependencies, factory)
    Defines a module
  • log(object, level, channel)
    Log an object on the current log stream (if available)
  • mapInstances(internalName, proto)
    Map the prototype of instances of the type with the internal name to the prototype object
  • mapModule(moduleName, registryID)
    Maps a module ID to the ID of a registered script. Allows to register scripts containing modules under a different ID
  • mapTypes(internalName, proto)
    Map the prototype of types with the internal name to the prototype object
  • module(moduleName)
    Loads a module
  • optimisticTransaction(f)
    Evaluates the function in a transaction and returns its return value. Does not check if the transaction has been accepted or rejected. Allows to start a transaction within another transaction, the nested transaction will be a part of the outer transaction
  • require(dependencies, callback)
    Calls a function with required modules. Passes the value of each required module
  • rootType()
    Returns the root type of the semantic network
  • shortcutRelationType()
    Returns the parent type of all shortcut relation types
  • symmetricRelationProperties()
    Returns true if symmetric relation properties are enabled
  • systemRelationType()
    Returns the parent type of all system relation types
  • topAttributeType()
    Returns the parent type of all attribute types
  • topRelationType()
    Returns the parent type of all relation types
  • topTypes()
    Returns all top types except the top attribute and relation types
  • transaction(f, rejectFunction)
    Evaluates the function in a transaction and returns its return value if the transaction has been accepted. If the transaction is rejected due to concurrency conflicts, the optional reject function is performed. This function does not allow to start a transaction within an outer transaction, use optimisticTransaction() instead.
  • user()
    Returns the current user
  • userRelationType()
    Returns the parent type of user-defined relation type
  • uuid()
    Generates a UUID
  • volume()
    Returns the name of the semantic network

• $k.AbstractEditorConfiguration

  Configuration of an editor

• $k.Attribute

  Represents an attribute.

  • hasTranslatedValues()
    True if the attribute has translated values
  • removeTranslation(language)
    Removes the translated value for the language
  • setValue(value, language)
    Sets the value of the attribute
  • setValueString(string, language)
    Sets the value of the attribute from the string representation
  • translatedLanguages()
    Returns the translated languages as 3-letter codes (ISO639 2b). Empty if the attribute is not translated
  • value(language)
    Returns the value of the attribute
  • valueRange()
    Returns the range of the values of the attribute
  • valueString(language)
    Returns the string representation of the value of the attribute

• $k.AttributeType

  Represents a type of attributes

  • elementAtValue(value, language)
    Returns the semantic element with an attribute of this type with the specified value, or undefined if there is either no such attribute or more than one
  • elementsAtValue(value, language)
    Returns all semantic elements with attributes of this types with the specified value
  • hasTranslatedValues()
    True if the attributes have translated values
  • translatedLanguages()
    Returns the possible translated languages as 3-letter codes (ISO639 2b). Empty if the attribute is not translated
  • valueRange()
    Returns the range of the values of the attributes

• $k.Blob

  The value of a blob attribute.

  • base64String()
    Returns the blob bytes as base 64 encoded string
  • convertImage(mediaType)
    Converts the image to another media type
  • createThumbnail(width, height, mediaType)
    Create a thumbnail with the specified maxium dimensions. The aspect ratio is preserved. Width or height can be undefined, but not both. The media type is optional and specifies the image type of the thumbnail. If not defined, the thumbnail will have the same type as the original image.
  • dataUrl()
    Returns the blob bytes as a data URL
  • equals(value)
    Returns true if the values are equal
  • fileExtension()
    Returns the extension of the filename of the blob, without dot
  • filename()
    Returns the filename of the blob
  • language()
    Returns the language of the blob, or undefined if not translated
  • locator()
    Returns a string that identifies the blob. Can be used to get the blob contents from the blob REST service
  • mimeType()
    Returns the mime type of the blob
  • size()
    Returns the byte size of the blob
  • text(charset)
    Returns the blob bytes as string
  • toNetEntity()
    Creates a NetEntity from this blob

• $k.Cause

  Provides additional details about a hit returned by a query

  • property(name)
    Returns the value of the named property, or undefined if the property does not exist
  • quality()
    Returns the quality of the cause, a number between 0 (worst quality) and 1 (best quality)
  • setProperties(properties)
    Set the properties of the cause
  • setProperty(name, value)
    Set the value of the named property
  • setQuality(quality)
    Set the quality, a number between 0 and 1
  • setType(type)
    Set the type
  • type()
    Returns the type of the cause, e.g. 'semantic'

• $k.Choice

  A choice of a choice attribute.

  • equals(value)
    Returns true if the values are equal
  • internalName()
    Returns the internal name (key) of the choice
  • position()
    Returns the position (0-based) of the choice, if defined
  • untranslatedString()
    Returns the untranslated string
  • valueString(language)
    Returns the string representation of the choice. Returns the fallback string if the choice does not define a translation for a language

• $k.ChoiceRange

  Represents the value range of a choice attribute

  • choiceInternalNamed(internalName)
    Returns the choice with the internal name
  • choices()
    Returns the possible choices

• $k.Cookie

  Represents a HTTP Cookie (RFC 2109) sent by a client

  • name()
    Returns the name of the cookie
  • value()
    Returns the value of the cookie

• $k.Date

  Represents a date

  • equals(value)
    Returns true if the values are equal
  • getDayNumber()
    Returns the number of the day, e.g. 18 for 2011-03-18
  • getMonthNumber()
    Returns the number of the month. Unlike Date.prototype.month(), this is not the 0-based month index, so for January getMonthNumber() returns 1, not 0
  • getYear()
    Returns the full year
  • maxDate()
    Returns the latest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T23:59:59.999 for the date 2007-03-01. Assumes that this is date/time of the local timezone
  • maxUTCDate()
    Returns the latest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T23:59:59.999 for the date 2007-03-01. Assumes that this is date/time of the local timezone
  • minDate()
    Returns the earliest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T0:00:00.0 for the date 2007-03-01. Assumes that this is date/time of the local timezone
  • minUTCDate()
    Returns the earliest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T0:00:00.0 for the date 2007-03-01. Assumes that this is an UTC date/time
  • parse(string, language)
    Parse the date/time string. Both ISO 8601 adnd localized strings are supported.
  • setDayNumber(day)
    Sets the number of the day, e.g. 23 for 2012-05-23
  • setMonthNumber(month)
    Set the number of the month. Unlike Date.prototype.month(), this is not the 0-based month index, so for January pass 1 to setMonthNumber() , not 0.
  • setYear(year)
    Sets the full year. The year is not modified, so setYear(99) sets the year 99, not 1999.
  • toDate()
    Returns the date/time as a Javascript date object. Assumes that this is date/time of the local timezone
  • toJSON(key)
    Returns a string representing the date/time, similar to Date.prototype.toJSON ( key )
  • toString(language)
    Returns the string representation. Equivalent to valueString()
  • valueString(language)
    Returns the string representation

• $k.DateTime

  Represents a date and time without timezone

  • equals(value)
    Returns true if the values are equal
  • getDayNumber()
    Returns the number of the day, e.g. 18 for 2011-03-18
  • getHours()
    Returns the hours
  • getMinutes()
    Returns the minutes
  • getMonthNumber()
    Returns the number of the month. Unlike Date.prototype.month(), this is not the 0-based month index, so for January getMonthNumber() returns 1, not 0
  • getSeconds()
    Returns the seconds
  • getYear()
    Returns the full year
  • maxDate()
    Returns the latest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T23:59:59.999 for the date 2007-03-01. Assumes that this is date/time of the local timezone
  • maxUTCDate()
    Returns the latest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T23:59:59.999 for the date 2007-03-01. Assumes that this is date/time of the local timezone
  • minDate()
    Returns the earliest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T0:00:00.0 for the date 2007-03-01. Assumes that this is date/time of the local timezone
  • minUTCDate()
    Returns the earliest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T0:00:00.0 for the date 2007-03-01. Assumes that this is an UTC date/time
  • parse(string, language)
    Parse the date/time string. Both ISO 8601 adnd localized strings are supported.
  • setDayNumber(day)
    Sets the number of the day, e.g. 23 for 2012-05-23
  • setHours(hours)
    Sets the hours
  • setMinutes(minutes)
    Sets the minutes.
  • setMonthNumber(month)
    Set the number of the month. Unlike Date.prototype.month(), this is not the 0-based month index, so for January pass 1 to setMonthNumber() , not 0.
  • setSeconds(seconds)
    Sets the seconds.
  • setYear(year)
    Sets the full year. The year is not modified, so setYear(99) sets the year 99, not 1999.
  • toDate()
    Returns the date/time as a Javascript date object. Assumes that this is date/time of the local timezone
  • toJSON(key)
    Returns a string representing the date/time, similar to Date.prototype.toJSON ( key )
  • toString(language)
    Returns the string representation. Equivalent to valueString()
  • toUTCDate()
    Returns the date/time as a Javascript date object. Assumes that this is an UTC date/time
  • valueString(language)
    Returns the string representation

• $k.Domain

  Represents all instances or subtypes of a type

  • definedProperties()
    Returns the properties defined for this domain. No inherited or mixed in properties are returned.
  • isTypeDomain()
    Returns true if this domain represents types, false if it represents instances / properties
  • possibleProperties(filter)
    Returns the possible properties of this domain
  • type()
    Returns the type of the domain

• $k.exception

  Namespace of errors

• $k.exception.AccessDenied

  Thrown when an read/write access is denied by the access rights

• $k.exception.HttpError

  Raised when a HTTP request fails

• $k.exception.InvalidLanguage

  Thrown when an invalid language was specified

• $k.exception.InvalidValue

  Thrown when a value is not in the range of allowed values

• $k.exception.JavaError

• $k.exception.MailError

• $k.exception.MissingParameter

  A required parameter is missing

• $k.exception.ModuleError

  An error related to defining or using module

• $k.exception.NotUnique

  Thrown when an object or value is not unique

• $k.exception.ObjectNotFound

  Thrown when an object could not be found

• $k.exception.ObjectRemoved

  Thrown when attempting to access a topic that was removed

• $k.exception.QueryError

  Thrown when a query could not be solved

• $k.exception.RemoveNotPossible

  Thrown when it is not possible to remove a topic

• $k.exception.RuntimeError

  Represents a generic runtime error

• $k.exception.SchemaError

  Thrown when an attempt to modify the schema in an invalid way was made, or if the schema does not allow the operation

• $k.exception.SyncError

• $k.exception.TransactionError

  A transaction-related error

• $k.exception.TypeError

  Thrown when the type of an argument is not suitable

• $k.exception.XMLError

  An XML-related error

• $k.FlexDateTime

  Represents a flexible date/time without timezone that allowes certain degrees of imprecision.

  • coversDate(date)
    Returns true if the date is within the range of this flexible date
  • equals(value)
    Returns true if the values are equal
  • getDayNumber()
    Returns the number of the day, e.g. 18 for 2011-03-18
  • getHours()
    Returns the hours
  • getMinutes()
    Returns the minutes
  • getMonthNumber()
    Returns the number of the month. Unlike Date.prototype.month(), this is not the 0-based month index, so for January getMonthNumber() returns 1, not 0
  • getYear()
    Returns the full year
  • maxDate()
    Returns the latest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T23:59:59.999 for the date 2007-03-01. Assumes that this is date/time of the local timezone
  • maxUTCDate()
    Returns the latest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T23:59:59.999 for the date 2007-03-01. Assumes that this is date/time of the local timezone
  • minDate()
    Returns the earliest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T0:00:00.0 for the date 2007-03-01. Assumes that this is date/time of the local timezone
  • minUTCDate()
    Returns the earliest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T0:00:00.0 for the date 2007-03-01. Assumes that this is an UTC date/time
  • parse(string, language)
    Parse the date/time string. Both ISO 8601 adnd localized strings are supported.
  • setDayNumber(day)
    Sets the number of the day, e.g. 23 for 2012-05-23
  • setHours(hours)
    Sets the hours
  • setMinutes(minutes)
    Sets the minutes.
  • setMonthNumber(month)
    Set the number of the month. Unlike Date.prototype.month(), this is not the 0-based month index, so for January pass 1 to setMonthNumber() , not 0.
  • setValues(year, month, day, hours, minutes)
    Sets all components of the FlexDateTime
  • setYear(year)
    Sets the full year. The year is not modified, so setYear(99) sets the year 99, not 1999.
  • toDate()
    Returns the date/time as a Javascript date object. Assumes that this is date/time of the local timezone
  • toJSON(key)
    Returns a string representing the date/time, similar to Date.prototype.toJSON ( key )
  • toString(language)
    Returns the string representation. Equivalent to valueString()
  • toUTCDate()
    Returns the date/time as a Javascript date object. Assumes that this is an UTC date/time
  • valueString(language)
    Returns the string representation

• $k.FlexTime

  Represents a flexible date that allowes certain degrees of imprecision.A flextime attribute can restrict the degrees of imprecision.

  • coversDate(date)
    Returns true if the date is within the range of this flexible date
  • equals(value)
    Returns true if the values are equal
  • getDayNumber()
    Returns the number of the day, e.g. 18 for 2011-03-18
  • getHours()
    Returns the hours
  • getMinutes()
    Returns the minutes
  • getMonthNumber()
    Returns the number of the month. Unlike Date.prototype.month(), this is not the 0-based month index, so for January getMonthNumber() returns 1, not 0
  • getYear()
    Returns the full year
  • maxDate()
    Returns the latest exact date that is within the range of this flexible date, e.g. 2007-03-31 23:59:59 for the flexible date 2007-03
  • minDate()
    Returns the oldest exact date that is within the range of this flexible date, e.g. 2007-03-01 0:00:00 for the flexible date 2007-03
  • parse(string, language)
    Parse the date string. Use the parse() method of an attribute value range if possible, because it can check the allowed formats
  • setDayNumber(day)
    Sets the number of the day, e.g. 23 for 2012-05-23
  • setHours(hours)
    Sets the hours
  • setMinutes(minutes)
    Sets the minutes.
  • setMonthNumber(month)
    Set the number of the month. Unlike Date.prototype.month(), this is not the 0-based month index, so for January pass 1 to setMonthNumber() , not 0.
  • setValues(year, month, day, hours, minutes)
    Sets all components of the FlexTime
  • setYear(year)
    Sets the full year. The year is not modified, so setYear(99) sets the year 99, not 1999.
  • toString(language)
    Returns the string representation. Equivalent to valueString()
  • valueString(language)
    Returns the string representation

• $k.Folder

  A folder which can contain queries, topic collections and other folders

  • leafElements()
    Returns the elements which are not folders
  • subfolders()
    Returns the subfolders

• $k.FolderElement

  An element that can be added to a folder

  • id()
    Returns the registered ID, or undefined if not registered.
  • parentFolders()
    Returns the folders that contain this element
  • registryType()
    Returns the name of the registry that contains elements of this type

• $k.GeoPosition

  The value of a geo position attribute.

  • distance(position)
    Returns the distance to the other position, in meters
  • equals(value)
    Returns true if the values are equal
  • lat()
    Returns the latitude (north-south position) as degrees
  • long()
    Returns the longitude (east-west position) as degrees
  • setLat(latitude)
    Set the latitude (north-south position, in degrees)
  • setLong(longitude)
    Set the longitude (east-west position, in degrees)
  • toFormat(format)
    Returns the string representation in the specified format ('KML', 'UTM' etc.)

• $k.GeoRange

  Represents the value range of a geo position attribute

  • formats()
    Returns the names of the supported formats
  • parseFormat(string, format)
    Parse the geo position in the specified format and returns the converted value

• $k.Hit

  Provides details about a topic returned by a query.

  • addCause(cause)
    Add a cause
  • causeOfType(type)
    Returns the cause of this hit with the given type, or undefined if no or more than one cause exists
  • causes()
    Returns the causes of this hit
  • causesOfType(type)
    Returns the causes of this hit with the given type
  • element()
    The semantic element associated with this hit
  • quality()
    Returns the quality of the hit, a number between 0 (worst quality) and 1 (best quality)
  • setElement(semanticElement)
    Set the semantic element associated with this hit
  • setQuality(quality)
    Set the quality, a number between 0 and 1

• $k.HttpConnection

  A single connection to a HTTP server.

  • getResponse(request)
    Sends the requests and returns a reponse

    Only HTTP(S) requests are allowed. If the URI uses another protocol (e.g. 'file'), then an URIError is raised.

    It is possible to restrict the domains that can be accessed by adding the following to the configuration file of a client (bridge etc.):

    
    [script]
    allowedOutgoingDomains=*.intelligent-views.com,ivinternal:8080
    

• $k.HttpRequest

  A HTTP request

  • cookies()
    Returns the cookies as an object. The name of a property is the cookie name, the value a Cookie object
  • queryData()
    Returns the query data of the request as an object. If the request method is GET, then this is equivalent to urlQueryData(). For other methods it returns application/x-www-form-urlencoded key/value pairs
  • setQueryData(queryData)
    Sets the query data of the URI. Each property is added as a query parameter (key=value). If the value of a property is an arry, then a key=value pair is added for each array element.
  • setUrl(url)
    Sets the URL
  • url()
    Returns the full URL
  • urlQueryData()
    Returns the URL query data of the URI as an object. Each key=value pair is added as a property. If a key appears more than once, then the value is an array with all elements

• $k.HttpResponse

  A HTTP response

  • BAD_REQUEST
    Status code 400 Bad Request
  • INTERNAL_SERVER_ERROR
    Status code 500 Internal Server Error
  • NOT_FOUND
    Status code 404 Not Found
  • NOT_MODIFIED
    Status code 304 Not Modified
  • OK
    Status code 200 OK
  • UNAUTHORIZED
    Status code 401 Unauthorized
  • code()
    Returns the status code of the response
  • setCode(code)
    Set the status code of the response
  • setCodeBadRequest()
    Set the status code of the response to 400 (Bad request). Equivalent to setCode($k.HttpResponse.BAD_REQUEST)
  • setCodeNotFound()
    Set the status code of the response to 404 (Not found). Equivalent to setCode($k.HttpResponse.NOT_FOUND)
  • setCodeNotModified()
    Set the status code of the response to 304 (Not Modified). Equivalent to setCode($k.HttpResponse.NOT_MODIFIED)
  • setCodeOk()
    Set the status code of the response to 200 (Ok). Equivalent to setCode($k.HttpResponse.OK)
  • setCodeUnauthorized()
    Set the status code of the response to 401 (Unauthorized). Equivalent to setCode($k.HttpResponse.UNAUTHORIZED)
  • setCookie(cookie)
    Add the cookie to the response, instructing the client to set the cookie

• $k.Instance

  Represents an instance.

  • createExtension(type)
    Create an extension of the given type
  • extensions()
    Returns the extension instances
  • possibleExtensions()
    Returns all possible extension types

• $k.InstanceType

  Represents a type of instances

  • allInstances()
    Returns all instances of this type and all subtypes. Avoid using this function if possible, use queries instead
  • createInstance(param, language)
    Create a new instance of this type
  • createSubtype(param, language)
    Create a new subtype
  • extendedTypes()
    Returns the types that can be extended by this type or a subtype. Does not check if this type allows to create extensions
  • extensionTypes()
    Returns the types that can extend instances of this type. Does not check if these types allow to create extensions
  • instances()
    Returns all direct instances of this type. Avoid using this function if possible, use queries instead

• $k.Interval

  An interval representing all values between two endpoints.

  • equals(value)
    Returns true if the values are equal
  • setStart(start)
    Sets the lower endpoint. Pass undefined to denote an interval without lower endpoint
  • setStop(stop)
    Sets the upper endpoint. Pass undefined to denote an interval without upper endpoint
  • start()
    Returns the lower endpoint, or undefined if the interval has no lower endpoint.
  • stop()
    Returns the upper endpoint , or undefined if the interval has no upper endpoint.

• $k.IntervalRange

  Represents the value range of an interval attribute

  • endpointRange()
    Returns the value range of the interval endpoints

• $k.MailMessage

  • bcc()
    Get the blind carbon copy receivers ('bcc' field)
  • cc()
    Get the carbon copy receivers ('cc' field)
  • headerCharset()
    Get the charset of the headers
  • receiver()
    Get the receiver ('to' field)
  • send(async)
    Send the mail, using the SMTP configuration of the volume
  • sender()
    Get the sender
  • setBcc(receivers)
    Set the blind carbon copy receivers ('bcc' field)
  • setCc(receivers)
    Set the carbon copy receivers ('cc' field)
  • setHeaderCharset(charset)
    Set the charset of the headers
  • setReceiver(receivers)
    Set the receiver ('to' field)
  • setSender(sender)
    Set the sender ('from' field)
  • setSubject(subject)
    Set the subject
  • setUserName(username)
    Set the name of the user account. Required if the SMTP configuration requires authentication and more than one user is configured
  • subject()
    Get the subject
  • userName()
    Get the name of the user account

• $k.NetEntity

  Abstract superclass of entities that are sent or received over the internet

  • attach(attachment)
    Attach a entity
  • attachments()
    Returns the attached entities
  • base64String()
    Get the binay contents as base64-encoded string. Returns undefined if the contents is not binary
  • charset()
    Returns the charset
  • contentDisposition()
    Returns the content disposition
  • contentLength()
    Returns the content length
  • contentType()
    Returns the content type (only the media type part)
  • dataUrl()
    Returns the entity bytes as a data URL, or undefined if the entity is not binary
  • debugString()
    Prints the entity, except binary contents, for debugging purposes
  • filename()
    Returns the filename part of the content disposition field
  • formData()
    Get all form fields (multipart/form-data or application/x-www-form-urlencoded). The property names correspond to the field names. The property values are either strings (if the form is of type application/x-www-form-urlencoded) or NetEntities (multipart/form-data)
  • headerField(fieldName)
    Get the unparsed value of the field of the request header. Returns undefined if the field does not exist
  • headerFields()
    Get all fields of the request header
  • isBinary()
    True if the entity has binary contents
  • setCharset(charset)
    Set the charset
  • setContentDisposition(contentDisposition)
    Set the content disposition
  • setContentLength(length)
    Set the content length
  • setContents(contents)
    Set the contents of the entity. Also sets the content type and filename if known. The contents object can be a string, document ($k.TextDocument), a blob value ($k.Blob) or another NetEntity
  • setContentType(mediaType, charset)
    Set the content type
  • setFilename(filename)
    Set the filename part of the content disposition field
  • setHeaderField(fieldName, fieldValue)
    Set the value of the field of the request header
  • setText(text)
    Set the text as the body
  • text(charset)
    Get the contents as string

• $k.NewCookie

  Represents a new HTTP Cookie (RFC 2109) that can be added to a response

  • comment()
    Returns the comment of the cookie
  • domain()
    Returns the domain of the cookie
  • expiry()
    Returns the expiry date of the cookie
  • httpOnly()
    Returns true if the cookie contains the HttpOnly attribute
  • maxAge()
    Returns the maximum age of the the cookie in seconds
  • path()
    Returns the path of the cookie
  • port()
    Returns the port of the cookie
  • secureOnly()
    Returns true if the cookie will only be sent over a secure connection
  • setComment(comment)
    Sets the comment of the cookie
  • setDomain(domain)
    Sets the domain of the cookie
  • setExpiry(expiryDate)
    Sets the expiry date of the cookie
  • setHttpOnly(httpOnly)
    Set the HttpOnly attribute
  • setMaxAge(maxAge)
    Sets the maximum age of the the cookie in seconds
  • setPath(path)
    Sets the path of the cookie
  • setPort(port)
    Sets the port of the cookie
  • setSecureOnly(secureOnly)
    Set if the cookie will only be sent over a secure connection
  • setVersion(version)
    Sets the version of the cookie
  • version()
    Returns the version of the cookie

• $k.PersistentCollection

  Abstract persistent collection of elements.

  • elements()
    Returns the elements of of the collection
  • name()
    Returns the name

• $k.Property

  Represents a property.

  • source()
    Returns the semantic element that has this property

• $k.PropertyFilter

  Filters the possible properties of an element or domain.

  • includeAbstract()
    Returns true if abstract properties should be returned. Default is false.
  • includeAttributes()
    Returns true if attributes should be returned
  • includeOneWay()
    Returns true if inverse one way relations should be returned. Default is false.
  • includeShortcutRelations()
    Returns true if shortcut relations should be returned. Default is false.
  • includeSystemRelations()
    Returns true if system relations should be returned. Default is false.
  • includeUserRelations()
    Returns true if user relations should be returned
  • isExact()
    Returns true if only properties of the specified type should be returned, false if also sub-properties should be included. Default is false.
  • possiblePropertiesOf(object)
    Returns the possible properties of the semantic element / domain
  • propertiesOf(semanticElement)
    Returns the properties of the semantic element
  • setAbstract(abstract)
    Defines if abstract properties are returned.
  • setAttributes(isExact)
    Defines if attributes should be returned. Default is true
  • setExact(exact)
    Defines if only properties of the specified type should be returned, or also sub-properties.
  • setOneWayRelations(oneWayRelations)
    Defines if inverse one way relations should be returned.
  • setShortcutRelations(shortcutRelations)
    Defines if shortcut relations should be returned.
  • setSystemRelations(systemRelations)
    Defines if shortcut relations should be returned.
  • setType(type)
    Defines the type / internal name of the properties
  • setUnconstrained(additionalOnly)
    Defines if properties should be returned that cannot be created due to cardinality constrains. This setting only has an effect when quering the possible properties of a semantic element, not of a domain
  • setUserRelations(isExact)
    Defines if user relations should be returned. Default is true
  • toPropertyFilter()
    Returns this filter. To define custom property filters, define an object with a function toPropertyFilter(). If toPropertyFilter() does not return an object of kind $k.PropertyFilter, the object has to define the functions propertiesOf() and possiblePropertiesOf()
  • type()
    Returns the type / internal name that should be used for filtering properties
  • unconstrained()
    Returns true if properties should be returned that cannot be created due to cardinality constrains. This setting only has an effect when quering the possible properties of a semantic element, not of a domain. Default is false

• $k.PropertyType

  Represents a type of properties

  • allowsMultipleOccurrences()
    Returns true if multiple occurrences per semantic element are possible
  • definedDomains()
    Returns the defined domains of the property.
  • domains()
    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.

• $k.Query

  Represents a query

  • definedParameters()
    Returns the parameters of the query
  • explainElements(elements, parameters)
    Returns all elements involved in the query
  • filterElements(elements, parameters, searchString)
    Returns all elements that match the query
  • findElements(parameters, searchString)
    Search and return all found semantic elements
  • findHits(parameters, searchString)
    Search and return all found hits.
  • name()
    Returns the name
  • searchString()
    Returns the search string
  • setDomains(domains)
    Restrict the query results to objects/types of the domains
  • setParameter(parameterId, value)
    Set a parameter of the query.
  • setParameters(parameters)
    Set the parameters of the query from the properties of the object
  • setSearchString(searchString)
    Set the string to search for

• $k.QueryParameter

  Parameter of a query

  • domains()
    Returns the domains
  • name()
    Returns the name
  • type()
    Returns the type of the parameter

• $k.Registry

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

  • elementAtValue(internalName, value, language)
    Returns the semantic element with an attribute with the specified value, or undefined if there is either no such attribute or more than one
  • elementWithID(id)
    Get the semantic element with the element ID
  • folder(folderID)
    Get the registered folder
  • query(queryID)
    Get the registered query
  • registeredFolders()
    Returns all registered folders
  • registeredObject(registryType, objectID)
    Get the registered folder element with the ID from the registry
  • registeredQueries()
    Returns all registered queries
  • registeredSemanticCollections()
    Returns all registered semantic collections
  • semanticCollection(collectionID)
    Get the registered semantic collection
  • type(type)
    Gets the type with the internal name

• $k.Relation

  Represents a relation.

  • inverseRelation()
    Returns the inverse relation
  • target()
    Returns the relation target

• $k.RelationType

  Represents a type of relations

  • inverseRelationType()
    Returns the inverse relation type
  • isMainDirection()
    Returns true if this is the main direction for the relation type.
  • isSingleSided()
    Returns true if this is a single sided relation type (i.e. only the main direction of the relation is stored in the volume).
  • isSymmetric()
    Returns true if this is a symmetric relation.
  • ranges()
    Returns the possible ranges of the relation, which are the domains of the inverse relation

• $k.ScriptDocument

  Represents the output text document of a legacy KScript

  • cr()
    Print a CR
  • print(object)
    Print the object on the script document
  • println(object)
    Print the object on the script document and adds a line break
  • tab()
    Print a tab
  • text()
    Get the contents as string
  • xmlWriter()
    Returns an XML writer that writes on this document

• $k.SemanticCollection

  A collection of topics

  • elements()
    Returns the elements of of the collection

• $k.SemanticElement

  Represents an element of the semantic network.

  • attribute(type)
    Returns the attribute of the type (including sub-attributes), or undefined if no attribute exists
  • attributes(type)
    Returns all attributes of the type (including sub-attributes). Returns all attributes if the type is undefined
  • attributeValue(type, language)
    Returns the value of the attribute, or undefined if there is no such attribute
  • callBehaviour(method, args)
    Calls an internal behavior method
  • core()
    Returns the extended element, if this is an extension. Returns the element itself otherwise
  • createAttribute(type, value, language)
    Creates a new attribute with the given value
  • createAttributeFromString(type, valueString, language)
    Creates a new attribute and set the value from the string representation
  • createRelation(type, target, inverse)
    Creates a new relation
  • hasPossibleAttribute(type)
    Returns true if the type is a possible attribute of this element
  • hasPossibleRelation(type)
    Returns true if the type is a possible relation of this element
  • idNumber()
    Returns the element ID as 64 bit integer. Returns undefined for non-persistent topics (system relations etc.)
  • idString()
    Returns the element ID as string, e.g. 'ID123_456'. Returns undefined for non-persistent topics (system relations etc.)
  • inheritedAttribute(type)
    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().
  • inheritedAttributeValue(type, language)
    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).
  • modificationNumber()
    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.
  • name(language)
    Returns the name of the element
  • possibleProperties(filter)
    Returns the possible properties of this element.
  • properties(filter)
    Returns all properties of the property type
  • relation(type)
    Returns the relation of the type (including sub-relations), or undefined if no relation exists
  • relations(type)
    Returns all relations of the type (including sub-relations). If type is undefined, all user relations (excluding inverse one way relations) are returned.
  • relationTarget(type)
    Returns the target of the relation of the relation type, or undefined if there is no such relation
  • relationTargets(type)
    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
  • remove()
    Deletes the element and all attached properties
  • render(context, keyFilter)
    Renders the element as a literal object using the associated view configuration. Uses the optional context topic to detect a suitable configuration
  • renderJSON(context, excludedKeys)
    Render the element as a JavaScript object using the associated view configuration. Uses the optional context topic to detect a suitable configuration
  • selfDestruct()
    für Test für Bug 2638
  • setAttributeFromString(type, valueString, language)
    Sets the value of the attribute from the string representation. Creates a new attribute if no such attribute exists
  • setAttributeValue(type, value, language)
    Sets the value of the attribute. Creates a new attribute if no such attribute exists
  • setName(name, language)
    Sets the name of the element
  • type()
    Returns the type of the element. If the topic is a type, the type itself is returned

• $k.StringValue

  An attribute value string that has not been parsed.

  • equals(value)
    Returns true if the values are equal

• $k.TableConfiguration

  Configuration of a table

  • columns()
    Returns the columns of the table
  • filter(elements, filterDescriptions, disableInheritance)
    Filters the elements by the given column values
  • forDomain(domain, context)
    Returns the table confguration for the domain and the optional context)
  • from(configurationElement)
    Returns the confguration defined by the element
  • render(elements, keyFilter)
    Renders the elements as literal objects
  • renderJSON(elements, excludedKeys)
    Render the elements as a JSON object
  • search(domain, filterDescriptions, disableInheritance)
    Find the elements by the given column values
  • sort(semanticElements, sortDescriptions)
    Returns the elements sorted by the given columns and sort orders
  • sortDescriptions()
    Returns the configured sort descriptions of the table

• $k.TextDocument

  Represents a text document

  • cr()
    Print a CR
  • print(object)
    Print the object on the script document
  • println(object)
    Print the object on the script document and adds a line break
  • tab()
    Print a tab
  • text()
    Get the contents as string
  • xmlWriter()
    Returns an XML writer that writes on this document

• $k.Time

  Represents a time without timezone

  • equals(value)
    Returns true if the values are equal
  • getHours()
    Returns the hours
  • getMinutes()
    Returns the minutes
  • getSeconds()
    Returns the seconds
  • maxDate()
    Returns the latest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T23:59:59.999 for the date 2007-03-01. Assumes that this is date/time of the local timezone
  • maxUTCDate()
    Returns the latest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T23:59:59.999 for the date 2007-03-01. Assumes that this is date/time of the local timezone
  • minDate()
    Returns the earliest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T0:00:00.0 for the date 2007-03-01. Assumes that this is date/time of the local timezone
  • minUTCDate()
    Returns the earliest exact Javascript date that is within the range of this date/time, e.g. 2007-03-01T0:00:00.0 for the date 2007-03-01. Assumes that this is an UTC date/time
  • parse(string, language)
    Parse the date/time string. Both ISO 8601 adnd localized strings are supported.
  • setHours(hours)
    Sets the hours
  • setMinutes(minutes)
    Sets the minutes.
  • setSeconds(seconds)
    Sets the seconds.
  • toDate()
    Returns the date/time as a Javascript date object. Assumes that this is date/time of the local timezone
  • toJSON(key)
    Returns a string representing the date/time, similar to Date.prototype.toJSON ( key )
  • toString(language)
    Returns the string representation. Equivalent to valueString()
  • toUTCDate()
    Returns the date/time as a Javascript date object. Assumes that this is an UTC date/time
  • valueString(language)
    Returns the string representation

• $k.Type

  Represents a type

  • addSupertype(type)
    Add a supertype
  • allSubtypes()
    Returns all subtypes
  • allSupertypes()
    Returns all supertypes
  • canCreateExtensions()
    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.
  • canCreateInstances()
    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.
  • domain()
    Returns the domain of the instances of this type
  • estimatedNumberOfInstances()
    Returns the estimated number of instances of this type
  • getCounter()
    Returns the value of the counter associated with this type.
  • increaseCounter()
    Increases and returns the value of the counter associated with this type. The counter can be increased concurrently.
  • internalName()
    Returns the internal name
  • isAbstract()
    Returns true if this is an abstract type (cannot create properties/instances/extensions). isAbstract() is true if neither canCreateExtensions() nor canCreateInstances() is true.
  • isKindOf(type)
    Returns true if this is equal to or a direct or indirect type of the other type
  • numberOfInstances()
    Returns the exact number of instances of this type
  • removeSupertype(supertype)
    Remove a supertype
  • 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.
  • 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.
  • setCounter(counterValue)
    Set the initial value of the counter associated with this type. Note: this cannot be done concurrently. Use increaseCounter() instead.
  • setInternalName(name)
    Sets the internal name, or removes the internal name if null is passed
  • subtypes()
    Returns the direct subtypes
  • supertypes()
    Returns the direct supertypes
  • typeDomain()
    Returns the domain that represents this type and its subtype

• $k.UI

  Provides UI interaction in action scripts

  • alert(message, windowTitle)
    Show a notification dialog
  • choose(objects, message, windowTitle, stringFunction)
    Let the user choose an object from a list
  • confirm(message, windowTitle)
    Show a confirmation dialog
  • openEditor(topic)
    Opens an editor on the element
  • requestString(message, windowTitle)
    Let the user enter a string in a single-line input field

• $k.User

  Represents a user.

  • instance()
    Returns the instance associated with the user
  • name()
    Returns the name of the user

• $k.ValueRange

  Represents the value range of an attribute type

  • parse(string, language)
    Parse the string representation and returns the converted value
  • valueToString(value, language)
    Returns the string representation of the value
  • valueType()
    Returns a string describing the value type.

    One of

    • blob
    • boolean
    • choice
    • color
    • container
    • date
    • dateAndTime
    • flexTime
    • float
    • geoPosition
    • integer
    • interval
    • password
    • registyEntry
    • string
    • time
    • translatedAttribute
    • translation
    • url

• $k.ValueString

  An attribute value string that has not been parsed.

  • equals(value)
    Returns true if the values are equal
  • setValueString(string)
    Sets the string representation
  • valueString()
    Returns the string representation

• $k.ViewConfiguration

  Configuration of a topic editor

  • forElement(semanticElement, context)
    Returns the configuration for the semantic element
  • from(configurationElement)
    Returns the confguration defined by the element
  • render(semanticElement, keyFilter)
    Render the element as a literal object
  • renderJSON(semanticElement, excludeKeys)
    Render the element as a JavaScript object
  • synchronize(object)
    Update the semantic element from the JSON string / literal object
  • synchronizeJSON(jsonObject)
    Update the semantic element from the JSON string / literal object

• $k.XMLWriter

  SAX interface for writing XML.

  • attribute(localName, value, prefix)
    Writes an attribute of a tag to the document
  • cdata(characters)
    Writes a CDATA section to the document
  • characters(characters)
    Writes a string to the document
  • comment(comment)
    Writes a comment to the document
  • defaultNamespace(namespace)
    Write the default namespace of the current tag and its children
  • endElement()
    Closes the currently opened tag
  • print(characters)
    Writes a string to the document without any escaping
  • processingInstruction(target, data)
    Writes a processing instruction to the document
  • setIndent(enableIndentation)
    Enable/disable automatic indentation of the XML tags. Default is true
  • setPrefix(prefix, namespace)
    Sets the prefix the uri is bound to
  • startElement(localName, prefix)
    Writes a start tag to the document

• _global_