Class %iKnow.Utils.MaintenanceQAPI

deprecatedclass %iKnow.Utils.MaintenanceQAPI extends %iKnow.Queries.AbstractQAPI

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

See the classdocs for %iKnow.Utils.MaintenanceAPI for more information.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
		28	4

Summary

Methods
%AddToSaveSet	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends
%GetParameter	%IsA	%IsModified	%New
%NormalizeObject	%ObjectModified	%OriginalNamespace	%PackageName
%RemoveFromSaveSet	%SerializeObject	%SetModified	%ValidateObject
AddEntityToSkipList	AddStringToSkipList	AddUserDictionaryEntry	ClearSkipList
CreateSkipList	CreateUserDictionary	DropSkipList	DropUserDictionary
GetSkipListId	GetUserDictionaryId	HasSkipLists	RemoveEntityFromSkipList
RemoveStringFromSkipList	RemoveUserDictionaryEntry	SkipListContainsElement	SkipListContainsString

Methods

• classmethod AddEntityToSkipList(domainId As %Integer, skipListId As %Integer, entUniId As %Integer) as %Boolean [ SQLProc = ]

Adds an existing entity (by ID) to a SkipList. For cross-domain SkipLists, use AddStringToSkipList

• classmethod AddStringToSkipList(domainId As %Integer, skipListId As %Integer, string As %String(MAXLEN=32767)) as %Boolean [ SQLProc = ]

Adds a string to a SkipList, adding it as an entity if it didn't exist in the domain before.

• classmethod AddUserDictionaryEntry(userDictId As %Integer, rewriteFrom As %String(MAXLEN=32767), rewriteTo As %String(MAXLEN=32767), ByRef position As %Integer = 0) as %Boolean [ SQLProc = ]

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 %iKnow.UserDictionary

• classmethod ClearSkipList(pDomainId As %Integer, pSkipListId As %Integer) as %Boolean [ SQLProc = ]

Clears the contents of a single SkipList.

• classmethod CreateSkipList(domainId As %Integer, name As %String(MAXLEN=32767), description As %String(MAXLEN=32767)="", Output scText As %String = "") as %Library.Integer [ SQLProc = ]

Create a new SkipList with the given name and description

• classmethod CreateUserDictionary(name As %String(MAXLEN=32767), description As %String(MAXLEN=32767)="", Output scText As %String = "") as %Library.Integer [ SQLProc = ]

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 %iKnow.UserDictionary

• classmethod DropSkipList(domainId As %Integer, skipListId As %Integer) as %Boolean [ SQLProc = ]

Drops a SkipList (entities part of the list will not be deleted from the domain)

• classmethod DropUserDictionary(userDictId As %Integer) as %Boolean [ SQLProc = ]

This method drops the User Dictionary identified by the supplied userDictId, including all its entries.
Deprecated: please use %DeleteId() in %iKnow.UserDictionary

• classmethod GetSkipListId(domainId As %Integer, name As %String(MAXLEN=32767), Output scText As %String = "") as %Library.Integer [ SQLProc = ]

Finds the SkipList ID corresponding to the supplied name.

• classmethod GetUserDictionaryId(name As %String(MAXLEN=32767)) as %Library.Integer [ SQLProc = ]

Returns the ID corresponding to the supplied User Dictionary name.
Deprecated: please use NameIndexOpen() %iKnow.UserDictionary

• classmethod HasSkipLists(pDomainId As %Integer) as %Library.Boolean [ SQLProc = ]

Returns whether or not there are any SkipLists in the domain

• classmethod RemoveEntityFromSkipList(domainId As %Integer, skipListId As %Integer, entUniId As %Integer) as %Boolean [ SQLProc = ]

Removes an entity (by ID) from a SkipList (but not from the domain) For cross-domain SkipLists, use RemoveStringFromSkipList

• classmethod RemoveStringFromSkipList(domainId As %Integer, skipListId As %Integer, string As %String(MAXLEN=32767)) as %Boolean [ SQLProc = ]

Removes a string from a SkipList (but not from the domain)

• classmethod RemoveUserDictionaryEntry(userDictId As %Integer, position As %Integer) as %Boolean [ SQLProc = ]

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 %iKnow.UserDictionary

• classmethod SkipListContainsElement(domainId As %Integer, skipListId As %Integer, entUniId As %Integer, Output scText As %String = "") as %Library.Boolean [ SQLProc = ]

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

• classmethod SkipListContainsString(domainId As %Integer, skipListId As %Integer, entity As %String(MAXLEN=32767), Output scText As %String = "") as %Library.Boolean [ SQLProc = ]

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

Queries

• query GetSkipListElements(domainId As %Integer, skipListId As %Integer)

Selects entUniId As %Integer, entity As %String(MAXLEN=32767)

Retrieves a list of all the strings in the specified SkipList

• query GetSkipLists(domainId As %Integer, pIncludeCrossDomain As %Boolean = 0)

Selects skipListId As %Integer, name As %String(MAXLEN=32767), description As %String(MAXLEN=32767)

Retrieves a list of all the SkipLists registered in this domain.

• deprecatedquery GetUserDictionaries()

Selects userDictId As %Integer, name As %String(MAXLEN=32767), description As %String(MAXLEN=32767)

Returns a list of all the User Dictionaries in this namespace.
Deprecated: please use %iKnow.UserDictionary

• deprecatedquery GetUserDictionaryEntries(userDictId As %Integer)

Selects position As %Integer, rewriteFrom As %String(MAXLEN=32767), rewriteTo As %String(MAXLEN=32767)

Returns the contents of a User Dictionary.

Deprecated: please use GetEntries() in %iKnow.UserDictionary

Class Reference IRIS for UNIX 2024.1.2
Documentation Search