com.filenet.api.admin

Interface IndexJobClassItem

All Superinterfaces:

DependentObject, EngineObject, IndexJobItem, RepositoryObject, java.io.Serializable

public interface IndexJobClassItem
extends RepositoryObject, IndexJobItem, DependentObject

Identifies the class to be full-text indexed. When a property or class is enabled for indexing (CBR-enabled), objects associated with that newly enabled property or class need to be indexed. Conversely, when a property or class is disabled for indexing, objects associated with that newly disabled property or class need to be removed from existing indexes. The specified class can be any base class (such as, Document or Folder), or any of its subclasses, that support indexing. All instances of the specified class are indexed.

Warning Do not change the CBREnabled status of a class or property while an IndexJob operation is running on that class. Doing so can cause unpredictable results. Instead, stop any index job running on a class before changing the configuration, then resubmit the index job for that class.

If the class selected to index is a base class (Versionable, Document, Annotation, Folder, or CustomObject), the server creates CmTextSearchIndex objects to hold the new indexing information. When this index operation completes, the server deletes the existing IBM® Content Search Services indexes that previously held the indexing information. When indexing information is deleted, the server deletes all relevant indexes rather than deleting indexes on a per-object basis. Therefore, indexing a base class is faster than indexing a subclass of the base class.

Note For indexing purposes, the Document class is also considered to be a base class, because the Document class is the only subclass of the Versionable class and no instances of the Versionable class can be created.

Metadata

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

Method Summary

Methods

Modifier and Type	Method and Description
ClassDefinition	get_ClassDefinition() Returns the value of the ClassDefinition property.
java.lang.Boolean	get_IncludeSubclassesRequested() Returns the value of the IncludeSubclassesRequested property.
void	set_ClassDefinition(ClassDefinition value) Sets the value of the ClassDefinition property.
void	set_IncludeSubclassesRequested(java.lang.Boolean value) Sets the value of the IncludeSubclassesRequested property.

Methods inherited from interface com.filenet.api.admin.IndexJobItem

get_Id

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_ClassDefinition

ClassDefinition get_ClassDefinition()

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

set_ClassDefinition

void set_ClassDefinition(ClassDefinition value)

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

get_IncludeSubclassesRequested

java.lang.Boolean get_IncludeSubclassesRequested()

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

set_IncludeSubclassesRequested

void set_IncludeSubclassesRequested(java.lang.Boolean value)

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