com.filenet.api.admin
Interface VerityCollection

All Superinterfaces:
DependentObject, EngineObject, RepositoryObject, java.io.Serializable

public interface VerityCollection
extends RepositoryObject, EngineObject, DependentObject

Identifies the full text indexing information used for a particular base class and all of its subclasses. A VerityCollection is associated with only one IndexArea, and the full text information is stored in a file system directory identified by the VerityIndexArea.RootDirectoryPath property.

For each VerityCollection object in the Content Engine database, there is a corresponding collection maintained by the Verity software that actually holds the full text index data. The name of this collection is identified in the VerityCollection.CollectionName property.

VerityCollection objects are automatically created by the server when needed, and do not need to be created by a client application. When full text indexing is available, and the first instance of a class is created or modified, the server looks for an existing VerityCollection associated with the appropriate base class, and will use this VerityCollection. If a VerityCollection is not found, a new VerityCollection is created, along with the corresponding collection maintained by the Verity software.

An application can set the ResourceStatus property to "closed" if a problem occurs with writing data to a particular VerityCollection, or to "unavailable" if the collection is expected to be made available again eventually.

The ResourceStatus property is set to "full" by the server when the number of rows in the collection is greater than VerityServerConfiguration.MaxRowsPerCollection (no new data will be written to the collection). Whenever a collection is needed for writing full text information, the collection is selected from the list of eligible "open" collections. If no open collection exists, then a collection with a status of "standby" is selected, and that collection’s status is changed to "open".

New indexing information is written only to collections having a status of "open". However, all collections, regardless of their status, are searched when queries are performed. To prevent a collection from being searched, the associated VerityCollection object must be deleted.

Metadata

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


Method Summary
 IdList get_BaseClassIds()
          Returns the value of the BaseClassIds property.
 java.lang.String get_CollectionName()
          Returns the value of the CollectionName property.
 Id get_Id()
          Returns the value of the Id property.
 java.lang.Integer get_OriginalOrdinal()
          Returns the value of the OriginalOrdinal property.
 ResourceStatus get_ResourceStatus()
          Returns the value of the ResourceStatus property.
 void set_BaseClassIds(IdList value)
          Sets the value of the BaseClassIds property.
 void set_CollectionName(java.lang.String value)
          Sets the value of the CollectionName property.
 void set_OriginalOrdinal(java.lang.Integer value)
          Sets the value of the OriginalOrdinal property.
 void set_ResourceStatus(ResourceStatus value)
          Sets the value of the ResourceStatus 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_BaseClassIds

IdList get_BaseClassIds()
Returns the value of the BaseClassIds property. For more information, see BaseClassIds Property.


set_BaseClassIds

void set_BaseClassIds(IdList value)
Sets the value of the BaseClassIds property. For more information, see BaseClassIds Property.


get_CollectionName

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


set_CollectionName

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


get_ResourceStatus

ResourceStatus get_ResourceStatus()
Returns the value of the ResourceStatus property. For more information, see ResourceStatus Property.


set_ResourceStatus

void set_ResourceStatus(ResourceStatus value)
Sets the value of the ResourceStatus property. For more information, see ResourceStatus Property.


get_OriginalOrdinal

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


set_OriginalOrdinal

void set_OriginalOrdinal(java.lang.Integer value)
Sets the value of the OriginalOrdinal property. For more information, see OriginalOrdinal Property.



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