MaintenanceQAPI Class Reference

Inheritance diagram for MaintenanceQAPI:

Collaboration diagram for MaintenanceQAPI:

Static Public Member Functions
_.Library.Boolean	AddEntityToSkipList (_.Library.Integer domainId, _.Library.Integer skipListId, _.Library.Integer entUniId)
	Adds an existing entity (by ID) to a SkipList. More...
_.Library.Boolean	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.Boolean	AddUserDictionaryEntry (_.Library.Integer userDictId, _.Library.String rewriteFrom, _.Library.String rewriteTo, _.Library.Integer position)
_.Library.Boolean	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.String scText)
_.Library.Integer	CreateUserDictionary (_.Library.String name, _.Library.String description, _.Library.String scText)
_.Library.Boolean	DropSkipList (_.Library.Integer domainId, _.Library.Integer skipListId)
	Drops a SkipList (entities part of the list will not be deleted from the domain)
_.Library.Boolean	DropUserDictionary (_.Library.Integer userDictId)
	This method drops the User Dictionary identified by the supplied userDictId,. More...
_.Library.Integer	GetSkipListId (_.Library.Integer domainId, _.Library.String name, _.Library.String scText)
	Finds the SkipList ID corresponding to the supplied name.
_.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.Boolean	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.Boolean	RemoveStringFromSkipList (_.Library.Integer domainId, _.Library.Integer skipListId, _.Library.String string)
	Removes a string from a SkipList (but not from the domain)
_.Library.Boolean	RemoveUserDictionaryEntry (_.Library.Integer userDictId, _.Library.Integer position)
_.Library.Boolean	SkipListContainsElement (_.Library.Integer domainId, _.Library.Integer skipListId, _.Library.Integer entUniId, _.Library.String scText)
	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.String scText)
	Returns whether or not the SkipList identified by skipListId contains the. More...

Detailed Description

This is an automatically generated class, offering a functionally equivalent set of methods and queries as <class>iKnow.Utils.MaintenanceAPI</class>, exposed as SqlProc methods.

See the classdocs for <class>iKnow.Utils.MaintenanceAPI</class> for more information.

Member Function Documentation

AddEntityToSkipList()

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

static

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

This is an automatically generated class, offering a functionally equivalent set of methods and queries as <class>iKnow.Utils.MaintenanceAPI</class>, exposed as SqlProc methods.

See the classdocs for <class>iKnow.Utils.MaintenanceAPI</class> for more information.

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

AddUserDictionaryEntry()

_.Library.Boolean 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.String  scText  )

static

Create a new SkipList with the given name and description

CreateUserDictionary()

_.Library.Integer CreateUserDictionary ( _.Library.String  name, _.Library.String  description, _.Library.String  scText  )

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.Boolean 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>

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.Boolean 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.Boolean 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.String  scText  )

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.String  scText  )

static

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

supplied entity.