CmTextSearchIndexArea Properties

This topic alphabetically lists the properties that apply to the CmTextSearchIndexArea class.

AffinityGroup Property



The Text Search Affinity Group with which the object is associated.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: CmTextSearchAffinityGroup
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

AuditedEvents Property



A collection of event objects audited for the object.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: Event
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ClassDescription Property



Describes an object's class.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

CmStandbyActivationPriority Property



Specifies the priority of this area for activation from Standby when other areas become full. A value of zero is highest priority.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: TBD [RD-2]
PropertyMaximumInteger32: TBD [RD-3]
PropertyMinimumInteger32: TBD [RD-4]
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

Creator Property



The name of the user who created this object.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: TBD [RD-1]
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

DateCreated Property



The date and time this object was created.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DATE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

DateLastModified Property



The date and time when this object was last modified.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DATE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

DescriptiveText Property



Text that describes this object.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: TBD [RD-1]
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

DisplayName Property



A user-intelligible name for the object.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
MaximumLengthString: TBD [RD-1]
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

Id Property



The unique object ID.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: GUID
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

LastModifier Property



The name of the user who last modified this object.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: TBD [RD-1]
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

MaxIndexes Property



The maximum number of indexes to create in this index area

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: TBD [RD-2]
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

MaxObjectsPerIndex Property



The maximum number of objects that a full text index can contain.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DOUBLE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

MaxSizePerIndexKbytes Property



The maximum size in KB that a full text index can have

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DOUBLE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

Name Property



Returns the value of the designated name property for the object, or its ID if there is no name property.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

Permissions Property



The discretionary permissions for the object.

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: 8
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: CmAbstractPermission
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

ResourceStatus Property



Open, closed, full, or standby status

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: TBD [RD-2]
PropertyMaximumInteger32: TBD [RD-3]
PropertyMinimumInteger32: TBD [RD-4]
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

RootDirectoryPath Property



The path to the root directory used for file storage.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
MaximumLengthString: TBD [RD-1]
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

Site Property



The site associated with this object

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: Site
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

TextSearchIndexes Property



The Text Search indexes associated to this index area

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: CmTextSearchIndex
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

This Property



Enables the expression of relationships among objects in DMA queries and selects candidate objects in query results.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: CmTextSearchIndexArea
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ