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 or disabled for indexing, objects with newly enabled properties/classes need to be indexed, and objects with newly disabled properties/classes need to be removed from the index. 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 will cause unpredictable results. Instead, abort 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), new VerityCollection objects are created to hold the new indexing information. When this index operation completes, the old collections that previously held the indexing information are deleted. Because deleting the indexing information is not done on an individual object basis, and is instead done by deleting all relevant Verity collections, indexing a base class is somewhat 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.

For Document or Annotation objects created using a FileNet P8 3.5.x installation: If the CBREnabled status is changed to disabled for a class that had either Document or Annotation objects that were indexed, the index job to remove the indexing information should be run before any documents or annotations are deleted or modified (the content elements removed). If this cannot be accomplished, the Document and/or Annotation class and all subclasses of these classes should be reindexed.

Metadata

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


Method Summary
 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.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.



© Copyright IBM Corporation 2006, 2008. All rights reserved.