com.filenet.api.admin

Interface VerityCollection

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

    Deprecated. 
    As of release 5.2.0.

    Metadata


    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 index area, and the full-text indexing information is stored in a file system directory identified by the RootDirectoryPath property of a VerityIndexArea object.

    For each VerityCollection object in the Content Engine database, there is a corresponding collection maintained by the Verity software that holds the full-text index data. The name of this collection is identified by the 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 object associated with the appropriate base class, and uses this VerityCollection object. If a VerityCollection object is not found, a new VerityCollection object 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 object, or to UNAVAILABLE if the collection is expected to be made available again.

    The ResourceStatus property is set to FULL by the server when the number of rows in the collection is greater than the value of the MaxRowsPerCollection property of the associated VerityServerConfiguration object (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.

    Note Beginning in the 5.1.0 release, the Legacy Content Search Engine is deprecated and support will be removed in a future release.

    • Method Detail

      • get_Id

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

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

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

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

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

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

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

        java.util.Date get_StartDate()
        Deprecated. 
        Returns the value of the StartDate property. For more information, see StartDate Property.
      • get_EndDate

        java.util.Date get_EndDate()
        Deprecated. 
        Returns the value of the EndDate property. For more information, see EndDate Property.

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