The ICmIndexDefinition type exposes the following members.
Properties
Type | Name | Description |
---|---|---|
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) |
![]() | DatabaseIndexStorageLocation |
Specifies the location in which index information is created and referenced.
For an ObjectStore object, this property specifies the location within the database. If this property is set during creation of the object store, the Content Engine server uses the value to control where indexes are located. A change to the property value after the object store is created affects only the location of indexes that are added after the change. You can override the value of this property by specifying a custom schema script during object store creation. For a CmIndexDefinition object, this property specifies the tablespace or filegroup in which the index is located. If you do not provide a value for this property, the server sets the value to the index storage location specified in the corresponding ObjectStore property (if set). Otherwise, the location will be set to the default index storage location specified by the underlying database. |
![]() | ForCaseInsensitiveSearch |
Indicates whether the index is case-insensitive or not.
If you set the value of this property to true, the server will retain the value only if the underlying database is capable of handling expression-based indexes and if string-valued columns have been included in the index definition. Otherwise, the server will set the value of this property to false, and a message indicating this change is posted to the p8_server_error.log file. If you do not specify a value for this property, the server sets the value to true if all of the following conditions are met:
Otherwise, the server sets the value of this property to false. |
![]() | Id |
A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created.
When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following
format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.
For IUser and IGroup classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, IUser.Id and IGroup.Id always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server. For a given property representation, the Id property has the following characteristics:
For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time. |
![]() | IndexedColumns |
A CmIndexedColumnList collection object that specifies the list of objects that define
the columns that comprise this index. The order in which the CmIndexedColumn objects appear in the
list reflect the order in which the columns are defined in the index. At least one element is required in the
list.
The names for any key columns for a given index must be distinct from those for any other index on the same table. Note that the order in which non-key elements appear in the list of the index definition is not important. However, IBM recommends that applications place the non-key elements after the key-defining elements in the list. (A key column is a column that will be present in the ON clause of the CREATE INDEX statement; a non-key column will appear in the INCLUDE clause (or equivalent) of the CREATE INDEX statement.) |
![]() | IndexName |
Specifies the name of the index.
For a CmIndexDefinition object, if you set the value of this property, the value must conform to all of the constraints on index names enforced by the underlying database. If you do not specify a name, then the server will generate one. For a CmTextSearchIndex object, the value of this property is the name assigned to this IBM Content Search Services index. |
![]() | IsSystemOwned |
Indicates whether a given class or property was originally created by the Content Engine (true),
as opposed to user-created (false).
For a CmIndexDefinition object, if the object is system-owned (the value of this property is true), then the object cannot be modified or deleted. |
![]() | Properties |
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.) |
![]() | RequiresUniqueElements |
Specifies the uniqueness of elements in a multi-valued property or a database index.
For a CmIndexDefinition object, specifies whether an index is unique (true) or not (false). For all other objects, specifies whether the values of a multi-valued property must be unique (true) or not (false). |