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
ObjectStoreobject 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
ObjectStoreobject by iterating anObjectStoreSetcollection returned by theDomainobject. You can get an instance ofObjectStoreby:- Calling
createInstance,getInstance, orfetchInstanceon theFactory.ObjectStoreclass. - Calling
getObjectStoreon an instance of aRepositoryObjectsubclass.
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 Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method and Description IdListdeterminePrerequisiteAddOnIds(Id addOnId)Returns the feature addon IDs for which installation is required prior to the installation of the feature addon specified byaddOnId.IndependentObjectfetchAndLockObject(java.lang.String classIdent, Id objectId, long timeout, java.lang.String lockOwner, PropertyFilter filter)Retrieves and locks the specified object from thisObjectStoreobject.IndependentObjectfetchAndLockObject(java.lang.String classIdent, java.lang.String objectIdent, long timeout, java.lang.String lockOwner, PropertyFilter filter)Retrieves and locks the specified object from thisObjectStoreobject.AddOnInstallationRecordListget_AddOnInstallationRecords()Returns the value of the AddOnInstallationRecords property.java.lang.Integerget_AdvancedStorageDeletionDelay()Returns the value of the AdvancedStorageDeletionDelay property.CmAuditDispositionPolicySetget_AuditDispositionPolicies()Returns the value of the AuditDispositionPolicies property.AuditLevelget_AuditLevel()Returns the value of the AuditLevel property.CmAuditProcessingBookmarkSetget_AuditProcessingBookmarks()Returns the value of the AuditProcessingBookmarks property.CmBackgroundSearchSetget_BackgroundSearches()Returns the value of the BackgroundSearches property.java.lang.Integerget_CBRQueryDynamicThreshold()Returns the value of the CBRQueryDynamicThreshold property.CBRQueryOptimizationget_CBRQueryOptimization()Returns the value of the CBRQueryOptimization property.CBRQueryRankOverrideget_CBRQueryRankOverride()Returns the value of the CBRQueryRankOverride property.CBRSearchTypeget_CBRSearchType()Returns the value of the CBRSearchType property.java.lang.Integerget_CBRSummaryIndexingSize()Returns the value of the CBRSummaryIndexingSize property.java.lang.Integerget_CBRSummaryResultSize()Returns the value of the CBRSummaryResultSize property.CBRSummaryTypeget_CBRSummaryType()Returns the value of the CBRSummaryType property.CmChangePreprocessorActionSetget_ChangePreprocessorActions()Returns the value of the ChangePreprocessorActions property.ChoiceListSetget_ChoiceLists()Returns the value of the ChoiceLists property.ClassDescriptionSetget_ClassDescriptions()Returns the value of the ClassDescriptions property.ContentAccessRecordingLevelget_ContentAccessRecordingLevel()Returns the value of the ContentAccessRecordingLevel property.DatabaseCompressionModeget_DatabaseCompressionMode()Returns the value of the DatabaseCompressionMode property.CmDatabaseConnectionget_DatabaseConnection()Returns the value of the DatabaseConnection property.java.lang.Stringget_DatabaseIndexStorageLocation()Returns the value of the DatabaseIndexStorageLocation property.java.lang.Stringget_DatabaseLOBStorageLocation()Returns the value of the DatabaseLOBStorageLocation property.java.lang.Stringget_DatabaseSchemaName()Returns the value of the DatabaseSchemaName property.java.lang.Stringget_DatabaseTableStorageLocation()Returns the value of the DatabaseTableStorageLocation property.java.lang.Integerget_DefaultQueryTimeLimit()Returns the value of the DefaultQueryTimeLimit property.ReservationTypeget_DefaultReservationType()Returns the value of the DefaultReservationType property.java.lang.Stringget_DescriptiveText()Returns the value of the DescriptiveText property.DocumentClassificationActionSetget_DocumentClassificationActions()Returns the value of the DocumentClassificationActions property.DocumentLifecycleActionSetget_DocumentLifecycleActions()Returns the value of the DocumentLifecycleActions property.DocumentLifecyclePolicySetget_DocumentLifecyclePolicies()Returns the value of the DocumentLifecyclePolicies property.Domainget_Domain()Returns the value of the Domain property.StringListget_ElasticSearchAnalyzers()The list of analyzers enabled for Elastic Search indexing and search in this object store.EventActionSetget_EventActions()Returns the value of the EventActions property.java.lang.Integerget_FolderCacheMaxAgeDelta()Deprecated.As of release 4.0.1.java.lang.Integerget_FolderCacheMaxEntries()Returns the value of the FolderCacheMaxEntries property.java.lang.Integerget_FolderCacheReapFrequency()Deprecated.As of release 4.0.1.java.lang.Booleanget_ForceCaseInsensitiveSearch()Returns the value of the ForceCaseInsensitiveSearch property.java.lang.Integerget_FullTextRowDefault()Returns the value of the FullTextRowDefault property.java.lang.Integerget_FullTextRowMax()Returns the value of the FullTextRowMax property.IndexAreaSetget_IndexAreas()Returns the value of the IndexAreas property.IndexingFailureRecordingLevelget_IndexingFailureRecordingLevel()Returns the value of the IndexingFailureRecordingLevel property.IsolatedRegionSetget_IsolatedRegions()Returns the value of the IsolatedRegions property.java.lang.Stringget_LocaleName()Returns the value of the LocaleName property.StringListget_LocaleNames()Returns the value of the LocaleNames property.java.lang.Integerget_MaxQueryTimeLimit()Returns the value of the MaxQueryTimeLimit property.java.lang.Stringget_Name()Returns the value of the Name property.java.lang.Integerget_ObjectSecurityCacheEntryTTL()Returns the value of the ObjectSecurityCacheEntryTTL property.java.lang.Integerget_ObjectSecurityCacheMaxEntries()Returns the value of the ObjectSecurityCacheMaxEntries property.Idget_ObjectStoreId()Returns the value of the ObjectStoreId property.CmTextSearchPartitionPropertyListget_PartitioningProperties()Returns the value of the PartitioningProperties property.AccessPermissionListget_Permissions()Returns the value of the Permissions property.CmPolicyControlledSweepSetget_PolicyControlledSweeps()Returns the value of the PolicyControlledSweeps property.PropertyTemplateSetget_PropertyTemplates()Returns the value of the PropertyTemplates property.java.lang.Integerget_QueryDatabaseTimeout()Returns the value of the QueryDatabaseTimeout property.CmQueueSweepSetget_QueueSweeps()Returns the value of the QueueSweeps property.java.lang.Integerget_RoleCacheCheckInterval()Returns the value of the RoleCacheCheckInterval property.java.lang.Integerget_RoleCacheEntryTTL()Returns the value of the RoleCacheEntryTTL property.java.lang.Integerget_RoleCacheMaxEntries()Returns the value of the RoleCacheMaxEntries property.ClassDefinitionSetget_RootClassDefinitions()Returns the value of the RootClassDefinitions property.Folderget_RootFolder()Returns the value of the RootFolder property.java.lang.Stringget_SchemaVersion()Returns the value of the SchemaVersion property.java.lang.Integerget_SecurityDescCacheMaxEntries()Returns the value of the SecurityDescCacheMaxEntries property.java.lang.Integerget_SecurityIdMappingCacheMaxEntries()Returns the value of the SecurityIdMappingCacheMaxEntries property.SecurityPolicySetget_SecurityPolicies()Returns the value of the SecurityPolicies property.StorageAreaSetget_StorageAreas()Returns the value of the StorageAreas property.StoragePolicySetget_StoragePolicies()Returns the value of the StoragePolicies property.java.lang.Integerget_SubscriptionCacheMaxEntries()Returns the value of the SubscriptionCacheMaxEntries property.SubscriptionSetget_Subscriptions()Returns the value of the Subscriptions property.CmSweepJobSetget_SweepJobs()Returns the value of the SweepJobs property.CmSweepPolicySetget_SweepPolicies()Returns the value of the SweepPolicies property.java.lang.Stringget_SymbolicName()Returns the value of the SymbolicName property.TableDefinitionSetget_TableDefinitions()Returns the value of the TableDefinitions property.java.lang.Booleanget_TableOverflowEnabled()Returns the value of the TableOverflowEnabled property.java.lang.Booleanget_TextSearchEnabled()Returns the value of the TextSearchEnabled property.StringListget_TextSearchIndexingLanguages()Returns the value of the TextSearchIndexingLanguages property.FolderSetget_TopFolders()Returns the value of the TopFolders property.java.lang.Booleanget_UseSequentialIds()Returns the value of the UseSequentialIds property.WorkflowDefinitionSetget_WorkflowDefinitions()Returns the value of the WorkflowDefinitions property.XMLPropertyMappingScriptSetget_XMLPropertyMappingScripts()Returns the value of the XMLPropertyMappingScripts property.voidinstallAddOn(AddOn addOn)Installs an add-on, available on a domain, to the current object store.booleanisAddOnInstalled(Id addOnId)Returns a boolean value indicating whether the feature addon identified byaddOnIdis installed (true) or not (false) in the object store.voidset_AdvancedStorageDeletionDelay(java.lang.Integer value)Sets the value of the AdvancedStorageDeletionDelay property.voidset_AuditLevel(AuditLevel value)Sets the value of the AuditLevel property.voidset_CBRQueryDynamicThreshold(java.lang.Integer value)Sets the value of the CBRQueryDynamicThreshold property.voidset_CBRQueryOptimization(CBRQueryOptimization value)Sets the value of the CBRQueryOptimization property.voidset_CBRQueryRankOverride(CBRQueryRankOverride value)Sets the value of the CBRQueryRankOverride property.voidset_CBRSummaryIndexingSize(java.lang.Integer value)Sets the value of the CBRSummaryIndexingSize property.voidset_CBRSummaryResultSize(java.lang.Integer value)Sets the value of the CBRSummaryResultSize property.voidset_CBRSummaryType(CBRSummaryType value)Sets the value of the CBRSummaryType property.voidset_ContentAccessRecordingLevel(ContentAccessRecordingLevel value)Sets the value of the ContentAccessRecordingLevel property.voidset_DatabaseCompressionMode(DatabaseCompressionMode value)Sets the value of the DatabaseCompressionMode property.voidset_DatabaseConnection(CmDatabaseConnection value)Sets the value of the DatabaseConnection property.voidset_DatabaseIndexStorageLocation(java.lang.String value)Sets the value of the DatabaseIndexStorageLocation property.voidset_DatabaseLOBStorageLocation(java.lang.String value)Sets the value of the DatabaseLOBStorageLocation property.voidset_DatabaseSchemaName(java.lang.String value)Sets the value of the DatabaseSchemaName property.voidset_DatabaseTableStorageLocation(java.lang.String value)Sets the value of the DatabaseTableStorageLocation property.voidset_DefaultQueryTimeLimit(java.lang.Integer value)Sets the value of the DefaultQueryTimeLimit property.voidset_DefaultReservationType(ReservationType value)Sets the value of the DefaultReservationType property.voidset_DescriptiveText(java.lang.String value)Sets the value of the DescriptiveText property.voidset_ElasticSearchAnalyzers(StringList value)The list of analyzers enabled for Elastic Search indexing and search in this object store.voidset_FolderCacheMaxAgeDelta(java.lang.Integer value)Deprecated.As of release 4.0.1.voidset_FolderCacheMaxEntries(java.lang.Integer value)Sets the value of the FolderCacheMaxEntries property.voidset_FolderCacheReapFrequency(java.lang.Integer value)Deprecated.As of release 4.0.1.voidset_ForceCaseInsensitiveSearch(java.lang.Boolean value)Sets the value of the ForceCaseInsensitiveSearch property.voidset_FullTextRowDefault(java.lang.Integer value)Sets the value of the FullTextRowDefault property.voidset_FullTextRowMax(java.lang.Integer value)Sets the value of the FullTextRowMax property.voidset_IndexingFailureRecordingLevel(IndexingFailureRecordingLevel value)Sets the value of the IndexingFailureRecordingLevel property.voidset_MaxQueryTimeLimit(java.lang.Integer value)Sets the value of the MaxQueryTimeLimit property.voidset_ObjectSecurityCacheEntryTTL(java.lang.Integer value)Sets the value of the ObjectSecurityCacheEntryTTL property.voidset_ObjectSecurityCacheMaxEntries(java.lang.Integer value)Sets the value of the ObjectSecurityCacheMaxEntries property.voidset_Permissions(AccessPermissionList value)Sets the value of the Permissions property.voidset_QueryDatabaseTimeout(java.lang.Integer value)Sets the value of the QueryDatabaseTimeout property.voidset_RoleCacheCheckInterval(java.lang.Integer value)Sets the value of the RoleCacheCheckInterval property.voidset_RoleCacheEntryTTL(java.lang.Integer value)Sets the value of the RoleCacheEntryTTL property.voidset_RoleCacheMaxEntries(java.lang.Integer value)Sets the value of the RoleCacheMaxEntries property.voidset_SecurityDescCacheMaxEntries(java.lang.Integer value)Sets the value of the SecurityDescCacheMaxEntries property.voidset_SecurityIdMappingCacheMaxEntries(java.lang.Integer value)Sets the value of the SecurityIdMappingCacheMaxEntries property.voidset_SubscriptionCacheMaxEntries(java.lang.Integer value)Sets the value of the SubscriptionCacheMaxEntries property.voidset_SymbolicName(java.lang.String value)Sets the value of the SymbolicName property.voidset_TableOverflowEnabled(java.lang.Boolean value)Sets the value of the TableOverflowEnabled property.voidset_TextSearchEnabled(java.lang.Boolean value)Sets the value of the TextSearchEnabled property.voidset_TextSearchIndexingLanguages(StringList value)Sets the value of the TextSearchIndexingLanguages property.voidset_UseSequentialIds(java.lang.Boolean value)Sets the value of the UseSequentialIds property.-
Methods inherited from interface com.filenet.api.core.InstantiatingScope
createObject, createObject, fetchObject, fetchObject, getObject, getObject
-
Methods inherited from interface com.filenet.api.replication.Repository
get_Creator, get_DateCreated, get_DateLastModified, get_DisplayName, get_Id, get_LastModifier, get_Site, set_Creator, set_DateCreated, set_DisplayName, set_Site
-
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_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_LocaleNames
StringList get_LocaleNames()
Returns the value of the LocaleNames property. For more information, see LocaleNames Property.
-
get_ObjectStoreId
Id get_ObjectStoreId()
Returns the value of the ObjectStoreId property. For more information, see ObjectStoreId Property.
-
get_TopFolders
FolderSet get_TopFolders()
Returns the value of the TopFolders property. For more information, see TopFolders Property.
-
get_Name
java.lang.String get_Name()
Returns the value of the Name property. For more information, see Name 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_RootClassDefinitions
ClassDefinitionSet get_RootClassDefinitions()
Returns the value of the RootClassDefinitions property. For more information, see RootClassDefinitions Property.
-
get_PropertyTemplates
PropertyTemplateSet get_PropertyTemplates()
Returns the value of the PropertyTemplates property. For more information, see PropertyTemplates Property.
-
get_ChoiceLists
ChoiceListSet get_ChoiceLists()
Returns the value of the ChoiceLists property. For more information, see ChoiceLists Property.
-
get_StoragePolicies
StoragePolicySet get_StoragePolicies()
Returns the value of the StoragePolicies property. For more information, see StoragePolicies 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_EventActions
EventActionSet get_EventActions()
Returns the value of the EventActions property. For more information, see EventActions Property.
-
get_Subscriptions
SubscriptionSet get_Subscriptions()
Returns the value of the Subscriptions property. For more information, see Subscriptions Property.
-
get_DocumentLifecyclePolicies
DocumentLifecyclePolicySet get_DocumentLifecyclePolicies()
Returns the value of the DocumentLifecyclePolicies property. For more information, see DocumentLifecyclePolicies Property.
-
get_DocumentLifecycleActions
DocumentLifecycleActionSet get_DocumentLifecycleActions()
Returns the value of the DocumentLifecycleActions property. For more information, see DocumentLifecycleActions Property.
-
get_DocumentClassificationActions
DocumentClassificationActionSet get_DocumentClassificationActions()
Returns the value of the DocumentClassificationActions property. For more information, see DocumentClassificationActions Property.
-
get_XMLPropertyMappingScripts
XMLPropertyMappingScriptSet get_XMLPropertyMappingScripts()
Returns the value of the XMLPropertyMappingScripts property. For more information, see XMLPropertyMappingScripts Property.
-
get_WorkflowDefinitions
WorkflowDefinitionSet get_WorkflowDefinitions()
Returns the value of the WorkflowDefinitions property. For more information, see WorkflowDefinitions Property.
-
get_TableDefinitions
TableDefinitionSet get_TableDefinitions()
Returns the value of the TableDefinitions property. For more information, see TableDefinitions Property.
-
get_SecurityPolicies
SecurityPolicySet get_SecurityPolicies()
Returns the value of the SecurityPolicies property. For more information, see SecurityPolicies 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.
-
get_DefaultReservationType
ReservationType get_DefaultReservationType()
Returns the value of the DefaultReservationType property. For more information, see DefaultReservationType Property.
-
set_DefaultReservationType
void set_DefaultReservationType(ReservationType value)
Sets the value of the DefaultReservationType property. For more information, see DefaultReservationType Property.
-
get_ContentAccessRecordingLevel
ContentAccessRecordingLevel get_ContentAccessRecordingLevel()
Returns the value of the ContentAccessRecordingLevel property. For more information, see ContentAccessRecordingLevel Property.
-
set_ContentAccessRecordingLevel
void set_ContentAccessRecordingLevel(ContentAccessRecordingLevel value)
Sets the value of the ContentAccessRecordingLevel property. For more information, see ContentAccessRecordingLevel Property.
-
get_AuditLevel
AuditLevel get_AuditLevel()
Returns the value of the AuditLevel property. For more information, see AuditLevel 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_StorageAreas
StorageAreaSet get_StorageAreas()
Returns the value of the StorageAreas property. For more information, see StorageAreas Property.
-
get_Domain
Domain get_Domain()
Returns the value of the Domain property. For more information, see Domain Property.
-
get_IndexAreas
IndexAreaSet get_IndexAreas()
Returns the value of the IndexAreas property. For more information, see IndexAreas 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_AddOnInstallationRecords
AddOnInstallationRecordList get_AddOnInstallationRecords()
Returns the value of the AddOnInstallationRecords property. For more information, see AddOnInstallationRecords 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_CBRSearchType
CBRSearchType get_CBRSearchType()
Returns the value of the CBRSearchType property. For more information, see CBRSearchType 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_PartitioningProperties
CmTextSearchPartitionPropertyList get_PartitioningProperties()
Returns the value of the PartitioningProperties property. For more information, see PartitioningProperties Property.
-
get_AuditDispositionPolicies
CmAuditDispositionPolicySet get_AuditDispositionPolicies()
Returns the value of the AuditDispositionPolicies property. For more information, see AuditDispositionPolicies Property.
-
get_AuditProcessingBookmarks
CmAuditProcessingBookmarkSet get_AuditProcessingBookmarks()
Returns the value of the AuditProcessingBookmarks property. For more information, see AuditProcessingBookmarks 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_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_ChangePreprocessorActions
CmChangePreprocessorActionSet get_ChangePreprocessorActions()
Returns the value of the ChangePreprocessorActions property. For more information, see ChangePreprocessorActions Property.
-
get_IndexingFailureRecordingLevel
IndexingFailureRecordingLevel get_IndexingFailureRecordingLevel()
Returns the value of the IndexingFailureRecordingLevel property. For more information, see IndexingFailureRecordingLevel Property.
-
set_IndexingFailureRecordingLevel
void set_IndexingFailureRecordingLevel(IndexingFailureRecordingLevel value)
Sets the value of the IndexingFailureRecordingLevel property. For more information, see IndexingFailureRecordingLevel Property.
-
get_DatabaseConnection
CmDatabaseConnection get_DatabaseConnection()
Returns the value of the DatabaseConnection property. For more information, see DatabaseConnection Property.
-
set_DatabaseConnection
void set_DatabaseConnection(CmDatabaseConnection value)
Sets the value of the DatabaseConnection property. For more information, see DatabaseConnection 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_CBRQueryOptimization
CBRQueryOptimization get_CBRQueryOptimization()
Returns the value of the CBRQueryOptimization property. For more information, see CBRQueryOptimization Property.
-
set_CBRQueryOptimization
void set_CBRQueryOptimization(CBRQueryOptimization value)
Sets the value of the CBRQueryOptimization property. For more information, see CBRQueryOptimization 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_CBRQueryRankOverride
CBRQueryRankOverride get_CBRQueryRankOverride()
Returns the value of the CBRQueryRankOverride property. For more information, see CBRQueryRankOverride Property.
-
set_CBRQueryRankOverride
void set_CBRQueryRankOverride(CBRQueryRankOverride value)
Sets the value of the CBRQueryRankOverride property. For more information, see CBRQueryRankOverride 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_TextSearchIndexingLanguages
StringList get_TextSearchIndexingLanguages()
Returns the value of the TextSearchIndexingLanguages property. For more information, see TextSearchIndexingLanguages Property.
-
set_TextSearchIndexingLanguages
void set_TextSearchIndexingLanguages(StringList value)
Sets the value of the TextSearchIndexingLanguages property. For more information, see TextSearchIndexingLanguages Property.
-
get_IsolatedRegions
IsolatedRegionSet get_IsolatedRegions()
Returns the value of the IsolatedRegions property. For more information, see IsolatedRegions Property.
-
get_PolicyControlledSweeps
CmPolicyControlledSweepSet get_PolicyControlledSweeps()
Returns the value of the PolicyControlledSweeps property. For more information, see PolicyControlledSweeps Property.
-
get_QueueSweeps
CmQueueSweepSet get_QueueSweeps()
Returns the value of the QueueSweeps property. For more information, see QueueSweeps Property.
-
get_SweepJobs
CmSweepJobSet get_SweepJobs()
Returns the value of the SweepJobs property. For more information, see SweepJobs Property.
-
get_SweepPolicies
CmSweepPolicySet get_SweepPolicies()
Returns the value of the SweepPolicies property. For more information, see SweepPolicies Property.
-
get_CBRSummaryType
CBRSummaryType get_CBRSummaryType()
Returns the value of the CBRSummaryType property. For more information, see CBRSummaryType Property.
-
set_CBRSummaryType
void set_CBRSummaryType(CBRSummaryType value)
Sets the value of the CBRSummaryType property. For more information, see CBRSummaryType 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.
-
get_AdvancedStorageDeletionDelay
java.lang.Integer get_AdvancedStorageDeletionDelay()
Returns the value of the AdvancedStorageDeletionDelay property. For more information, see AdvancedStorageDeletionDelay Property.
-
set_AdvancedStorageDeletionDelay
void set_AdvancedStorageDeletionDelay(java.lang.Integer value)
Sets the value of the AdvancedStorageDeletionDelay property. For more information, see AdvancedStorageDeletionDelay Property.
-
get_UseSequentialIds
java.lang.Boolean get_UseSequentialIds()
Returns the value of the UseSequentialIds property. For more information, see UseSequentialIds Property.
-
set_UseSequentialIds
void set_UseSequentialIds(java.lang.Boolean value)
Sets the value of the UseSequentialIds property. For more information, see UseSequentialIds Property.
-
get_BackgroundSearches
CmBackgroundSearchSet get_BackgroundSearches()
Returns the value of the BackgroundSearches property. For more information, see BackgroundSearches Property.
-
get_SecurityIdMappingCacheMaxEntries
java.lang.Integer get_SecurityIdMappingCacheMaxEntries()
Returns the value of the SecurityIdMappingCacheMaxEntries property. For more information, see SecurityIdMappingCacheMaxEntries Property.
-
set_SecurityIdMappingCacheMaxEntries
void set_SecurityIdMappingCacheMaxEntries(java.lang.Integer value)
Sets the value of the SecurityIdMappingCacheMaxEntries property. For more information, see SecurityIdMappingCacheMaxEntries Property.
-
get_DatabaseCompressionMode
DatabaseCompressionMode get_DatabaseCompressionMode()
Returns the value of the DatabaseCompressionMode property. For more information, see DatabaseCompressionMode Property.
-
set_DatabaseCompressionMode
void set_DatabaseCompressionMode(DatabaseCompressionMode value)
Sets the value of the DatabaseCompressionMode property. For more information, see DatabaseCompressionMode Property.
-
get_RoleCacheEntryTTL
java.lang.Integer get_RoleCacheEntryTTL()
Returns the value of the RoleCacheEntryTTL property. For more information, see RoleCacheEntryTTL Property.
-
set_RoleCacheEntryTTL
void set_RoleCacheEntryTTL(java.lang.Integer value)
Sets the value of the RoleCacheEntryTTL property. For more information, see RoleCacheEntryTTL Property.
-
get_RoleCacheMaxEntries
java.lang.Integer get_RoleCacheMaxEntries()
Returns the value of the RoleCacheMaxEntries property. For more information, see RoleCacheMaxEntries Property.
-
set_RoleCacheMaxEntries
void set_RoleCacheMaxEntries(java.lang.Integer value)
Sets the value of the RoleCacheMaxEntries property. For more information, see RoleCacheMaxEntries Property.
-
get_RoleCacheCheckInterval
java.lang.Integer get_RoleCacheCheckInterval()
Returns the value of the RoleCacheCheckInterval property. For more information, see RoleCacheCheckInterval Property.
-
set_RoleCacheCheckInterval
void set_RoleCacheCheckInterval(java.lang.Integer value)
Sets the value of the RoleCacheCheckInterval property. For more information, see RoleCacheCheckInterval Property.
-
get_ElasticSearchAnalyzers
StringList get_ElasticSearchAnalyzers()
The list of analyzers enabled for Elastic Search indexing and search in this object store.
-
set_ElasticSearchAnalyzers
void set_ElasticSearchAnalyzers(StringList value)
The list of analyzers enabled for Elastic Search indexing and search in this object store. Settability Restrictions: None.
-
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 thisObjectStoreobject. 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
nullfor thefilterparameter, this method returns values for all non-object properties and returns placeholders for all object-valued properties. For more information, see the description of thefilterparameter.- 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- AStringrepresenting 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- APropertyFilterobject that represents information for controlling which property values (and with what level of detail and recursion) to return. Ifnull, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObjectproperties with a state ofPropertyState.UNEVALUATEDorPropertyState.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.
-
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
AddOnInstallationRecordobject 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- AnAddOnobject that specifies the add-on to install.
- If the add-on doesn't have an installation record, the installation is attempted and an
-
fetchAndLockObject
IndependentObject fetchAndLockObject(java.lang.String classIdent, Id objectId, long timeout, java.lang.String lockOwner, PropertyFilter filter)
Retrieves and locks the specified object from thisObjectStoreobject. 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
nullfor thefilterparameter, this method returns values for all non-object properties and returns placeholders for all object-valued properties. For more information, see the description of thefilterparameter.- 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- AStringrepresenting 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- APropertyFilterobject that represents information for controlling which property values (and with what level of detail and recursion) to return. Ifnull, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObjectproperties with a state ofPropertyState.UNEVALUATEDorPropertyState.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.
-
get_ClassDescriptions
ClassDescriptionSet get_ClassDescriptions()
Returns the value of the ClassDescriptions property. For more information, see ClassDescriptions Property.
-
isAddOnInstalled
boolean isAddOnInstalled(Id addOnId)
Returns a boolean value indicating whether the feature addon identified byaddOnIdis installed (true) or not (false) in the object store. If the feature addon identified byaddOnIdhas been superseded and the superseded addon is currently installed, a value oftrueis returned.- Parameters:
addOnId- AnIdobject identifying the feature addon to check per the previously stated semantics.- Returns:
- A boolean value indicating whether or not the feature addon identified by
addOnIdor 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 byaddOnId. If the addon specified byaddOnIdhas been superseded, then the results are based on the superseding addon prerequisites.- Parameters:
addOnId- AnIdobject 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.
-
-