%iKnow.Objects.DictionaryTerm

persistent class %iKnow.Objects.DictionaryTerm extends %Library.Persistent

SQL Table Name: %iKnow_Objects.DictionaryTerm

Note: the use of this class is no longer recommended for accessing elements of a specific domain. For those scenarios, %iKnow.Tables.Utils offers a more flexible and customizable way of projecting iKnow domain data to SQL

This is a read-only object representation wrapping the internal iKnow data structures for Dictionary Terms.

This class can be used from Cache ObjectScript or SQL to access a single or small number of entries, but the storage mappings are not meant to support elaborate or complex queries targeting this SQL table.

Please use the predefined queries in %iKnow.Matching.DictionaryAPI and other query classes to consult Dictionary data as the internal global structures are designed to optimize performance for these queries rather than general-purpose access.

Property Inventory

• DefaultLanguage
• DefaultLanguageId
• Dictionary
• DictionaryId
• DictionaryItem
• DictionaryItemId
• DictionaryTermId
• DomainId
• String

Method Inventory

• Open()

Parameters

parameter READONLY = 1;

Inherited description: READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.

Properties

property DefaultLanguage as %String [ Calculated ];

Property methods: DefaultLanguageCompute(), DefaultLanguageDisplayToLogical(), DefaultLanguageGet(), DefaultLanguageIsValid(), DefaultLanguageLogicalToDisplay(), DefaultLanguageLogicalToOdbc(), DefaultLanguageNormalize(), DefaultLanguageSQLCompute()

property DefaultLanguageId as %Integer;

Property methods: DefaultLanguageIdDisplayToLogical(), DefaultLanguageIdGet(), DefaultLanguageIdIsValid(), DefaultLanguageIdLogicalToDisplay(), DefaultLanguageIdNormalize(), DefaultLanguageIdSet()

property Dictionary as %iKnow.Objects.Dictionary [ Calculated ];

Property methods: DictionaryCompute(), DictionaryGet(), DictionaryGetObject(), DictionaryGetObjectId(), DictionarySQLCompute()

property DictionaryId as %Integer;

Property methods: DictionaryIdDisplayToLogical(), DictionaryIdGet(), DictionaryIdIsValid(), DictionaryIdLogicalToDisplay(), DictionaryIdNormalize(), DictionaryIdSet()

property DictionaryItem as %iKnow.Objects.DictionaryItem [ Calculated ];

Property methods: DictionaryItemCompute(), DictionaryItemGet(), DictionaryItemGetObject(), DictionaryItemGetObjectId(), DictionaryItemSQLCompute()

property DictionaryItemId as %Integer;

Property methods: DictionaryItemIdDisplayToLogical(), DictionaryItemIdGet(), DictionaryItemIdIsValid(), DictionaryItemIdLogicalToDisplay(), DictionaryItemIdNormalize(), DictionaryItemIdSet()

property DictionaryTermId as %Integer [ Required ];

Property methods: DictionaryTermIdDisplayToLogical(), DictionaryTermIdGet(), DictionaryTermIdIsValid(), DictionaryTermIdLogicalToDisplay(), DictionaryTermIdNormalize(), DictionaryTermIdSet()

property DomainId as %Integer [ Required ];

Property methods: DomainIdDisplayToLogical(), DomainIdGet(), DomainIdIsValid(), DomainIdLogicalToDisplay(), DomainIdNormalize(), DomainIdSet()

property String as %String (MAXLEN = 2000);

Property methods: StringDisplayToLogical(), StringGet(), StringIsValid(), StringLogicalToDisplay(), StringLogicalToOdbc(), StringNormalize(), StringSet()

Methods

classmethod Open(pDomainId As %Integer, pDictionaryTermId As %Integer) as %iKnow.Objects.DictionaryTerm

Returns a %iKnow.Objects.DictionaryTerm object using the supplied identifiers, resolving negative dictionary Term IDs to the appropriate coordinates for a cross-domain dictionary entry.

Indexes

index (PKINDEX on DomainId,DictionaryTermId) [IdKey, PrimaryKey, Type = key, Unique];

Index methods: PKINDEXCheck(), PKINDEXDelete(), PKINDEXExists(), PKINDEXOpen(), PKINDEXSQLCheckUnique(), PKINDEXSQLExists(), PKINDEXSQLFindPKeyByConstraint(), PKINDEXSQLFindRowIDByConstraint()