A hold is applied by associating a ICmHold object with a ICmHoldable object through an intermediate CmHoldRelationship object. Every hold in which a ICmHold object participates is reflected in the object's ICmHoldRelationships property. Deleting a ICmHold object results in a cascade delete of the set of ICmHoldRelationship objects referenced by the CmHoldRelationships property. Thus, the hold is removed from all of the ICmHoldable objects to which the hold previously applied.
Note: Deleting a ICmHold object that is referenced by a large number of ICmHoldRelationship objects can result in a database transaction failure. If you anticipate large-scale hold removals, configure the application server transaction timeout and transaction log space to accommodate the operation.
By default, only object store administrators have the right to create ICmHold instances. The initial default instance permissions for ICmHold grant full control to object store administrators and read-only access to general users.
See Hold Concepts
Namespace:
FileNet.Api.Admin
Assembly:
FileNet.Api (in FileNet.Api.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Interface ICmHold _ Implements IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, _ IIndependentObject, IEngineObject, ICloneable |
C# |
---|
public interface ICmHold : IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
Visual C++ |
---|
public interface class ICmHold : IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
JavaScript |
---|
FileNet.Api.Admin.ICmHold = function(); FileNet.Api.Admin.ICmHold.createInterface('FileNet.Api.Admin.ICmHold'); |
Remarks
Metadata
Auditable: true
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: Replicable