com.filenet.rm.api

Interface Hold

  • All Superinterfaces:
    com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.ContainableObject, com.filenet.wcm.api.CreatableObject, com.filenet.wcm.api.CustomObject, com.filenet.wcm.api.GettableObject, com.filenet.wcm.api.LockableObject, com.filenet.wcm.api.ReadableMetadataObject, com.filenet.wcm.api.ReadableSecurityObject, RMCustomObject, RMObject, java.io.Serializable, com.filenet.wcm.api.ValueObject, com.filenet.wcm.api.WorkflowTarget, com.filenet.wcm.api.WriteableMetadataObject, com.filenet.wcm.api.WriteableSecurityObject


    public interface Hold
    extends RMCustomObject
    Represents a disposition hold that suspends the normal disposition schedule for one or more objects to ensure their availability beyond the approved retention period. The Hold interface extends the RMCustomObject interface to provide methods for managing a disposition hold.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      HoldableObjects getAssociatedRMobjects()
      Returns the Record Manager objects that are associated with this Hold object.
      org.w3c.dom.Document getAssociatedRMobjects(java.lang.String[] aoFolderProps, java.lang.String[] aoRecordInfoProps, int aiMaxRecords, java.lang.String asFilterString)
      Returns a Document object containing the Record Manager objects that are associated with this Hold object.
      int getHoldState()
      Returns an int value indicating the hold state for this Hold object.
      boolean isAppliedDynamically()
      Indicates whether the disposition hold represented by this Hold object has been placed dynamically.
      void unHoldAll()
      Releases the disposition hold on all objects associated with this Hold object by dissociating those objects from this Hold object.
      • Methods inherited from interface com.filenet.wcm.api.CustomObject

        applySecurityTemplate, changeClass, delete, getHeadLinks, getHeadLinksXML, getPermissionsXML, getSubscriptions, getTailLinks, getTailLinksXML, getUserAccess, getUserAccess, getUserAccess, raiseEvent
      • Methods inherited from interface com.filenet.wcm.api.ContainableObject

        file, file, file, file, getContainers, getContainersXML, getContainmentNames, getContainmentPaths, getSecurityParent, setContainmentName, setContainmentName, setSecurityParent, unfile, unfile
      • Methods inherited from interface com.filenet.wcm.api.WorkflowTarget

        getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML
      • Methods inherited from interface com.filenet.wcm.api.WriteableSecurityObject

        setPermissions, setPermissions
      • Methods inherited from interface com.filenet.wcm.api.WriteableMetadataObject

        setProperties, setProperties
      • Methods inherited from interface com.filenet.wcm.api.ReadableSecurityObject

        getAccessMask, getPermissions, getPermissions
      • Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject

        getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
      • Methods inherited from interface com.filenet.wcm.api.BaseObject

        equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject
      • Methods inherited from interface com.filenet.wcm.api.LockableObject

        extendLock, extendLock, isLocked, lock, unlock, unlock
    • Method Detail

      • getAssociatedRMobjects

        HoldableObjects getAssociatedRMobjects()
                                               throws RMException
        Returns the Record Manager objects that are associated with this Hold object. These objects can include record categories, record folders, or volumes.
        Returns:
        A HoldableObjects collection containing the objects associated with this Hold object
        Throws:
        RMException - If a Records Manager error occurs.
      • getAssociatedRMobjects

        org.w3c.dom.Document getAssociatedRMobjects(java.lang.String[] aoFolderProps,
                                                  java.lang.String[] aoRecordInfoProps,
                                                  int aiMaxRecords,
                                                  java.lang.String asFilterString)
                                                    throws RMException
        Returns a Document object containing the Record Manager objects that are associated with this Hold object. These objects can include record categories, record folders, or volumes.
        Parameters:
        aoFolderProps - A String array containing the properties associated with the record categories, record folders, or volumes to be returned.
        aoRecordInfoProps - A String array containing the properties associated with the records to be returned.
        aiMaxRecords - An int value indicating the maximum number of records to be returned.
        asFilterString - A String that specifies a filter to be applied to the results.
        Returns:
        An org.w3c.dom.Document that includes the objects associated with associated with this Hold object.
        Throws:
        RMException - If a Records Manager error occurs.
      • unHoldAll

        void unHoldAll()
                       throws RMException
        Releases the disposition hold on all objects associated with this Hold object by dissociating those objects from this Hold object.
        Throws:
        RMException - If a Records Manager error occurs.
      • isAppliedDynamically

        boolean isAppliedDynamically()
                                     throws RMException
        Indicates whether the disposition hold represented by this Hold object has been placed dynamically.
        Returns:
        true if at least one object associated with this Hold object was dynamically placed on hold; otherwise, returns false.
        Throws:
        RMException - If a Records Manager error occurs.
      • getHoldState

        int getHoldState()
                         throws RMException
        Returns an int value indicating the hold state for this Hold object.
        Returns:
        An int value indicating the hold state as follows:

        • 0 - Hold without any condition.
        • 1 - Hold with at least one condition.
        • 2 - User has requested removal of hold from all associated entities.
        • 3 - Hold will no longer be processed by the hold sweep. This value is set after completing the remove hold request by the hold sweep.
        • 4 - The hold sweep is currently processing the hold.

        Throws:
        RMException - If a Records Manager error occurs.

© Copyright IBM Corp. 2003, 2013. All Rights Reserved.