Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / %SYS namespace / %Library.IndexDefinition
Private  Storage   

%Library.IndexDefinition


persistent class %Library.IndexDefinition extends
%AbstractDefinition

Note: The class definition classes in the %Library package have been superceded by those in the %Dictionary package.

This class represents a specific index description for a class contained within the Class Dictionary.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
16 7


Summary


Properties
Attributes ClassName Condition Data Deprecated
Description Extent IdKey Internal Name
PrimaryKey Properties SQLName SequenceNumber Type
Unique

Methods
%AddToSaveSet %AddToSyncSet %BuildIndices %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
AttributesGet AttributesSet GetTransientState SetTransientState
lb li ll


Properties


• property Attributes as %RawString [ Calculated ];
This attribute is obsolete. Use 'Properties' instead.
• property ClassName as %RawString;
A string containing the name of the class the index belongs to.
• property Condition as %RawString;
A string containing a condition for the index.
• property Data as %RawString;
A string containing a comma-delimited list of properties stored with the index.
• property Deprecated as %RawString;
A flag indicating if this index is deprecated (1) or not (0).
• property Description as %RawString;
A string containing a description of the index.
• property Extent as %RawString;
A flag indicating whether the index is an extent index (1) or not (0).

An extent index is used to differentiate members of subclasses within extents.

• property IdKey as %RawString;
A flag indicating whether the index is an IDKEY index (1) or not (0).
• property Internal as %RawString;
A flag indicating whether the index is internal (1) or not (0).
• property Name as %RawString;
A string containing the name of the index.
• property PrimaryKey as %RawString;
A flag indicating whether the index is the SQL primary key (1) or not (0).
• property Properties as %RawString;
A string containing a comma-delimited list of the properties the index is based upon.
• property SQLName as %RawString;
A string containing the name that this index as defined in SQL.
• property SequenceNumber as %RawString;
Sequence number used to determine order of this item in Studio editor and in XML export format.
• property Type as %RawString;
A string indicating the type of index to create, KEY or INDEX. A key index is build using only the index attributes while an INDEX uses both the index attributes and the IDKEY attributes (or system generated ID value).
• property Unique as %RawString;
A flag indicating whether the index is unique (1) or not (0).

Methods


• method AttributesGet() as %RawString
This is a Get accessor method for the Attributes property.
• method AttributesSet(newvalue As %RawString) as %Status
This is a Set accessor method for the Attributes property.