Home > Class Reference > %SYS namespace > %iKnow.Utils.MaintenanceAPI

%iKnow.Utils.MaintenanceAPI

class %iKnow.Utils.MaintenanceAPI extends %iKnow.Queries.AbstractAPI

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

Method Inventory (Including Private)

Parameters

parameter GetBlackListElementsRT = entUniId:%Integer,entity:%String;
parameter GetBlackListsRT = blackListId:%Integer,name:%String,description:%String;
parameter GetUserDictionariesRT = userDictId:%Integer,name:%String,description:%String;
parameter GetUserDictionaryEntriesRT = position:%Integer,rewriteFrom:%String,rewriteTo:%String;

Methods (Including Private)

classmethod AddEntityToBlackList(domainId As %Integer, blackListId As %Integer, entUniId As %Integer) as %Status [ Language = objectscript ]
Adds an existing entity (by ID) to a BlackList. For cross-domain blacklists, use AddStringToBlackList()
classmethod AddStringToBlackList(domainId As %Integer, blackListId As %Integer, string As %String) as %Status [ Language = objectscript ]
Adds a string to a BlackList, adding it as an entity if it didn't exist in the domain before.
classmethod AddUserDictionaryEntry(userDictId As %Integer, rewriteFrom As %String, rewriteTo As %String, ByRef position As %Integer = 0) as %Status [ Language = objectscript ]

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 BlacklistContainsElement(domainId As %Integer, blackListId As %Integer, entUniId As %Integer, Output pSC As %Status = $$$OK) as %Boolean [ Language = objectscript ]
Returns whether or not the BlackList identified by blackListId contains the supplied entity.
classmethod BlacklistContainsString(domainId As %Integer, blackListId As %Integer, entity As %String, Output pSC As %Status = $$$OK) as %Boolean [ Language = objectscript ]
Returns whether or not the BlackList identified by blackListId contains the supplied entity.
classmethod ClearBlackList(pDomainId As %Integer, pBlackListId As %Integer) as %Status [ Language = objectscript ]
Clears the contents of a single BlackList.
classmethod CreateBlackList(domainId As %Integer, name As %String, description As %String = "", Output sc As %Status = $$$OK) as %Integer [ Language = objectscript ]

Create a new BlackList entry with the given name and description

classmethod CreateUserDictionary(name As %String, description As %String = "", Output sc As %Status) as %Integer [ Language = objectscript ]

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 DropBlackList(domainId As %Integer, blackListId As %Integer) as %Status [ Language = objectscript ]
Drops a BlackList (entities part of the list will not be deleted from the domain)
classmethod DropUserDictionary(userDictId As %Integer) as %Status [ Language = objectscript ]
This method drops the User Dictionary identified by the supplied userDictId, including all its entries.

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

classmethod GetBlackListElements(ByRef result, domainId As %Integer, blackListId As %Integer) as %Status [ Language = objectscript ]
Retrieves a list of all the strings in the specified BlackList
classmethod GetBlackListId(domainId As %Integer, name As %String, Output sc As %Status = $$$OK) as %Integer [ Language = objectscript ]
Finds the BlackList ID corresponding to the supplied name.
classmethod GetBlackLists(ByRef result, domainId As %Integer, pIncludeCrossDomain As %Boolean = 0) as %Status [ Language = objectscript ]
Retrieves a list of all the BlackLists registered in this domain.
classmethod GetUserDictionaries(ByRef result) as %Status [ Language = objectscript ]
Returns a list of all the User Dictionaries in this namespace.

Deprecated: please use %iKnow.UserDictionary

classmethod GetUserDictionaryEntries(ByRef result, userDictId As %Integer) as %Status [ Language = objectscript ]

Returns the contents of a User Dictionary.

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

classmethod GetUserDictionaryId(name As %String) as %Integer [ Language = objectscript ]
Returns the ID corresponding to the supplied User Dictionary name.

Deprecated: please use NameIndexOpen() %iKnow.UserDictionary

classmethod HasBlackLists(pDomainId As %Integer) as %Boolean [ Language = objectscript ]
Returns whether or not there are any blacklists in the domain
classmethod RemoveEntityFromBlackList(domainId As %Integer, blackListId As %Integer, entUniId As %Integer) as %Status [ Language = objectscript ]
Removes an entity (by ID) from a BlackList (but not from the domain) For cross-domain blacklists, use RemoveStringFromBlackList()
classmethod RemoveStringFromBlackList(domainId As %Integer, blackListId As %Integer, string As %String) as %Status [ Language = objectscript ]
Removes a string from a BlackList (but not from the domain)
classmethod RemoveUserDictionaryEntry(userDictId As %Integer, position As %Integer) as %Status [ Language = objectscript ]

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

Inherited Members

Inherited Methods (Including Private)