com.filenet.api.admin

Interface CmIndexedColumn

All Superinterfaces:

DependentObject, EngineObject, RepositoryObject, java.io.Serializable

public interface CmIndexedColumn
extends RepositoryObject, EngineObject, DependentObject

Defines a column that forms part of a database index, and the manner in which the column participates in the index.

Using the properties on this class, you can:

• Specify the name of the column.
• Control whether a key column should be in ascending or descending order.
• Specify an include-only column.

Note that these properties are all SETTABLE_ONLY_ON_CREATE. Therefore, instances of CmIndexedColumn are immutable once created.

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: true
IsHidden: false
Searchable: false
StorageType: ObjectStore
SuperclassName: GenericObject

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	get_ColumnName() Returns the value of the ColumnName property.
Id	get_Id() Returns the value of the Id property.
SortOrder	get_SortOrder() Returns the value of the SortOrder property.
void	set_ColumnName(java.lang.String value) Sets the value of the ColumnName property.
void	set_SortOrder(SortOrder value) Sets the value of the SortOrder property.

Methods inherited from interface com.filenet.api.core.RepositoryObject

getObjectStore

Methods inherited from interface com.filenet.api.core.EngineObject

get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

Method Detail

get_Id

Id get_Id()

Returns the value of the Id property. For more information, see Id Property.

get_ColumnName

java.lang.String get_ColumnName()

Returns the value of the ColumnName property. For more information, see ColumnName Property.

set_ColumnName

void set_ColumnName(java.lang.String value)

Sets the value of the ColumnName property. For more information, see ColumnName Property.

get_SortOrder

SortOrder get_SortOrder()

Returns the value of the SortOrder property. For more information, see SortOrder Property.

set_SortOrder

void set_SortOrder(SortOrder value)

Sets the value of the SortOrder property. For more information, see SortOrder Property.