DictionaryWSAPI Class Reference

Inheritance diagram for DictionaryWSAPI:

Collaboration diagram for DictionaryWSAPI:

Static Public Member Functions
_.Library.Integer	CreateDictionary (_.Library.Integer domainId, _.Library.String name, _.Library.String description, _.Library.String defaultLanguage, _.Library.Integer defaultProfileId)
	Creates a Dictionary and returns its ID.
_.Library.Integer	CreateDictionaryFormat (_.Library.Integer domainId, _.Library.String formatClass, _.Library.ListOfDataTypes formatParams)
	Creates a Dictionary Format instance of the supplied formatClass and returns its ID.
_.Library.Integer	CreateDictionaryItem (_.Library.Integer domainId, _.Library.Integer dictId, _.Library.String name, _.Library.String URI, _.Library.String defaultLanguage)
	Creates a Dictionary Item and returns its ID.
_.Library.Integer	CreateDictionaryItemAndTerm (_.Library.Integer domainId, _.Library.Integer dictId, _.Library.String name, _.Library.String URI, _.Library.String language)
	Shorthand method for creating a Dictionary Item and Term using the Item's name. More...
_.Library.Integer	CreateDictionaryTerm (_.Library.Integer domainId, _.Library.Integer dictItemId, _.Library.String string, _.Library.String language, _.Library.Boolean isProcessed)
_.Library.Integer	CreateDictionaryTermFormat (_.Library.Integer domainId, _.Library.Integer dictItemId, _.Library.String formatClass, _.Library.ListOfDataTypes formatParams)
	Creates a Dictionary Term composed of a single Dictionary Format and returns the Terms ID.
_.Library.Integer	CreateRegularExpression (_.Library.Integer pDomainId, _.Library.Integer pDictItemId, _.Library.String pRegularExpression, _.Library.String pReplace)
	Shorthand method to create a Dictionary Term composed of a single Dictionary Format of type. More...
_.Library.Boolean	DropAllDictionaryData (_.Library.Integer domainId)
	Drops all dictionary data, including matching results. More...
_.Library.Boolean	DropDictionary (_.Library.Integer domainId, _.Library.Integer dictId)
	Deletes a Dictionary and all related items, terms, elements and matches.
_.Library.Boolean	DropDictionaryItem (_.Library.Integer domainId, _.Library.Integer dictItemId)
	Deletes a Dictionary Item with all related terms, elements and matches.
_.Library.Boolean	DropDictionaryTerm (_.Library.Integer domainId, _.Library.String dictTermId)
	Drops a single Dictionary Term and its matching results.
_.XML.DataSet	GetDictionaries (_.Library.Integer domainId, _.Library.Integer page, _.Library.Integer pageSize, _.Library.Boolean pIncludeCrossDomain)
	Returns all Dictionaries in this domain. More...
_.Library.Integer	GetDictionaryId (_.Library.Integer domainId, _.Library.String name)
	Looks up the Dictionary ID corresponding to the supplied Dictionary name.
_.Library.Integer	GetDictionaryItemIdByURI (_.Library.Integer domainId, _.Library.String URI)
	Looks up the Dictionary Item ID corresponding to the supplied Dictionary Item URI.
_.XML.DataSet	GetDictionaryItems (_.Library.Integer domainId, _.Library.Integer dictId, _.Library.Integer page, _.Library.Integer pageSize)
	Returns all Dictionary Items for the given Dictionary ID.
_.XML.DataSet	GetDictionaryItemsAndTerms (_.Library.Integer domainId, _.Library.Integer dictId, _.Library.Integer page, _.Library.Integer pageSize)
	Returns all Dictionary Items and their Terms for the given Dictionary ID.
_.XML.DataSet	GetDictionaryTermsByItem (_.Library.Integer domainId, _.Library.Integer dictItemId, _.Library.Integer page, _.Library.Integer pageSize)
	Returns all the Dictionary Terms for the given Dictionary Item ID.
_.XML.DataSet	GetItemsByName (_.Library.Integer pDomainId, _.Library.String pString, _.Library.Integer pPage, _.Library.Integer pPageSize, _.Library.String pFilter, _.Library.ListOfDataTypes pDictIds, _.Library.Integer pMode, _.Library.String pCheck, _.Library.String pLang)
	Note: pFilter is ignored when looking at cross-domain dictionaries.
_.XML.DataSet	GetTermsByName (_.Library.Integer pDomainId, _.Library.String pString, _.Library.Integer pPage, _.Library.Integer pPageSize, _.Library.String pFilter, _.Library.ListOfDataTypes pDictIds, _.Library.Integer pMode, _.Library.String pLang)
	Note: pFilter is ignored when looking at cross-domain dictionaries.
_.Library.Boolean	HasDictionaries (_.Library.Integer pDomainId)
	Returns whether or not there are any dictionaries in the domain.

Static Public Attributes
	NAMESPACE = None

Detailed Description

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

See the classdocs for <class>iKnow.Matching.DictionaryAPI</class> for more information.

Member Function Documentation

CreateDictionaryItemAndTerm()

_.Library.Integer CreateDictionaryItemAndTerm ( _.Library.Integer  domainId, _.Library.Integer  dictId, _.Library.String  name, _.Library.String  URI, _.Library.String  language  )

static

Shorthand method for creating a Dictionary Item and Term using the Item's name.

Returns the Items ID.

CreateDictionaryTerm()

_.Library.Integer CreateDictionaryTerm ( _.Library.Integer  domainId, _.Library.Integer  dictItemId, _.Library.String  string, _.Library.String  language, _.Library.Boolean  isProcessed  )

static

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.

CreateRegularExpression()

_.Library.Integer CreateRegularExpression ( _.Library.Integer  pDomainId, _.Library.Integer  pDictItemId, _.Library.String  pRegularExpression, _.Library.String  pReplace  )

static

Shorthand method to create a Dictionary Term composed of a single Dictionary Format of type.

<class>iKnow.Matching.Formats.RegularExpression</class>, matching pRegularExpression and optionally producing output by replacing the matched parts of an entity with pReplace.

DropAllDictionaryData()

_.Library.Boolean DropAllDictionaryData ( _.Library.Integer  domainId )

static

Drops all dictionary data, including matching results.

This method will fail if there are managed dictionaries in this domain.

GetDictionaries()

_.XML.DataSet GetDictionaries ( _.Library.Integer  domainId, _.Library.Integer  page, _.Library.Integer  pageSize, _.Library.Boolean  pIncludeCrossDomain  )

static

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.

Member Data Documentation

NAMESPACE

NAMESPACE = None

static

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

See the classdocs for <class>iKnow.Matching.DictionaryAPI</class> for more information.