com.filenet.api.core

Interface ObjectStore

  • All Superinterfaces:
    EngineObject, IndependentlyPersistableObject, IndependentObject, InstantiatingScope, Repository, Scope, java.io.Serializable


    public interface ObjectStore
    extends InstantiatingScope, Repository
    Represents a location in which folders, documents, and custom objects are stored, accessed, and managed on the Content Engine server.

    An ObjectStore object provides access to metadata and Content Engine objects, such as class descriptions, property descriptions, security policies, and so on. Using methods on this interface, you can retrieve this information, create and store new objects in the object store, and retrieve its installed feature add-ons.

    You can get a reference to an ObjectStore object by iterating an ObjectStoreSet collection returned by the Domain object. You can get an instance of ObjectStore by:

    • Calling createInstance, getInstance, or fetchInstance on the Factory.ObjectStore class.
    • Calling getObjectStore on an instance of a RepositoryObject subclass.

    You can configure an object store to share database connections with event export stores, isolated regions, or other object stores, depending on how you set the DatabaseConnection property.

    Metadata

    See Also:
    CmDatabaseConnection
    • Method Detail

      • 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_LocaleName

        java.lang.String get_LocaleName()
        Returns the value of the LocaleName property. For more information, see LocaleName Property.
      • get_ObjectStoreId

        Id get_ObjectStoreId()
        Returns the value of the ObjectStoreId property. For more information, see ObjectStoreId Property.
      • get_Name

        java.lang.String get_Name()
        Returns the value of the Name property. For more information, see Name Property.
      • get_JNDIDataSource

        java.lang.String get_JNDIDataSource()
        Deprecated. As of release 5.2.0.
        Returns the value of the JNDIDataSource property. For more information, see JNDIDataSource Property.
      • set_JNDIDataSource

        void set_JNDIDataSource(java.lang.String value)
        Deprecated. As of release 5.2.0.
        Sets the value of the JNDIDataSource property. For more information, see JNDIDataSource Property.
      • get_JNDIXADataSource

        java.lang.String get_JNDIXADataSource()
        Deprecated. As of release 5.2.0.
        Returns the value of the JNDIXADataSource property. For more information, see JNDIXADataSource Property.
      • set_JNDIXADataSource

        void set_JNDIXADataSource(java.lang.String value)
        Deprecated. As of release 5.2.0.
        Sets the value of the JNDIXADataSource property. For more information, see JNDIXADataSource Property.
      • get_DatabaseType

        DatabaseType get_DatabaseType()
        Deprecated. As of release 5.2.0.
        Returns the value of the DatabaseType property. For more information, see DatabaseType Property.
      • get_DefaultQueryTimeLimit

        java.lang.Integer get_DefaultQueryTimeLimit()
        Returns the value of the DefaultQueryTimeLimit property. For more information, see DefaultQueryTimeLimit Property.
      • set_DefaultQueryTimeLimit

        void set_DefaultQueryTimeLimit(java.lang.Integer value)
        Sets the value of the DefaultQueryTimeLimit property. For more information, see DefaultQueryTimeLimit Property.
      • get_MaxQueryTimeLimit

        java.lang.Integer get_MaxQueryTimeLimit()
        Returns the value of the MaxQueryTimeLimit property. For more information, see MaxQueryTimeLimit Property.
      • set_MaxQueryTimeLimit

        void set_MaxQueryTimeLimit(java.lang.Integer value)
        Sets the value of the MaxQueryTimeLimit property. For more information, see MaxQueryTimeLimit Property.
      • get_RootFolder

        Folder get_RootFolder()
        Returns the value of the RootFolder property. For more information, see RootFolder Property.
      • get_SymbolicName

        java.lang.String get_SymbolicName()
        Returns the value of the SymbolicName property. For more information, see SymbolicName Property.
      • set_SymbolicName

        void set_SymbolicName(java.lang.String value)
        Sets the value of the SymbolicName property. For more information, see SymbolicName Property.
      • set_AuditLevel

        void set_AuditLevel(AuditLevel value)
        Sets the value of the AuditLevel property. For more information, see AuditLevel Property.
      • get_ForceCaseInsensitiveSearch

        java.lang.Boolean get_ForceCaseInsensitiveSearch()
        Returns the value of the ForceCaseInsensitiveSearch property. For more information, see ForceCaseInsensitiveSearch Property.
      • set_ForceCaseInsensitiveSearch

        void set_ForceCaseInsensitiveSearch(java.lang.Boolean value)
        Sets the value of the ForceCaseInsensitiveSearch property. For more information, see ForceCaseInsensitiveSearch Property.
      • get_Domain

        Domain get_Domain()
        Returns the value of the Domain property. For more information, see Domain Property.
      • get_FullTextRowMax

        java.lang.Integer get_FullTextRowMax()
        Returns the value of the FullTextRowMax property. For more information, see FullTextRowMax Property.
      • set_FullTextRowMax

        void set_FullTextRowMax(java.lang.Integer value)
        Sets the value of the FullTextRowMax property. For more information, see FullTextRowMax Property.
      • get_FullTextRowDefault

        java.lang.Integer get_FullTextRowDefault()
        Returns the value of the FullTextRowDefault property. For more information, see FullTextRowDefault Property.
      • set_FullTextRowDefault

        void set_FullTextRowDefault(java.lang.Integer value)
        Sets the value of the FullTextRowDefault property. For more information, see FullTextRowDefault Property.
      • get_CBRLocale

        java.lang.String get_CBRLocale()
        Deprecated. As of release 5.2.0
        Returns the value of the CBRLocale property. For more information, see CBRLocale Property.
      • set_CBRLocale

        void set_CBRLocale(java.lang.String value)
        Deprecated. As of release 5.2.0
        Sets the value of the CBRLocale property. For more information, see CBRLocale Property.
      • get_SecurityDescCacheMaxEntries

        java.lang.Integer get_SecurityDescCacheMaxEntries()
        Returns the value of the SecurityDescCacheMaxEntries property. For more information, see SecurityDescCacheMaxEntries Property.
      • set_SecurityDescCacheMaxEntries

        void set_SecurityDescCacheMaxEntries(java.lang.Integer value)
        Sets the value of the SecurityDescCacheMaxEntries property. For more information, see SecurityDescCacheMaxEntries Property.
      • get_ObjectSecurityCacheMaxEntries

        java.lang.Integer get_ObjectSecurityCacheMaxEntries()
        Returns the value of the ObjectSecurityCacheMaxEntries property. For more information, see ObjectSecurityCacheMaxEntries Property.
      • set_ObjectSecurityCacheMaxEntries

        void set_ObjectSecurityCacheMaxEntries(java.lang.Integer value)
        Sets the value of the ObjectSecurityCacheMaxEntries property. For more information, see ObjectSecurityCacheMaxEntries Property.
      • get_ObjectSecurityCacheEntryTTL

        java.lang.Integer get_ObjectSecurityCacheEntryTTL()
        Returns the value of the ObjectSecurityCacheEntryTTL property. For more information, see ObjectSecurityCacheEntryTTL Property.
      • set_ObjectSecurityCacheEntryTTL

        void set_ObjectSecurityCacheEntryTTL(java.lang.Integer value)
        Sets the value of the ObjectSecurityCacheEntryTTL property. For more information, see ObjectSecurityCacheEntryTTL Property.
      • get_FolderCacheMaxEntries

        java.lang.Integer get_FolderCacheMaxEntries()
        Returns the value of the FolderCacheMaxEntries property. For more information, see FolderCacheMaxEntries Property.
      • set_FolderCacheMaxEntries

        void set_FolderCacheMaxEntries(java.lang.Integer value)
        Sets the value of the FolderCacheMaxEntries property. For more information, see FolderCacheMaxEntries Property.
      • get_FolderCacheReapFrequency

        java.lang.Integer get_FolderCacheReapFrequency()
        Deprecated. As of release 4.0.1.
        Returns the value of the FolderCacheReapFrequency property. For more information, see FolderCacheReapFrequency Property.
      • set_FolderCacheReapFrequency

        void set_FolderCacheReapFrequency(java.lang.Integer value)
        Deprecated. As of release 4.0.1.
        Sets the value of the FolderCacheReapFrequency property. For more information, see FolderCacheReapFrequency Property.
      • get_FolderCacheMaxAgeDelta

        java.lang.Integer get_FolderCacheMaxAgeDelta()
        Deprecated. As of release 4.0.1.
        Returns the value of the FolderCacheMaxAgeDelta property. For more information, see FolderCacheMaxAgeDelta Property.
      • set_FolderCacheMaxAgeDelta

        void set_FolderCacheMaxAgeDelta(java.lang.Integer value)
        Deprecated. As of release 4.0.1.
        Sets the value of the FolderCacheMaxAgeDelta property. For more information, see FolderCacheMaxAgeDelta Property.
      • get_DatabaseIndexStorageLocation

        java.lang.String get_DatabaseIndexStorageLocation()
        Returns the value of the DatabaseIndexStorageLocation property. For more information, see DatabaseIndexStorageLocation Property.
      • set_DatabaseIndexStorageLocation

        void set_DatabaseIndexStorageLocation(java.lang.String value)
        Sets the value of the DatabaseIndexStorageLocation property. For more information, see DatabaseIndexStorageLocation Property.
      • get_DatabaseTableStorageLocation

        java.lang.String get_DatabaseTableStorageLocation()
        Returns the value of the DatabaseTableStorageLocation property. For more information, see DatabaseTableStorageLocation Property.
      • set_DatabaseTableStorageLocation

        void set_DatabaseTableStorageLocation(java.lang.String value)
        Sets the value of the DatabaseTableStorageLocation property. For more information, see DatabaseTableStorageLocation Property.
      • get_DatabaseLOBStorageLocation

        java.lang.String get_DatabaseLOBStorageLocation()
        Returns the value of the DatabaseLOBStorageLocation property. For more information, see DatabaseLOBStorageLocation Property.
      • set_DatabaseLOBStorageLocation

        void set_DatabaseLOBStorageLocation(java.lang.String value)
        Sets the value of the DatabaseLOBStorageLocation property. For more information, see DatabaseLOBStorageLocation Property.
      • get_SchemaVersion

        java.lang.String get_SchemaVersion()
        Returns the value of the SchemaVersion property. For more information, see SchemaVersion Property.
      • get_VerityPartitionProperty

        java.lang.String get_VerityPartitionProperty()
        Deprecated. As of release 5.2.0.
        Returns the value of the VerityPartitionProperty property. For more information, see VerityPartitionProperty Property.
      • set_VerityPartitionProperty

        void set_VerityPartitionProperty(java.lang.String value)
        Deprecated. As of release 5.2.0.
        Sets the value of the VerityPartitionProperty property. For more information, see VerityPartitionProperty Property.
      • get_VerityPartitionInterval

        java.lang.Integer get_VerityPartitionInterval()
        Deprecated. As of release 5.2.0.
        Returns the value of the VerityPartitionInterval property. For more information, see VerityPartitionInterval Property.
      • set_VerityPartitionInterval

        void set_VerityPartitionInterval(java.lang.Integer value)
        Deprecated. As of release 5.2.0.
        Sets the value of the VerityPartitionInterval property. For more information, see VerityPartitionInterval Property.
      • get_CBRPreFilterEnabled

        java.lang.Boolean get_CBRPreFilterEnabled()
        Deprecated. As of release 5.1.0.
        Returns the value of the CBRPreFilterEnabled property. For more information, see CBRPreFilterEnabled Property.
      • set_CBRPreFilterEnabled

        void set_CBRPreFilterEnabled(java.lang.Boolean value)
        Deprecated. As of release 5.1.0.
        Sets the value of the CBRPreFilterEnabled property. For more information, see CBRPreFilterEnabled Property.
      • get_TextSearchEnabled

        java.lang.Boolean get_TextSearchEnabled()
        Returns the value of the TextSearchEnabled property. For more information, see TextSearchEnabled Property.
      • set_TextSearchEnabled

        void set_TextSearchEnabled(java.lang.Boolean value)
        Sets the value of the TextSearchEnabled property. For more information, see TextSearchEnabled Property.
      • get_TableOverflowEnabled

        java.lang.Boolean get_TableOverflowEnabled()
        Returns the value of the TableOverflowEnabled property. For more information, see TableOverflowEnabled Property.
      • set_TableOverflowEnabled

        void set_TableOverflowEnabled(java.lang.Boolean value)
        Sets the value of the TableOverflowEnabled property. For more information, see TableOverflowEnabled Property.
      • get_TextSearchIndexingLanguage

        java.lang.String get_TextSearchIndexingLanguage()
        Deprecated. As of release 5.2.0.
        Returns the value of the TextSearchIndexingLanguage property. For more information, see TextSearchIndexingLanguage Property.
      • set_TextSearchIndexingLanguage

        void set_TextSearchIndexingLanguage(java.lang.String value)
        Deprecated. As of release 5.2.0.
        Sets the value of the TextSearchIndexingLanguage property. For more information, see TextSearchIndexingLanguage Property.
      • get_DatabaseSchemaName

        java.lang.String get_DatabaseSchemaName()
        Returns the value of the DatabaseSchemaName property. For more information, see DatabaseSchemaName Property.
      • set_DatabaseSchemaName

        void set_DatabaseSchemaName(java.lang.String value)
        Sets the value of the DatabaseSchemaName property. For more information, see DatabaseSchemaName Property.
      • get_SubscriptionCacheMaxEntries

        java.lang.Integer get_SubscriptionCacheMaxEntries()
        Returns the value of the SubscriptionCacheMaxEntries property. For more information, see SubscriptionCacheMaxEntries Property.
      • set_SubscriptionCacheMaxEntries

        void set_SubscriptionCacheMaxEntries(java.lang.Integer value)
        Sets the value of the SubscriptionCacheMaxEntries property. For more information, see SubscriptionCacheMaxEntries Property.
      • get_CBRQueryDynamicThreshold

        java.lang.Integer get_CBRQueryDynamicThreshold()
        Returns the value of the CBRQueryDynamicThreshold property. For more information, see CBRQueryDynamicThreshold Property.
      • set_CBRQueryDynamicThreshold

        void set_CBRQueryDynamicThreshold(java.lang.Integer value)
        Sets the value of the CBRQueryDynamicThreshold property. For more information, see CBRQueryDynamicThreshold Property.
      • get_QueryDatabaseTimeout

        java.lang.Integer get_QueryDatabaseTimeout()
        Returns the value of the QueryDatabaseTimeout property. For more information, see QueryDatabaseTimeout Property.
      • set_QueryDatabaseTimeout

        void set_QueryDatabaseTimeout(java.lang.Integer value)
        Sets the value of the QueryDatabaseTimeout property. For more information, see QueryDatabaseTimeout Property.
      • get_CBRSummaryIndexingSize

        java.lang.Integer get_CBRSummaryIndexingSize()
        Returns the value of the CBRSummaryIndexingSize property. For more information, see CBRSummaryIndexingSize Property.
      • set_CBRSummaryIndexingSize

        void set_CBRSummaryIndexingSize(java.lang.Integer value)
        Sets the value of the CBRSummaryIndexingSize property. For more information, see CBRSummaryIndexingSize Property.
      • get_CBRSummaryResultSize

        java.lang.Integer get_CBRSummaryResultSize()
        Returns the value of the CBRSummaryResultSize property. For more information, see CBRSummaryResultSize Property.
      • set_CBRSummaryResultSize

        void set_CBRSummaryResultSize(java.lang.Integer value)
        Sets the value of the CBRSummaryResultSize property. For more information, see CBRSummaryResultSize Property.
      • installAddOn

        void installAddOn(AddOn addOn)
        Installs an add-on, available on a domain, to the current object store. When an add-on is installed, the pre-import script (if one exists) is run. Then the import data is imported into the object store, creating new metadata classes, properties, and data objects. Finally, the post-import script is run.

        This method results in one of the following outcomes:

        • If the add-on doesn't have an installation record, the installation is attempted and an AddOnInstallationRecord object is created.
        • If the add-on has an installation record with a status of "InstallationFailed", the installation is re-attempted and the installation record's properties are updated.
        • If the add-on has an installation record with a status of "Installed", an exception (indicating that the add-on is already installed) is thrown.
        Parameters:
        addOn - An AddOn object that specifies the add-on to install.
      • fetchAndLockObject

        IndependentObject fetchAndLockObject(java.lang.String classIdent,
                                           java.lang.String objectIdent,
                                           long timeout,
                                           java.lang.String lockOwner,
                                           PropertyFilter filter)
        Retrieves and locks the specified object from this ObjectStore object. Use parameters on this method to specify the owner of the lock and the lock timeout value. This method always makes a round-trip to the server.

        You can optionally include a filter to control which properties to return with the object. If you pass in null for the filter parameter, this method returns values for all non-object properties and returns placeholders for all object-valued properties. For more information, see the description of the filter parameter.

        Parameters:
        classIdent - The class of the object to be retrieved and locked. You can specify the value of this parameter as an ID (a string containing a GUID) or a symbolic name.
        objectIdent - The ID of the object to retrieve. You can specify the value of this parameter as an ID (a string containing a GUID), a path, or a symbolic name.
        timeout - An integer that represents the number of seconds after which the lock will expire. The range of values is 0 to 2147483647 (Integer.MAX_VALUE) seconds.
        lockOwner - A String representing the user name to be assigned as the owner of the lock on this object. The value defaults to the short principal name of the requesting user. The value is strictly advisory and is not validated against user or group names known to the Content Engine. The value can be used by client applications to identify the user who has locked the object.
        filter - A PropertyFilter object that represents information for controlling which property values (and with what level of detail and recursion) to return. If null, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObject properties with a state of PropertyState.UNEVALUATED or PropertyState.REFERENCE); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.
        Returns:
        An object of the requested type.
      • fetchAndLockObject

        IndependentObject fetchAndLockObject(java.lang.String classIdent,
                                           Id objectId,
                                           long timeout,
                                           java.lang.String lockOwner,
                                           PropertyFilter filter)
        Retrieves and locks the specified object from this ObjectStore object. Use parameters on this method to specify the owner of the lock and the lock timeout value. This method always makes a round-trip to the server.

        You can optionally include a filter to control which properties to return with the object. If you pass in null for the filter parameter, this method returns values for all non-object properties and returns placeholders for all object-valued properties. For more information, see the description of the filter parameter.

        Parameters:
        classIdent - The class of the object to be retrieved and locked. You can specify this value as an ID (a string containing a GUID) or a symbolic name.
        objectId - The ID (GUID) of the object to retrieve.
        timeout - An integer that represents the number of seconds after which the lock will expire. The range of values is 0 to 2147483647 (Integer.MAX_VALUE) seconds.
        lockOwner - A String representing the user name to be assigned as the owner of the lock on this object. The value defaults to the short principal name of the requesting user. The value is strictly advisory and is not validated against user or group names known to the Content Engine. The value can be used by applications such as WebDAV to identify the user who has locked the object.
        filter - A PropertyFilter object that represents information for controlling which property values (and with what level of detail and recursion) to return. If null, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObject properties with a state of PropertyState.UNEVALUATED or PropertyState.REFERENCE); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.
        Returns:
        An object of the requested type.
      • isAddOnInstalled

        boolean isAddOnInstalled(Id addOnId)
        Returns a boolean value indicating whether the feature addon identified by addOnId is installed (true) or not (false) in the object store. If the feature addon identified by addOnId has been superseded and the superseded addon is currently installed, a value of true is returned.
        Parameters:
        addOnId - An Id object identifying the feature addon to check per the previously stated semantics.
        Returns:
        A boolean value indicating whether or not the feature addon identified by addOnId or that addon's superseding version is installed.
      • determinePrerequisiteAddOnIds

        IdList determinePrerequisiteAddOnIds(Id addOnId)
        Returns the feature addon IDs for which installation is required prior to the installation of the feature addon specified by addOnId. If the addon specified by addOnId has been superseded, then the results are based on the superseding addon prerequisites.
        Parameters:
        addOnId - An Id object representing the ID of the feature addon to be installed. Example: SystemAddOnId.PUBLISHING
        Returns:
        A collection of addon IDs that must be installed prior to installation of the feature addon specified by addOnId.

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