Skip to main content

%iKnow.Matching.DictionaryWSAPI

Class %iKnow.Matching.DictionaryWSAPI Extends %iKnow.Queries.AbstractWSAPI [ Deprecated, System = 4 ]

This is an automatically generated class, offering a functionally equivalent set of methods and queries as %iKnow.Matching.DictionaryAPI, exposed as WebMethod methods.

See the classdocs for %iKnow.Matching.DictionaryAPI for more information.

Parameters​

NAMESPACE​

Parameter NAMESPACE = "http://www.intersystems.com/iKnow/Matching/DictionaryWSAPI";

SERVICENAME​

Parameter SERVICENAME = "iKnow.Matching.DictionaryWSAPI";

USECLASSNAMESPACES​

Parameter USECLASSNAMESPACES = 1;

Methods​

CreateDictionary​

ClassMethod CreateDictionary(domainId As %Integer, name As %String, description As %String = "", defaultLanguage As %String = "en", defaultProfileId As %Integer = "") As %Library.Integer [ WebMethod ]

Creates a Dictionary and returns its ID.

CreateDictionaryFormat​

ClassMethod CreateDictionaryFormat(domainId As %Integer, formatClass As %String, formatParams As %ListOfDataTypes = "") As %Library.Integer [ WebMethod ]

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, URI As %String, defaultLanguage As %String = "en") As %Library.Integer [ WebMethod ]

Creates a Dictionary Item and returns its ID.

CreateDictionaryItemAndTerm​

ClassMethod CreateDictionaryItemAndTerm(domainId As %Integer, dictId As %Integer, name As %String, URI As %String, language As %String = "en") As %Library.Integer [ WebMethod ]

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, language As %String = "en", isProcessed As %Boolean = 0) As %Library.Integer [ WebMethod ]

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, formatParams As %ListOfDataTypes = "") As %Library.Integer [ WebMethod ]

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, pReplace As %String = "") As %Library.Integer [ WebMethod ]

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 [ WebMethod ]

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 [ WebMethod ]

Deletes a Dictionary and all related items, terms, elements and matches.

DropDictionaryItem​

ClassMethod DropDictionaryItem(domainId As %Integer, dictItemId As %Integer) As %Boolean [ WebMethod ]

Deletes a Dictionary Item with all related terms, elements and matches.

DropDictionaryTerm​

ClassMethod DropDictionaryTerm(domainId As %Integer, dictTermId As %String) As %Boolean [ WebMethod ]

Drops a single Dictionary Term and its matching results

GetDictionaries​

ClassMethod GetDictionaries(domainId As %Integer, page As %Integer = 1, pageSize As %Integer = 10, pIncludeCrossDomain As %Boolean = 0) As %XML.DataSet [ WebMethod ]

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.

GetDictionaryCount​

ClassMethod GetDictionaryCount(pDomainId As %Integer) As %Library.Integer [ WebMethod ]

GetDictionaryId​

ClassMethod GetDictionaryId(domainId As %Integer, name As %String) As %Library.Integer [ WebMethod ]

Looks up the Dictionary ID corresponding to the supplied Dictionary name.

GetDictionaryItemIdByURI​

ClassMethod GetDictionaryItemIdByURI(domainId As %Integer, URI As %String) As %Library.Integer [ WebMethod ]

Looks up the Dictionary Item ID corresponding to the supplied Dictionary Item URI.

GetDictionaryItems​

ClassMethod GetDictionaryItems(domainId As %Integer, dictId As %Integer, page As %Integer = 1, pageSize As %Integer = 10) As %XML.DataSet [ WebMethod ]

Returns all Dictionary Items for the given Dictionary ID.

GetDictionaryItemsAndTerms​

ClassMethod GetDictionaryItemsAndTerms(domainId As %Integer, dictId As %Integer, page As %Integer = 1, pageSize As %Integer = 10) As %XML.DataSet [ WebMethod ]

Returns all Dictionary Items and their Terms for the given Dictionary ID.

GetDictionaryTermsByItem​

ClassMethod GetDictionaryTermsByItem(domainId As %Integer, dictItemId As %Integer, page As %Integer = 1, pageSize As %Integer = 10) As %XML.DataSet [ WebMethod ]

Returns all the Dictionary Terms for the given Dictionary Item ID.

GetItemCount​

ClassMethod GetItemCount(pDomainId As %Integer, pDictIds As %ListOfDataTypes = "") As %Library.Integer [ WebMethod ]

GetItemsByName​

ClassMethod GetItemsByName(pDomainId As %Integer, pString As %String, pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %String(MAXLEN=32767) = "", pDictIds As %ListOfDataTypes = "", pMode As %Integer = {$$$USEPARTS}, pCheck As %String(VALUELIST="NAME,URI") = "NAME", pLang As %String = "en") As %XML.DataSet [ WebMethod ]

Note: pFilter is ignored when looking at cross-domain dictionaries

GetTermCount​

ClassMethod GetTermCount(pDomainId As %Integer, pDictIds As %ListOfDataTypes = "") As %Library.Integer [ WebMethod ]

GetTermCountByItem​

ClassMethod GetTermCountByItem(pDomainId As %Integer, pDictItemIds As %ListOfDataTypes = "") As %Library.Integer [ WebMethod ]

GetTermElements​

ClassMethod GetTermElements(pDomainId As %Integer, pDictionaryTermId As %Integer) As %XML.DataSet [ Internal, WebMethod ]

Retrieves the elements corresponding to a given pDictionaryTermId.

GetTermsByName​

ClassMethod GetTermsByName(pDomainId As %Integer, pString As %String, pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %String(MAXLEN=32767) = "", pDictIds As %ListOfDataTypes = "", pMode As %Integer = {$$$USEPARTS}, pLang As %String = "en") As %XML.DataSet [ WebMethod ]

Note: pFilter is ignored when looking at cross-domain dictionaries

HasDictionaries​

ClassMethod HasDictionaries(pDomainId As %Integer) As %Library.Boolean [ WebMethod ]

Returns whether or not there are any dictionaries in the domain