Class %iKnow.Utils.MaintenanceQAPI

class %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.

This class was generated by %iKnow.Utils.MaintenanceAPI.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
		23	4

Summary

Methods
%%OIDGet	%AddToSaveSet	%ClassIsLatestVersion
%ClassName	%ConstructClone	%DispatchClassMethod
%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%Extends	%GetParameter	%IsA
%IsModified	%New	%NormalizeObject
%ObjectModified	%OriginalNamespace	%PackageName
%RemoveFromSaveSet	%SerializeObject	%SetModified
%ValidateObject	AddEntityToBlackList	AddStringToBlackList
BlacklistContainsElement	CreateBlackList	DropBlackList
GetBlackListElementsClose	GetBlackListElementsExecute	GetBlackListElementsFetch
GetBlackListId	GetBlackListsClose	GetBlackListsExecute
GetBlackListsFetch	GetUserDictionariesClose	GetUserDictionariesExecute
GetUserDictionariesFetch	GetUserDictionaryEntriesClose	GetUserDictionaryEntriesExecute
GetUserDictionaryEntriesFetch	RemoveEntityFromBlackList	RemoveStringFromBlackList

Methods

• classmethod AddEntityToBlackList(domainId As %Integer, blackListId As %Integer, entUniId As %Integer) as %Boolean [ SQLProc ]

Adds an existing entity (by ID) to a BlackList

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

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

• classmethod BlacklistContainsElement(domainId As %Integer, blackListId As %Integer, entUniId As %Integer) as %Library.Integer [ SQLProc ]

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

Create a new BlackList entry with the given name and description

• classmethod DropBlackList(domainId As %Integer, blackListId As %Integer) as %Boolean [ SQLProc ]

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

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

Finds the BlackList ID corresponding to the supplied name.

• classmethod RemoveEntityFromBlackList(domainId As %Integer, blackListId As %Integer, entUniId As %Integer) as %Boolean [ SQLProc ]

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

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

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

Queries

• query GetBlackListElements(domainId As %Integer, blackListId As %Integer)

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

Retrieves a list of all the strings in the specified BlackList

• query GetBlackLists(domainId As %Integer)

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

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

• query 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.

• query 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.


[BASEXML] > [%iKnow] > [Utils] > [MaintenanceQAPI]		Private Storage