Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%iKnow] >  [Objects] >  [Dictionary]
Private  Storage   

persistent class %iKnow.Objects.Dictionary extends %Persistent

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

This class can be used from 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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 7 1 2


Summary

Properties
DefaultLanguage DefaultLanguageId DefaultProfileId Description
DictionaryId DomainId Name

Methods
%AddToSaveSet %AddToSyncSet %CheckConstraints %CheckConstraintsForExtent
%ClassIsLatestVersion %ClassName %ComposeOid %ConstructClone
%Delete %DeleteExtent %DeleteId %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %Exists %ExistsId
%Extends %GUID %GUIDSet %GetLock
%GetParameter %GetSwizzleObject %Id %IsA
%IsModified %IsNull %KillExtent %LockExtent
%LockId %New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnBeforeAddToSync %OnDetermineClass
%Open %OpenId %OriginalNamespace %PackageName
%PurgeIndices %Reload %RemoveFromSaveSet %ResolveConcurrencyConflict
%RollBack %Save %SaveDirect %SerializeObject
%SetModified %SortBegin %SortEnd %SyncObjectIn
%SyncTransport %UnlockExtent %UnlockId %ValidateIndices
%ValidateObject Open


Parameters

• parameter READONLY = 1;
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 DefaultLanguageId as %Integer;
• property DefaultProfileId as %Integer;
• property Description as %String(MAXLEN=2000);
• property DictionaryId as %Integer;
• property DomainId as %Integer;
• property Name as %String(MAXLEN=1000);

Methods

• classmethod Open(pDomainId As %Integer, pDictionaryId As %Integer) as %iKnow.Objects.Dictionary
Returns a %iKnow.Objects.Dictionary object using the supplied identifiers, resolving negative dictionary IDs to the appropriate coordinates for a cross-domain dictionary.

Indices

•index (DictNameIndex on DomainId,Name) [Unique];
•index (PKINDEX on DomainId,DictionaryId) [IdKey,PrimaryKey,Unique];


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.