com.filenet.api.admin

Interface CmHold

  • All Superinterfaces:
    EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable

    public interface CmHold
extends RepositoryObject, Replicable, Subscribable, IndependentlyPersistableObject
    Represents a hold on an object of type CmHoldable, preventing that object from being deleted for an indefinite period of time, until the hold is explicitly removed. Holds can be repeatedly applied and removed on an ad hoc basis during the object's lifecycle.

    A hold is applied by associating a CmHold object with a CmHoldable object through an intermediate CmHoldRelationship object. Every hold in which a CmHold object participates is reflected in the object's CmHoldRelationships property. Deleting a CmHold object results in a cascade delete of the set of CmHoldRelationship objects referenced by the CmHoldRelationships property. Thus, the hold is removed from all of the CmHoldable objects to which the hold previously applied.

    Note: Deleting a CmHold object that is referenced by a large number of CmHoldRelationship 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 CmHold instances. The initial default instance permissions for CmHold grant full control to object store administrators and read-only access to general users.

    Metadata

    Auditable: true
    AllowsInstances: true
    AllowsSubClasses: true
    ClassDefinitionName: ReplicableClassDefinition
    IsDependent: false
    IsHidden: false
    Name: DisplayName
    Searchable: true
    StorageType: ObjectStore
    SuperclassName: Replicable
    See Also:
    Hold Concepts

    • Method Detail

      • get_Creator

        java.lang.String get_Creator()
        Returns the value of the Creator property. For more information, see Creator Property.

      • set_Creator

        void set_Creator(java.lang.String value)
        Sets the value of the Creator property. For more information, see Creator Property.

      • get_DateCreated

        java.util.Date get_DateCreated()
        Returns the value of the DateCreated property. For more information, see DateCreated Property.

      • set_DateCreated

        void set_DateCreated(java.util.Date value)
        Sets the value of the DateCreated property. For more information, see DateCreated Property.

      • get_LastModifier

        java.lang.String get_LastModifier()
        Returns the value of the LastModifier property. For more information, see LastModifier Property.

      • set_LastModifier

        void set_LastModifier(java.lang.String value)
        Sets the value of the LastModifier property. For more information, see LastModifier Property.

      • get_DateLastModified

        java.util.Date get_DateLastModified()
        Returns the value of the DateLastModified property. For more information, see DateLastModified Property.

      • set_DateLastModified

        void set_DateLastModified(java.util.Date value)
        Sets the value of the DateLastModified property. For more information, see DateLastModified Property.

      • get_Id

        Id get_Id()
        Returns the value of the Id property. For more information, see Id Property.

      • get_Owner

        java.lang.String get_Owner()
        Returns the value of the Owner property. For more information, see Owner Property.

      • set_Owner

        void set_Owner(java.lang.String value)
        Sets the value of the Owner property. For more information, see Owner Property.

      • get_DisplayName

        java.lang.String get_DisplayName()
        Returns the value of the DisplayName property. For more information, see DisplayName Property.

      • set_DisplayName

        void set_DisplayName(java.lang.String value)
        Sets the value of the DisplayName property. For more information, see DisplayName Property.

      • 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.
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

© Copyright IBM Corporation 2006, 2013. All rights reserved.