com.filenet.api.admin
Interface IndexJob

All Superinterfaces:
EngineObject, IndependentlyPersistableObject, IndependentObject, RepositoryObject, java.io.Serializable

public interface IndexJob
extends RepositoryObject, IndependentlyPersistableObject

Initiates and tracks the status of a full text indexing operation. IndexJob is used to rebuild the full text index in the event that it becomes corrupted, or a configuration change requires that the full text index be rebuilt. The following types of indexing scenarios are supported:

All currently indexed data is available while indexing is in progress, but some queries will get duplicate matches from full text searches, due to matches in both the old and the new index data. When the Index Job operation completes, old copies of the data are removed (duplicate matches will no longer occur).

Most index jobs require sweeping the database looking for collections or classes to be indexed. This sweep requires a table scan on the database (taking a considerable length of time on a large table), even if the amount of data to be indexed is minimal. The database table scans are performed once for all classes to be indexed in a table, and once for all collections to be indexed in a table. To minimize the number of table scans required, we recommend you put all classes or collections to be indexed for the same table into a single IndexJob operation.

Metadata

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


Method Summary
 java.lang.String get_Creator()
          Returns the value of the Creator property.
 java.util.Date get_DateCreated()
          Returns the value of the DateCreated property.
 java.util.Date get_DateLastModified()
          Returns the value of the DateLastModified property.
 java.lang.String get_DescriptiveText()
          Returns the value of the DescriptiveText property.
 Id get_Id()
          Returns the value of the Id property.
 IndexJobItemList get_IndexItems()
          Returns the value of the IndexItems property.
 java.lang.Boolean get_JobAbortRequested()
          Returns the value of the JobAbortRequested property.
 IndexJobStatus get_JobStatus()
          Returns the value of the JobStatus property.
 java.lang.String get_LastModifier()
          Returns the value of the LastModifier property.
 java.lang.String get_Owner()
          Returns the value of the Owner property.
 AccessPermissionList get_Permissions()
          Returns the value of the Permissions property.
 java.lang.Integer get_SubmittedCount()
          Returns the value of the SubmittedCount property.
 java.util.Date get_TimeAllSubmitted()
          Returns the value of the TimeAllSubmitted property.
 java.util.Date get_TimeLastProcessed()
          Returns the value of the TimeLastProcessed property.
 void set_Creator(java.lang.String value)
          Sets the value of the Creator property.
 void set_DateCreated(java.util.Date value)
          Sets the value of the DateCreated property.
 void set_DateLastModified(java.util.Date value)
          Sets the value of the DateLastModified property.
 void set_DescriptiveText(java.lang.String value)
          Sets the value of the DescriptiveText property.
 void set_IndexItems(IndexJobItemList value)
          Sets the value of the IndexItems property.
 void set_JobAbortRequested(java.lang.Boolean value)
          Sets the value of the JobAbortRequested property.
 void set_LastModifier(java.lang.String value)
          Sets the value of the LastModifier property.
 void set_Owner(java.lang.String value)
          Sets the value of the Owner property.
 void set_Permissions(AccessPermissionList value)
          Sets the value of the Permissions property.
 
Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore
 
Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
 
Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
 
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
 

Method Detail

get_Creator

java.lang.String get_Creator()
Returns the value of the Creator property. For more information, see Creator Property.


set_Creator

void set_Creator(java.lang.String value)
Sets the value of the Creator property. For more information, see Creator Property.


get_DateCreated

java.util.Date get_DateCreated()
Returns the value of the DateCreated property. For more information, see DateCreated Property.


set_DateCreated

void set_DateCreated(java.util.Date value)
Sets the value of the DateCreated property. For more information, see DateCreated Property.


get_LastModifier

java.lang.String get_LastModifier()
Returns the value of the LastModifier property. For more information, see LastModifier Property.


set_LastModifier

void set_LastModifier(java.lang.String value)
Sets the value of the LastModifier property. For more information, see LastModifier Property.


get_DateLastModified

java.util.Date get_DateLastModified()
Returns the value of the DateLastModified property. For more information, see DateLastModified Property.


set_DateLastModified

void set_DateLastModified(java.util.Date value)
Sets the value of the DateLastModified property. For more information, see DateLastModified Property.


get_Id

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


get_Owner

java.lang.String get_Owner()
Returns the value of the Owner property. For more information, see Owner Property.


set_Owner

void set_Owner(java.lang.String value)
Sets the value of the Owner property. For more information, see Owner Property.


get_Permissions

AccessPermissionList get_Permissions()
Returns the value of the Permissions property. For more information, see Permissions Property.


set_Permissions

void set_Permissions(AccessPermissionList value)
Sets the value of the Permissions property. For more information, see Permissions Property.


get_DescriptiveText

java.lang.String get_DescriptiveText()
Returns the value of the DescriptiveText property. For more information, see DescriptiveText Property.


set_DescriptiveText

void set_DescriptiveText(java.lang.String value)
Sets the value of the DescriptiveText property. For more information, see DescriptiveText Property.


get_TimeLastProcessed

java.util.Date get_TimeLastProcessed()
Returns the value of the TimeLastProcessed property. For more information, see TimeLastProcessed Property.


get_TimeAllSubmitted

java.util.Date get_TimeAllSubmitted()
Returns the value of the TimeAllSubmitted property. For more information, see TimeAllSubmitted Property.


get_JobStatus

IndexJobStatus get_JobStatus()
Returns the value of the JobStatus property. For more information, see JobStatus Property.


get_JobAbortRequested

java.lang.Boolean get_JobAbortRequested()
Returns the value of the JobAbortRequested property. For more information, see JobAbortRequested Property.


set_JobAbortRequested

void set_JobAbortRequested(java.lang.Boolean value)
Sets the value of the JobAbortRequested property. For more information, see JobAbortRequested Property.


get_IndexItems

IndexJobItemList get_IndexItems()
Returns the value of the IndexItems property. For more information, see IndexItems Property.


set_IndexItems

void set_IndexItems(IndexJobItemList value)
Sets the value of the IndexItems property. For more information, see IndexItems Property.


get_SubmittedCount

java.lang.Integer get_SubmittedCount()
Returns the value of the SubmittedCount property. For more information, see SubmittedCount Property.



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