Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%iKnow.Matching.DictionaryWSAPI

class %iKnow.Matching.DictionaryWSAPI extends %iKnow.Queries.AbstractWSAPI

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.

This class was generated by : %iKnow.Matching.DictionaryAPI.cls

Method Inventory

Parameters

parameter NAMESPACE = http://www.intersystems.com/iKnow/Matching/DictionaryWSAPI;
Inherited description: NAMESPACE - Should be an unique URI Override this parameter in the subclass with the unique namespace URI of your organization. Override this parameter in the subclass.
parameter SERVICENAME = iKnow.Matching.DictionaryWSAPI;
Inherited description: SERVICENAME - Should be the name of the service for which this is a proxy. Override this parameter in the subclass.
parameter USECLASSNAMESPACES = 1;
Inherited description: When USECLASSNAMESPACES = 1, then the WSDL of the Web service reflects the namespaces defined for the referenced classes by the NAMESPACE parameters of those classes. The default, for compatibility with previous versions, is that the NAMESPACE parameters of the referenced classes are ignored when creating the WSDL. If USECLASSNAMESPACES has no value, then the default value from ^ISCSOAP("USECLASSNAMESPACES") is used.

Methods

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.
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.
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.
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.
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.

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.
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.
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.
classmethod DropDictionary(domainId As %Integer, dictId As %Integer) as %Boolean [ WebMethod ]
Deletes a Dictionary and all related items, terms, elements and matches.
classmethod DropDictionaryItem(domainId As %Integer, dictItemId As %Integer) as %Boolean [ WebMethod ]
Deletes a Dictionary Item with all related terms, elements and matches.
classmethod DropDictionaryTerm(domainId As %Integer, dictTermId As %String) as %Boolean [ WebMethod ]
Drops a single Dictionary Term and its matching results
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.
classmethod GetDictionaryCount(pDomainId As %Integer) as %Library.Integer [ WebMethod ]
classmethod GetDictionaryId(domainId As %Integer, name As %String) as %Library.Integer [ WebMethod ]
Looks up the Dictionary ID corresponding to the supplied Dictionary name.
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.
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.
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.
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.
classmethod GetItemCount(pDomainId As %Integer, pDictIds As %ListOfDataTypes = "") as %Library.Integer [ WebMethod ]
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
classmethod GetTermCount(pDomainId As %Integer, pDictIds As %ListOfDataTypes = "") as %Library.Integer [ WebMethod ]
classmethod GetTermCountByItem(pDomainId As %Integer, pDictItemIds As %ListOfDataTypes = "") as %Library.Integer [ WebMethod ]
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
classmethod HasDictionaries(pDomainId As %Integer) as %Library.Boolean [ WebMethod ]
Returns whether or not there are any dictionaries in the domain

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab