The IStoragePolicy type exposes the following members.

ToggleProperties

Type NameDescription
Public propertyAuditedEvents
An EventSet collection of the Event objects containing the audited events that have occurred for the object.
Public propertyClassDescription
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.)
Public propertyCreator
Indicates the name of the user assigned as the creator of the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Public propertyDateCreated
Indicates the date and time the object was created. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Public propertyDateLastModified
Indicates the date and time the object was last modified. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Public propertyDescriptiveText
User-readable text that describes an object.

The text is not locale-specific to the retrieving user except for the following classes:

  • ClassDescription
  • PropertyDescription
  • ClassDefinition
  • PropertyTemplate
  • PropertyDefinition
Public propertyDisplayName
The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.

For ICmAuditProcessingBookmark and IAuditDefinition objects, this property is intended to identify client applications that process the audit log. For ICmAuditProcessingBookmark objects, this property, in support of the audit disposition feature, identifies the client that created the object. For IAuditDefinition objects, this property identifies a set of audit definitions for a given client or client functionality.

For ICmAuditProcessingBookmark and IAuditDefinition objects, it is recommended that you set this property. Specify a unique value to distinguish one client application from another. Note, however, that the server does not prevent identical display names across multiple ICmAuditProcessingBookmark or IAuditDefinition objects. Therefore, the client application is responsible for enforcing uniqueness.

Public propertyExternalReplicaIdentities
Specifies an ExternalIdentityList collection of the read-only ExternalIdentity objects that represent the identities of replicas of this object in external repositories.
(Inherited from IReplicable.)
Public propertyFilterExpression
The text of a filter expression that, when evaluated, determines the action to be taken on the object. This property applies to IStoragePolicy, ISubscription, IAuditDefinition, ICmSweepPolicy, and ICmSweepJob objects.

For a IStoragePolicy object, FilterExpression is used as the selection criteria for determining into which storage area the content for a document or annotation should be stored. The expression is evaluated against all storage areas to determine which ones are deemed "equivalent" in terms of this storage policy. For more information, see Storage policies.

For a ISubscription-based object, FilterExpression is used to determine whether the event action should be launched. For IAuditDefinition, FilterExpression is used to determine whether an event should be audited. The filter is applied to either the source object, or optionally, to the object specified in the FilteredPropertyId property of ISubscription or IAuditDefinition. Note that for version series subscriptions, the filter is applied to the document version in the transaction and not to the version series.

For ISubscription, the Content Engine server evaluates the filter expression, as follows:

  • If the value of the expression evaluates to true, the event specified by the subscription is fired or enqueued, as appropriate (depending on whether the event code is set to execute synchronously or asynchronously).
  • If the value evaluates to false or unknown (typically resulting from a property that has no value), or if there is an error in the evaluation (such as a syntax error in the expression or an incorrect reference to a property), the event is silently discarded.

For a sweep job or sweep policy, FilterExpression is used to evaluate each instance of of the sweep-target class. If the value of the expression evaluates to true, an operation is applied to the instance. The operation performed depends on the type of sweep.

For IAuditDefinition objects, FilterExpression is only applicable to events of type IObjectChangeEvent. If the value of the expression evaluates to true, the event is audited; otherwise, it is not audited.

The syntax of this property must be a fragment of a SQL where-clause expression (for example, VersionStatus = 1) and use supported operators. See SQL Syntax Reference.

Note that some operators that are valid in an ad hoc SQL query are not supported in FilterExpression. The following operators are not supported.

  • Binary compare operators (e.g., Equal Binary)
  • Contains
  • Exists
  • Float64 To Integer 32 Round/Truncate
  • In Folder and In Subfolder
  • Integer32 To Float 32
  • IsDefined
  • Joins (e.g., Full Outer Join)

Note that a filter expression can include conditions expressed against non-queryable and non-persistent properties. For example, the following is a valid expression: Owner='jsmith'

For ISubscription and IAuditDefinition objects only, you can use the IsModified predicate, for filtering events based on modified properties of the source object.

A filter expression using the IsModified predicate must be constructed as follows: IsModified(property), where property can be in any form supported elsewhere in the query, for example, table_alias.property_alias.

Note that the IsModified predicate can only be used in a filter expression. It cannot be used in an ad hoc SQL query.

Public propertyId
A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For IUser and IGroup classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, IUser.Id and IGroup.Id always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

  • PropertyDescription.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.Id.

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

Public propertyLastModifier
Indicates the name of the user who last modified the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Public propertyName
The name for this object.

For most classes, this property is read-only and returns the value of the designated name property for the object, or its ID if there is no name property. If ClassDescription.NamePropertyIndex has a value, this property contains the value of the designated name property. If there is no designated name property value, and the object has an Id property, this property contains the string value of the Id property. If neither of these conditions is satisfied, this property contains an empty string.

For a ComponentRelationship object, this property is read/write and specifies the name of the object.

Public propertyOwner
Manages the security owner assigned to the object.
Public propertyPermissions
Manages the discretionary permissions assigned to the object.
Public propertyProperties
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.)
Public propertyReplicationGroup
A ReplicationGroup object representing the replication group to which this replicable object belongs.

For ReplicationJournalEntry objects only, this property represents the replication group to which the source object of the replication operation generating this journal entry belongs.

(Inherited from IReplicable.)
Public propertyStorageAreas
Specifies the collection of all storage areas.

For a storage policy, this represents all storage areas (regardless of the ResourceStatus property value) that the policy references (the filter includes).

ToggleSee Also