Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %iKnow.Objects.DictionaryElement
Private  Storage   


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

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.


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 13 2 1


Dictionary DictionaryElementId DictionaryId DictionaryTerm
DictionaryTermId DomainId MinMatchScore NbOfSiblings
RequiredPosition RequiredRole StringValue Type

%AddToSaveSet %AddToSyncSet %BuildIndicesAsync %BuildIndicesAsyncResponse
%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 ComputeStringValue


• parameter READONLY = 1;
READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.


• property Dictionary as %iKnow.Objects.Dictionary [ Calculated ];
• property DictionaryElementId as %Integer;
• property DictionaryId as %Integer;
• property DictionaryTerm as %iKnow.Objects.DictionaryTerm [ Calculated ];
• property DictionaryTermId as %Integer;
• property DomainId as %Integer;
• property MinMatchScore as %Numeric;
• property NbOfSiblings as %Integer;
• property RequiredPosition as %Integer;
• property RequiredRole as %Integer;
• property StringValue as %String [ Calculated ];
• property Type as %Integer;
• property Value as %String(MAXLEN=1000);


• classmethod ComputeStringValue(pDomainId As %Integer, pDEId As %Integer) as %String
• classmethod Open(pDomainId As %Integer, pDictionaryElementId As %Integer) as %iKnow.Objects.DictionaryElement
Returns a %iKnow.Objects.DictionaryElement object using the supplied identifiers, resolving negative dictionary Element IDs to the appropriate coordinates for a cross-domain dictionary entry.


•index (PKINDEX on DomainId,DictionaryElementId) [IdKey,PrimaryKey,Unique];