The setting that enables or disables a cache area for active use. The CacheStatus enumeration
has constants defined for the cache status settings.
Namespace:
FileNet.Api.AdminValid settings are:
- OPEN (default setting): Enables the cache area for active use.
- CLOSED: Disables the cache area for active use.
- CLEARING: Disables the cache area for active use, deletes all content from the cache, initializes the values for all cache statistical properties, and automatically resets the cache status to the previous setting (OPEN or CLOSED). Once started, this cache clearing operation always completes; you cannot stop the operation or manually change the cache status from CLEARING to any other setting. In order for the clearing operation to be performed and for the cache status not to remain set to CLEARING indefinitely, at least one server must be associated with the same site as that of the content cache. For information on associating a content cache with a site, see the IContentCacheConfiguration interface.
Assembly: FileNet.Api (in FileNet.Api.dll)
Syntax
Visual Basic (Declaration) |
---|
Property CacheStatus As CacheStatus |
C# |
---|
CacheStatus CacheStatus { get; set; } |
Visual C++ |
---|
property CacheStatus CacheStatus { CacheStatus get (); void set (CacheStatus value); } |
JavaScript |
---|
function get_cacheStatus(); function set_cacheStatus(value); |
Remarks
Metadata
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 0
PropertyMaximumInteger32: 2
PropertyMinimumInteger32: 0
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ