Specifies the document's storage policy, which identifies the set of available storage areas that are considered equivalent based on common, user-specified criteria. Assigning a storage policy to a document is the recommended method of selecting a storage area. The alternative is to directly assign the storage area (specify the StorageArea property).

When a document is created, the order of precedence for setting the storage on the Document instance is (from highest to lowest):

  • instance value for the StorageArea property
  • class default for the StorageArea property
  • instance value for the StoragePolicy property
  • class default for the StoragePolicy property

The default ClassDefinition for a document sets the StorageArea to "Database Storage Area" and the StoragePolicy to "All Storage Areas". Therefore, if you create a new Document instance of the default Document ClassDefinition with only the StoragePolicy property set, the document will use the class default for the StorageArea property (Database Storage Area).

To avoid this situation, you must set the instance value for the document's StorageArea property to null. Because the instance value for StorageArea is set, but has no value, the StoragePolicy property will be evaluated and used.

In general, storage policies should be used to allow administrators to properly administer their storage systems. They can assign multiple storage areas to be load balanced, and also assign standby storage areas to be used if any of the current storage areas become full.


Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Property StoragePolicy As IStoragePolicy
C#
IStoragePolicy StoragePolicy { get; set; }
C++
property IStoragePolicy StoragePolicy abstract  {
    IStoragePolicy get();
    void set(IStoragePolicy value);
}
J#
/** property */
public IStoragePolicy get_StoragePolicy();

/** property */
public void set_StoragePolicy(IStoragePolicy value);
JScript
public function get StoragePolicy() : IStoragePolicy

public function set StoragePolicy(value : IStoragePolicy);

Remarks

See Also