Home > Class Reference > ENSLIB namespace > %iKnow.Objects.DictionaryTerm
Private   Storage    


persistent class %iKnow.Objects.DictionaryTerm 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 Dictionary Terms.

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 9 1 1


DefaultLanguage DefaultLanguageId Dictionary DictionaryId
DictionaryItem DictionaryItemId DictionaryTermId DomainId
%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 Open


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 DefaultLanguage as %String [ Calculated ];
property DefaultLanguageId as %Integer;
property Dictionary as %iKnow.Objects.Dictionary [ Calculated ];
property DictionaryId as %Integer;
property DictionaryItem as %iKnow.Objects.DictionaryItem [ Calculated ];
property DictionaryItemId as %Integer;
property DictionaryTermId as %Integer;
property DomainId as %Integer;
property String as %String(MAXLEN=2000);


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.


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