Inheritance diagram for MaintenanceAPI:

Collaboration diagram for MaintenanceAPI:

Static Public Member Functions
_.Library.Status	AddEntityToSkipList (_.Library.Integer domainId, _.Library.Integer skipListId, _.Library.Integer entUniId)
	Adds an existing entity (by ID) to a SkipList. More...

_.Library.Status	AddStringToSkipList (_.Library.Integer domainId, _.Library.Integer skipListId, _.Library.String string)
	Adds a string to a SkipList, adding it as an entity if it didn't exist in the domain before.

_.Library.Status	AddUserDictionaryEntry (_.Library.Integer userDictId, _.Library.String rewriteFrom, _.Library.String rewriteTo, _.Library.Integer position)

_.Library.Status	ClearSkipList (_.Library.Integer pDomainId, _.Library.Integer pSkipListId)
	Clears the contents of a single SkipList.

_.Library.Integer	CreateSkipList (_.Library.Integer domainId, _.Library.String name, _.Library.String description, _.Library.Status sc)

_.Library.Integer	CreateUserDictionary (_.Library.String name, _.Library.String description, _.Library.Status sc)

_.Library.Status	DropSkipList (_.Library.Integer domainId, _.Library.Integer skipListId)
	Drops a SkipList (entities part of the list will not be deleted from the domain)

_.Library.Status	DropUserDictionary (_.Library.Integer userDictId)
	This method drops the User Dictionary identified by the supplied userDictId,. More...

_.Library.Status	GetSkipListElements (result, _.Library.Integer domainId, _.Library.Integer skipListId)
	Retrieves a list of all the strings in the specified SkipList.

_.Library.Integer	GetSkipListId (_.Library.Integer domainId, _.Library.String name, _.Library.Status sc)
	Finds the SkipList ID corresponding to the supplied name.

_.Library.Status	GetSkipLists (result, _.Library.Integer domainId, _.Library.Boolean pIncludeCrossDomain)
	Retrieves a list of all the SkipLists registered in this domain.

_.Library.Status	GetUserDictionaries (result)
	Returns a list of all the User Dictionaries in this namespace. More...

_.Library.Status	GetUserDictionaryEntries (result, _.Library.Integer userDictId)

_.Library.Integer	GetUserDictionaryId (_.Library.String name)
	Returns the ID corresponding to the supplied User Dictionary name. More...

_.Library.Boolean	HasSkipLists (_.Library.Integer pDomainId)
	Returns whether or not there are any SkipLists in the domain.

_.Library.Status	RemoveEntityFromSkipList (_.Library.Integer domainId, _.Library.Integer skipListId, _.Library.Integer entUniId)
	Removes an entity (by ID) from a SkipList (but not from the domain) More...

_.Library.Status	RemoveStringFromSkipList (_.Library.Integer domainId, _.Library.Integer skipListId, _.Library.String string)
	Removes a string from a SkipList (but not from the domain)

_.Library.Status	RemoveUserDictionaryEntry (_.Library.Integer userDictId, _.Library.Integer position)

_.Library.Boolean	SkipListContainsElement (_.Library.Integer domainId, _.Library.Integer skipListId, _.Library.Integer entUniId, _.Library.Status pSC)
	Returns whether or not the SkipList identified by skipListId contains the. More...

_.Library.Boolean	SkipListContainsString (_.Library.Integer domainId, _.Library.Integer skipListId, _.Library.String entity, _.Library.Status pSC)
	Returns whether or not the SkipList identified by skipListId contains the. More...

Static Public Attributes
	GetSkipListElementsRT = None

Detailed Description

This API groups a number of utility and maintenance operations and queries.

Member Function Documentation

◆ AddEntityToSkipList()

_.Library.Status AddEntityToSkipList	(	_.Library.Integer	domainId,
		_.Library.Integer	skipListId,
		_.Library.Integer	entUniId
	)

static

Adds an existing entity (by ID) to a SkipList.

For cross-domain SkipLists, use <method>AddStringToSkipList</method>

◆ AddUserDictionaryEntry()

_.Library.Status AddUserDictionaryEntry	(	_.Library.Integer	userDictId,
		_.Library.String	rewriteFrom,
		_.Library.String	rewriteTo,
		_.Library.Integer	position
	)

static

Adds a single entry to a User Dictionary at position. If position <= 0 (default),

it is added at the bottom of the list, otherwise at the requested position, shifting existing entries down if it was already taken.

Deprecated: please use AddEntry() in <class>iKnow.UserDictionary</class>

◆ CreateSkipList()

_.Library.Integer CreateSkipList	(	_.Library.Integer	domainId,
		_.Library.String	name,
		_.Library.String	description,
		_.Library.Status	sc
	)

static

Create a new SkipList with the given name and description

◆ CreateUserDictionary()

_.Library.Integer CreateUserDictionary	(	_.Library.String	name,
		_.Library.String	description,
		_.Library.Status	sc
	)

static

This method creates a User Dictionary with a given name and optional description and

returns the created user dictionary ID afterwards. This method will return -1 if an error occurred, which is passed by reference as sc.

Deprecated: please use New() in <class>iKnow.UserDictionary</class>

◆ DropUserDictionary()

_.Library.Status DropUserDictionary ( _.Library.Integer userDictId )

static

This method drops the User Dictionary identified by the supplied userDictId,.

including all its entries.

Deprecated: please use DeleteId() in <class>iKnow.UserDictionary</class>

◆ GetUserDictionaries()

_.Library.Status GetUserDictionaries ( result )

static

Returns a list of all the User Dictionaries in this namespace.

Deprecated: please use <class>iKnow.UserDictionary</class>

◆ GetUserDictionaryEntries()

_.Library.Status GetUserDictionaryEntries	(		result,
		_.Library.Integer	userDictId
	)

static

Returns the contents of a User Dictionary.

Deprecated: please use GetEntries() in <class>iKnow.UserDictionary</class>

◆ GetUserDictionaryId()

_.Library.Integer GetUserDictionaryId ( _.Library.String name )

static

Returns the ID corresponding to the supplied User Dictionary name.

Deprecated: please use NameIndexOpen() <class>iKnow.UserDictionary</class>

◆ RemoveEntityFromSkipList()

_.Library.Status RemoveEntityFromSkipList	(	_.Library.Integer	domainId,
		_.Library.Integer	skipListId,
		_.Library.Integer	entUniId
	)

static

Removes an entity (by ID) from a SkipList (but not from the domain)

For cross-domain SkipLists, use <method>RemoveStringFromSkipList</method>

◆ RemoveUserDictionaryEntry()

_.Library.Status RemoveUserDictionaryEntry	(	_.Library.Integer	userDictId,
		_.Library.Integer	position
	)

static

Removes the User Dictionary entry registered at position. This method will

not impact the order or position of any remaning entries.

Deprecated: please use RemoveEntry() in <class>iKnow.UserDictionary</class>

◆ SkipListContainsElement()

_.Library.Boolean SkipListContainsElement	(	_.Library.Integer	domainId,
		_.Library.Integer	skipListId,
		_.Library.Integer	entUniId,
		_.Library.Status	pSC
	)

static

Returns whether or not the SkipList identified by skipListId contains the.

supplied entity.

◆ SkipListContainsString()

_.Library.Boolean SkipListContainsString	(	_.Library.Integer	domainId,
		_.Library.Integer	skipListId,
		_.Library.String	entity,
		_.Library.Status	pSC
	)

static

Returns whether or not the SkipList identified by skipListId contains the.

supplied entity.

Member Data Documentation

◆ GetSkipListElementsRT

GetSkipListElementsRT = None

static

This API groups a number of utility and maintenance operations and queries.

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ AddEntityToSkipList()

◆ AddUserDictionaryEntry()

◆ CreateSkipList()

◆ CreateUserDictionary()

◆ DropUserDictionary()

◆ GetUserDictionaries()

◆ GetUserDictionaryEntries()

◆ GetUserDictionaryId()

◆ RemoveEntityFromSkipList()

◆ RemoveUserDictionaryEntry()

◆ SkipListContainsElement()

◆ SkipListContainsString()

Member Data Documentation

◆ GetSkipListElementsRT