%iKnow.Matching.DictionaryQAPI
Class %iKnow.Matching.DictionaryQAPI Extends %iKnow.Queries.AbstractQAPI [ Deprecated, System = 4 ]
This is an automatically generated class, offering a functionally equivalent set of methods and queries as %iKnow.Matching.DictionaryAPI, exposed as SqlProc methods.
See the classdocs for %iKnow.Matching.DictionaryAPI for more information.
Methods
CreateDictionary
ClassMethod CreateDictionary(domainId As %Integer, name As %String(MAXLEN=32767), description As %String(MAXLEN=32767) = "", defaultLanguage As %String(MAXLEN=32767) = "en", defaultProfileId As %Integer = "", Output scText As %String = "") As %Library.Integer [ SqlProc ]
Creates a Dictionary and returns its ID.
CreateDictionaryFormat
ClassMethod CreateDictionaryFormat(domainId As %Integer, formatClass As %String(MAXLEN=32767), formatParams As %String(MAXLEN=32767) = "", Output scText As %String = "") As %Library.Integer [ SqlProc ]
Creates a Dictionary Format instance of the supplied formatClass and returns its ID.
CreateDictionaryItem
ClassMethod CreateDictionaryItem(domainId As %Integer, dictId As %Integer, name As %String(MAXLEN=32767), ByRef URI As %String(MAXLEN=32767), defaultLanguage As %String(MAXLEN=32767) = "en", Output scText As %String = "") As %Library.Integer [ SqlProc ]
Creates a Dictionary Item and returns its ID.
CreateDictionaryItemAndTerm
ClassMethod CreateDictionaryItemAndTerm(domainId As %Integer, dictId As %Integer, name As %String(MAXLEN=32767), ByRef URI As %String(MAXLEN=32767), language As %String(MAXLEN=32767) = "en", Output scText As %String = "") As %Library.Integer [ SqlProc ]
Shorthand method for creating a Dictionary Item and Term using the Item's name. Returns the Items ID.
CreateDictionaryTerm
ClassMethod CreateDictionaryTerm(domainId As %Integer, dictItemId As %Integer, string As %String(MAXLEN=32767), language As %String(MAXLEN=32767) = "en", Output scText As %String = "", isProcessed As %Boolean = 0) As %Library.Integer [ SqlProc ]
Creates a Dictionary Term and returns its ID.
If isProcessed is 1 (default 0), the term will be marked as processed upon creation and no Dictionary Elements will be created. This parameter is for internal use only and deprecated in 2013.1.
CreateDictionaryTermFormat
ClassMethod CreateDictionaryTermFormat(domainId As %Integer, dictItemId As %Integer, formatClass As %String(MAXLEN=32767), formatParams As %String(MAXLEN=32767) = "", Output scText As %String = "") As %Library.Integer [ SqlProc ]
Creates a Dictionary Term composed of a single Dictionary Format and returns the Terms ID.
CreateRegularExpression
ClassMethod CreateRegularExpression(pDomainId As %Integer, pDictItemId As %Integer, pRegularExpression As %String(MAXLEN=32767), pReplace As %String(MAXLEN=32767) = "", Output scText As %String = "") As %Library.Integer [ SqlProc ]
Shorthand method to create a Dictionary Term composed of a single Dictionary Format of type %iKnow.Matching.Formats.RegularExpression, matching pRegularExpression and optionally producing output by replacing the matched parts of an entity with pReplace.
DropAllDictionaryData
ClassMethod DropAllDictionaryData(domainId As %Integer) As %Boolean [ SqlProc ]
Drops all dictionary data, including matching results. This method will fail if there are managed dictionaries in this domain.
DropDictionary
ClassMethod DropDictionary(domainId As %Integer, dictId As %Integer) As %Boolean [ SqlProc ]
Deletes a Dictionary and all related items, terms, elements and matches.
DropDictionaryItem
ClassMethod DropDictionaryItem(domainId As %Integer, dictItemId As %Integer) As %Boolean [ SqlProc ]
Deletes a Dictionary Item with all related terms, elements and matches.
DropDictionaryTerm
ClassMethod DropDictionaryTerm(domainId As %Integer, dictTermId As %String(MAXLEN=32767)) As %Boolean [ SqlProc ]
Drops a single Dictionary Term and its matching results
GetDictionariesExecute
ClassMethod GetDictionariesExecute(ByRef qHandle As %Binary, domainId As %Integer, page As %Integer = 1, pageSize As %Integer = 10, pIncludeCrossDomain As %Boolean = 0) As %Status [ Internal ]
Returns all Dictionaries in this domain. If pIncludeCrossDomain = 1, any cross-domain dictionaries registered in "domain 0" are also included in the result, using a negative value for their ID.
GetDictionariesFetch
ClassMethod GetDictionariesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ Internal, PlaceAfter = GetDictionariesExecute ]
GetDictionariesClose
ClassMethod GetDictionariesClose(ByRef qHandle As %Binary) As %Status [ Internal, PlaceAfter = GetDictionariesExecute ]
GetDictionaryCount
ClassMethod GetDictionaryCount(pDomainId As %Integer, Output scText As %String = "") As %Library.Integer [ SqlProc ]
GetDictionaryId
ClassMethod GetDictionaryId(domainId As %Integer, name As %String(MAXLEN=32767), Output scText As %String = "") As %Library.Integer [ SqlProc ]
Looks up the Dictionary ID corresponding to the supplied Dictionary name.
GetDictionaryItemIdByURI
ClassMethod GetDictionaryItemIdByURI(domainId As %Integer, URI As %String(MAXLEN=32767), Output scText As %String = "") As %Library.Integer [ SqlProc ]
Looks up the Dictionary Item ID corresponding to the supplied Dictionary Item URI.
GetDictionaryItemsExecute
ClassMethod GetDictionaryItemsExecute(ByRef qHandle As %Binary, domainId As %Integer, dictId As %Integer, page As %Integer = 1, pageSize As %Integer = 10) As %Status [ Internal ]
Returns all Dictionary Items for the given Dictionary ID.
GetDictionaryItemsFetch
ClassMethod GetDictionaryItemsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ Internal, PlaceAfter = GetDictionaryItemsExecute ]
GetDictionaryItemsClose
ClassMethod GetDictionaryItemsClose(ByRef qHandle As %Binary) As %Status [ Internal, PlaceAfter = GetDictionaryItemsExecute ]
GetDictionaryItemsAndTermsExecute
ClassMethod GetDictionaryItemsAndTermsExecute(ByRef qHandle As %Binary, domainId As %Integer, dictId As %Integer, page As %Integer = 1, pageSize As %Integer = 10) As %Status [ Internal ]
Returns all Dictionary Items and their Terms for the given Dictionary ID.
GetDictionaryItemsAndTermsFetch
ClassMethod GetDictionaryItemsAndTermsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ Internal, PlaceAfter = GetDictionaryItemsAndTermsExecute ]
GetDictionaryItemsAndTermsClose
ClassMethod GetDictionaryItemsAndTermsClose(ByRef qHandle As %Binary) As %Status [ Internal, PlaceAfter = GetDictionaryItemsAndTermsExecute ]
GetDictionaryTermsByItemExecute
ClassMethod GetDictionaryTermsByItemExecute(ByRef qHandle As %Binary, domainId As %Integer, dictItemId As %Integer, page As %Integer = 1, pageSize As %Integer = 10) As %Status [ Internal ]
Returns all the Dictionary Terms for the given Dictionary Item ID.
GetDictionaryTermsByItemFetch
ClassMethod GetDictionaryTermsByItemFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ Internal, PlaceAfter = GetDictionaryTermsByItemExecute ]
GetDictionaryTermsByItemClose
ClassMethod GetDictionaryTermsByItemClose(ByRef qHandle As %Binary) As %Status [ Internal, PlaceAfter = GetDictionaryTermsByItemExecute ]
GetItemCount
ClassMethod GetItemCount(pDomainId As %Integer, pDictIds As %String(MAXLEN=32767) = "", Output scText As %String = "") As %Library.Integer [ SqlProc ]
GetItemsByNameExecute
ClassMethod GetItemsByNameExecute(ByRef qHandle As %Binary, pDomainId As %Integer, pString As %String(MAXLEN=32767), pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %String(MAXLEN=32767) = "", pDictIds As %String(MAXLEN=32767) = "", pMode As %Integer = {$$$USEPARTS}, pCheck As %String(VALUELIST="NAME,URI") = "NAME", pLang As %String(MAXLEN=32767) = "en") As %Status [ Internal ]
Note: pFilter is ignored when looking at cross-domain dictionaries
GetItemsByNameFetch
ClassMethod GetItemsByNameFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ Internal, PlaceAfter = GetItemsByNameExecute ]
GetItemsByNameClose
ClassMethod GetItemsByNameClose(ByRef qHandle As %Binary) As %Status [ Internal, PlaceAfter = GetItemsByNameExecute ]
GetTermCount
ClassMethod GetTermCount(pDomainId As %Integer, pDictIds As %String(MAXLEN=32767) = "", Output scText As %String = "") As %Library.Integer [ SqlProc ]
GetTermCountByItem
ClassMethod GetTermCountByItem(pDomainId As %Integer, pDictItemIds As %String(MAXLEN=32767) = "", Output scText As %String = "") As %Library.Integer [ SqlProc ]
GetTermElementsExecute
ClassMethod GetTermElementsExecute(ByRef qHandle As %Binary, pDomainId As %Integer, pDictionaryTermId As %Integer) As %Status [ Internal ]
Retrieves the elements corresponding to a given pDictionaryTermId.
GetTermElementsFetch
ClassMethod GetTermElementsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ Internal, PlaceAfter = GetTermElementsExecute ]
GetTermElementsClose
ClassMethod GetTermElementsClose(ByRef qHandle As %Binary) As %Status [ Internal, PlaceAfter = GetTermElementsExecute ]
GetTermsByNameExecute
ClassMethod GetTermsByNameExecute(ByRef qHandle As %Binary, pDomainId As %Integer, pString As %String(MAXLEN=32767), pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %String(MAXLEN=32767) = "", pDictIds As %String(MAXLEN=32767) = "", pMode As %Integer = {$$$USEPARTS}, pLang As %String(MAXLEN=32767) = "en") As %Status [ Internal ]
Note: pFilter is ignored when looking at cross-domain dictionaries
GetTermsByNameFetch
ClassMethod GetTermsByNameFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ Internal, PlaceAfter = GetTermsByNameExecute ]
GetTermsByNameClose
ClassMethod GetTermsByNameClose(ByRef qHandle As %Binary) As %Status [ Internal, PlaceAfter = GetTermsByNameExecute ]
HasDictionaries
ClassMethod HasDictionaries(pDomainId As %Integer) As %Library.Boolean [ SqlProc ]
Returns whether or not there are any dictionaries in the domain