%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
- AddEntityToBlackList()
- AddStringToBlackList()
- AddUserDictionaryEntry()
- BlacklistContainsElement()
- BlacklistContainsString()
- ClearBlackList()
- CreateBlackList()
- CreateUserDictionary()
- DropBlackList()
- DropUserDictionary()
- GetBlackListElements()
- GetBlackListId()
- GetBlackLists()
- GetUserDictionaries()
- GetUserDictionaryEntries()
- GetUserDictionaryId()
- HasBlackLists()
- RemoveEntityFromBlackList()
- RemoveStringFromBlackList()
- RemoveUserDictionaryEntry()
Parameters
Methods
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
Create a new BlackList entry with the given name and description
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
Deprecated: please use %DeleteId() in %iKnow.UserDictionary
Deprecated: please use %iKnow.UserDictionary
Returns the contents of a User Dictionary.
Deprecated: please use GetEntries() in %iKnow.UserDictionary
Deprecated: please use NameIndexOpen() %iKnow.UserDictionary
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
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()