DictIndex Class

The DictIndex class returns metadata about a table index.

Syntax

class DictIndex extends Object

Run On

Called

Methods

	Method	Description
	allowDuplicates	Returns the value of the allowDuplicates property for the index.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	configurationKeyId	Returns the ID of the configuration key for the index.
	enabled	Returns a value that indicates whether the index is enabled.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	field	Returns the ID of the specified field in the index.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	getValidTimeStateMode
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	id	Returns the ID of the index.
	includedColumn
	isAlternateKey
	isSql	Gets a value that indicates whether the index is in the SQL database.
	isUniqueAcrossCompanies	Gets a value that indicates whether the UniqueAcrossCompanies property is set for the index.
	isValidTimeStateKey
	modify	Modifies the index.
	name	Returns the name of the index.
	new	Initializes a new instance of the Object class. (Overrides the new Method.)
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	numberOfFields	Returns the number of fields in the index definition.
	numberOfIncludedColumns
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	setAlternateKey
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	setValidTimeStateKey
	tableid	Returns the ID of the table that contains the index.
	toString	Returns a string that represents the current object. (Inherited from Object.)
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)

Top

Examples

The following example creates an instance of the DictIndex class.

Dictionary dict; 
DictTable  table; 
DictIndex  idx; 
 
dict = new Dictionary(); 
table = new DictTable(dict.tableName2Id("Address")); 
idx = new DictIndex(table.id(), table.indexName2Id("AddrIdx"));

Inheritance Hierarchy

Object Class
  DictIndex Class
    SysDictIndex Class

See Also

DictField Class

DictTable Class