This is an automatically generated class, offering a functionally equivalent set of methods and queries as %iKnow.Utils.MaintenanceAPI, exposed as SqlProc methods.
classmethod AddEntityToBlackList(domainId As %Integer, blackListId As %Integer, entUniId As %Integer) as %Boolean [ SQLProc = MaintenanceQAPI_AddEntityToBlackList ]
Projected as the stored procedure: MaintenanceQAPI_AddEntityToBlackList
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(MAXLEN=32767)) as %Boolean [ SQLProc = MaintenanceQAPI_AddStringToBlackList ]
Projected as the stored procedure: MaintenanceQAPI_AddStringToBlackList
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(MAXLEN=32767), rewriteTo As %String(MAXLEN=32767), ByRef position As %Integer = 0) as %Boolean [ SQLProc = MaintenanceQAPI_AddUserDictionaryEntry ]
Projected as the stored procedure: MaintenanceQAPI_AddUserDictionaryEntry
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.
classmethod BlacklistContainsElement(domainId As %Integer, blackListId As %Integer, entUniId As %Integer, Output scText As %String = "") as %Library.Boolean [ SQLProc = MaintenanceQAPI_BlacklistContainsElement ]
Projected as the stored procedure: MaintenanceQAPI_BlacklistContainsElement
Returns whether or not the BlackList identified by blackListId contains the
supplied entity.
classmethod BlacklistContainsString(domainId As %Integer, blackListId As %Integer, entity As %String(MAXLEN=32767), Output scText As %String = "") as %Library.Boolean [ SQLProc = MaintenanceQAPI_BlacklistContainsString ]
Projected as the stored procedure: MaintenanceQAPI_BlacklistContainsString
Returns whether or not the BlackList identified by blackListId contains the
supplied entity.
classmethod ClearBlackList(pDomainId As %Integer, pBlackListId As %Integer) as %Boolean [ SQLProc = MaintenanceQAPI_ClearBlackList ]
Projected as the stored procedure: MaintenanceQAPI_ClearBlackList
Clears the contents of a single BlackList.
classmethod CreateBlackList(domainId As %Integer, name As %String(MAXLEN=32767), description As %String(MAXLEN=32767)="", Output scText As %String = "") as %Library.Integer [ SQLProc = MaintenanceQAPI_CreateBlackList ]
Projected as the stored procedure: MaintenanceQAPI_CreateBlackList
Create a new BlackList entry 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 = MaintenanceQAPI_CreateUserDictionary ]
Projected as the stored procedure: MaintenanceQAPI_CreateUserDictionary
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.
classmethod GetBlackListId(domainId As %Integer, name As %String(MAXLEN=32767), Output scText As %String = "") as %Library.Integer [ SQLProc = MaintenanceQAPI_GetBlackListId ]
Projected as the stored procedure: MaintenanceQAPI_GetBlackListId
Finds the BlackList ID corresponding to the supplied name.
classmethod GetUserDictionaryId(name As %String(MAXLEN=32767)) as %Library.Integer [ SQLProc = MaintenanceQAPI_GetUserDictionaryId ]
Projected as the stored procedure: MaintenanceQAPI_GetUserDictionaryId
Returns the ID corresponding to the supplied User Dictionary name.
classmethod HasBlackLists(pDomainId As %Integer) as %Library.Boolean [ SQLProc = MaintenanceQAPI_HasBlackLists ]
Projected as the stored procedure: MaintenanceQAPI_HasBlackLists
Returns whether or not there are any blacklists in the domain
classmethod RemoveEntityFromBlackList(domainId As %Integer, blackListId As %Integer, entUniId As %Integer) as %Boolean [ SQLProc = MaintenanceQAPI_RemoveEntityFromBlackList ]
Projected as the stored procedure: MaintenanceQAPI_RemoveEntityFromBlackList
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(MAXLEN=32767)) as %Boolean [ SQLProc = MaintenanceQAPI_RemoveStringFromBlackList ]
Projected as the stored procedure: MaintenanceQAPI_RemoveStringFromBlackList
Removes a string from a BlackList (but not from the domain)
classmethod RemoveUserDictionaryEntry(userDictId As %Integer, position As %Integer) as %Boolean [ SQLProc = MaintenanceQAPI_RemoveUserDictionaryEntry ]
Projected as the stored procedure: MaintenanceQAPI_RemoveUserDictionaryEntry
Removes the User Dictionary entry registered at position. This method will
not impact the order or position of any remaning entries.