com.filenet.rm.api.util

Class RMBulkOperationsUtil

  • java.lang.Object
    • com.filenet.rm.api.util.RMBulkOperationsUtil


  • public class RMBulkOperationsUtil
    extends java.lang.Object
    The RMBulkOperationsUtil class is a utility class that is used to perform bulk operations on RM entities. This class provides various functions such as moving and filing that can be performed on multiple RM entities simultaneously. You can instantiate the RMBulkOperationsUtil object by calling the default constructor of this class.
    • Field Detail

      • QUERY_MARKERS_ON_IERHOLD

        public static final java.lang.String QUERY_MARKERS_ON_IERHOLD
        See Also:
        Constant Field Values
      • QUERY_MARKERS_ON_IERHOLD_EDMHOLD

        public static final java.lang.String QUERY_MARKERS_ON_IERHOLD_EDMHOLD
        See Also:
        Constant Field Values
      • QUERY_MARKERS_CONTAINEE_ON_IERHOLD

        public static final java.lang.String QUERY_MARKERS_CONTAINEE_ON_IERHOLD
        See Also:
        Constant Field Values
      • QUERY_MARKERS_CONTAINEE_ON_IERHOLD_EDMHOLD

        public static final java.lang.String QUERY_MARKERS_CONTAINEE_ON_IERHOLD_EDMHOLD
        See Also:
        Constant Field Values
      • QUERY_PHYSICAL_CONTAINER_CONTAINEE_ON_HOLD

        public static final java.lang.String QUERY_PHYSICAL_CONTAINER_CONTAINEE_ON_HOLD
        See Also:
        Constant Field Values
      • QUERY_PHYSICAL_CONTAINER_VOL_CONTAINEE_ON_HOLD

        public static final java.lang.String QUERY_PHYSICAL_CONTAINER_VOL_CONTAINEE_ON_HOLD
        See Also:
        Constant Field Values
    • Constructor Detail

      • RMBulkOperationsUtil

        public RMBulkOperationsUtil()
        A default constructor thats is used to retrieve an instance of this class.
    • Method Detail

      • move

        public RMBulkOperationResults move(RMObjectStore aoRMOS,
                                  java.lang.String[] asArrObjectIDs,
                                  RMRecordContainer aoSource,
                                  RMFolder aoDestination,
                                  java.lang.String asReasonForMove,
                                  DispositionSchedule aoDispositionSchedule)
                                    throws RMException
        Performs the move operation on all RM entities whose Ids are specified in the asArrObjectIDs input parameter.
        Parameters:
        aoRMOS - An ObjectStore object that represents an FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of RM entities that are to be moved.
        aoSource - Specifies the source RMRecordContainer from where RecordInfo is to be moved. This parameter is ignored, if an RM entity is not RecordInfo.
        aoDestination - Specifies the target RMFolder where RM entities are to be moved.
        asReasonForMove - Reason to move RM entities must be specified. This parameter cannot be null.
        aoDispositionSchedule - A DispositionSchedule object that is to be associated with the RM entity after the move operation.
        Returns:
        A RMBulkOperationResults collection that contains RMBulkOperationResult for the operations performed on each RM entity.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • clearDispositionData

        public RMBulkOperationResults clearDispositionData(RMObjectStore aoRMOS,
                                                  java.lang.String[] asArrObjectIDs)
                                                    throws RMException
        Performs the clear disposition properties operation on all RM entities whose Ids are specified in the asArrObjectIDs input parameter.
        Parameters:
        aoRMOS - An ObjectStore object that represents an FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of RM entities whose disposition properties are to be cleared.
        Returns:
        A RMBulkOperationResults collection that contains RMBulkOperationResult for the operations performed on each RM entity.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • file

        public RMBulkOperationResults file(RMObjectStore aoRMOS,
                                  java.lang.String[] asArrObjectIDs,
                                  RMRecordContainer aoDestination)
                                    throws RMException
        Performs the file operations on all RecordInfo Objects whose Ids are specified in asArrObjectIDs input parameter.
        Parameters:
        aoRMOS - An Objectstore object that represents an FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of the RecordInfos that is to be filed.
        aoDestination - Specifies the target RMRecordContainer where RecordInfos are to be filed.
        Returns:
        A RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RMObject.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • copy

        public RMBulkOperationResults copy(RMObjectStore aoRMOS,
                                  java.lang.String[] asArrObjectIDs,
                                  RMRecordContainer aoDestination,
                                  java.lang.String copyOfPrefix)
                                    throws RMException
        Performs the copy operation on all RecordInfo Objects whose Ids are specified in asArrObjectIDs input parameter.
        Parameters:
        aoRMOS - An Objectstore object that represents an FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of the RecordInfos that is to be copied.
        aoDestination - Specifies the target RMRecordContainer where RecordInfos are to be copied.
        copyOfPrefix - Prefix for the title of the copied records
        Returns:
        A RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RMObject.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • copy

        public RMBulkOperationResults copy(RMObjectStore aoRMOS,
                                  java.lang.String[] asArrObjectIDs,
                                  RMRecordContainer aoDestination,
                                  com.filenet.wcm.api.Properties aoCopyProps)
                                    throws RMException
        Performs the copy operation on all RecordInfo Objects whose Ids are specified in asArrObjectIDs input parameter.
        Parameters:
        aoRMOS - An Objectstore object that represents an FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of the RecordInfos that is to be copied.
        aoDestination - Specifies the target RMRecordContainer where RecordInfos are to be copied.
        Returns:
        A RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RMObject.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • delete

        public RMBulkOperationResults delete(RMObjectStore aoRMOS,
                                    java.lang.String[] asArrObjectIDs)
                                      throws RMException
        Performs the delete operation on all RM Entities whose IDs are specified in asArrObjectIDs input parameter.
        Parameters:
        aoRMOS - An Objectstore object that represents an FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of the RecordInfos that is to be copied.
        Returns:
        A RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RMObject.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • undeclare

        public RMBulkOperationResults undeclare(RMObjectStore aoRMOS,
                                       java.lang.String[] asArrObjectIDs)
                                         throws RMException
        Performs the undeclare operation on all RM records whose IDs are specified in asArrObjectIDs input parameter.
        Parameters:
        aoRMOS - An Objectstore object that represents an FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of the RecordInfos that are to be undeclared.
        Returns:
        A RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RMObject.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • reOpen

        public RMBulkOperationResults reOpen(RMObjectStore aoRMOS,
                                    java.lang.String[] asArrObjectIDs,
                                    boolean abReOpen,
                                    java.lang.String asReasonForClose)
                                      throws RMException
        Performs the reOpen operation on all RM objects whose IDs are specified in the asArrObjectIDs input parameter. All the RM objects whose IDs are specified should extend the ClosableObject interface.
        Parameters:
        aoRMOS - An ObjectStore object that represents an FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of RM objects.
        abReOpen - If true, the reOpen operation is performed; else the entity that is already reopened before is closed.
        asReasonForClose - A String that represents the reason for reOpen operation.
        Returns:
        A RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RM object.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • hold

        public RMBulkOperationResults hold(RMObjectStore aoRMOS,
                                  java.lang.String[] asArrObjectIDs,
                                  Hold aoHold)
                                    throws RMException
        Performs hold operation on all RM entities whose Ids are specified in the asArrObjectIDs input parameter.
        Parameters:
        aoRMOS - An ObjectStore object that represents an FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of RM entities that is to be put on hold.
        aoHold - The Hold object that is to be associated.
        Returns:
        A RMBulkOperationResults collection that contains RMBulkOperationResult for operations performed on each RMObject.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • hold

        public RMBulkOperationResults hold(RMObjectStore aoRMOS,
                                  java.lang.String[] asArrObjectIDs,
                                  RMObjects aoHolds)
                                    throws RMException
        Performs the hold operation on all the RM entities whose Ids are specified in the asArrObjectIDs input parameter. All the Hold objects (contained in the Holds collection) that are specified are associated with each RM object whose GUID is passed as an input parameter.
        Parameters:
        aoRMOS - An ObjectStore object that represents an FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of RM entities that are kept on hold.
        aoHolds - The Holds collection that contain the Hold objects that are to be associated.
        Returns:
        The RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RMObject.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • hold

        public RMBulkOperationResults hold(RMObjectStore aoRMOS,
                                  java.lang.String[] asArrObjectIDs,
                                  Holds aoHolds)
                                    throws RMException
        Performs the hold operation on all the RM entities whose Ids are specified in the asArrObjectIDs input parameter. All the Hold objects (contained in the Holds collection) that are specified are associated with each RM object whose GUID is passed as an input parameter.
        Parameters:
        aoRMOS - An ObjectStore object that represents an FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of RM entities that are kept on hold.
        aoHolds - The Holds collection that contain the Hold objects that are to be associated.
        Returns:
        The RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RMObject.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • unHold

        public RMBulkOperationResults unHold(RMObjectStore aoRMOS,
                                    java.lang.String[] asArrObjectIDs,
                                    RMObjects aoHolds)
                                      throws RMException
        Deprecated. Use instead of this method.
        Performs the unHold operation on all RM entities whose Ids are specified in the asArrObjectIDs input parameter. All the Hold objects (contained in the Holds collection) that are specified are disassociated from each RM object.
        Parameters:
        aoRMOS - An Objectstore object that represents a FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of RM entities from which Hold is to be removed.
        aoHolds - The Holds collection that contains the Hold objects that are to be removed.
        Returns:
        The RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RM object.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • unHold

        public RMBulkOperationResults unHold(RMObjectStore aoRMOS,
                                    java.lang.String[] asArrObjectIDs,
                                    Holds aoHolds)
                                      throws RMException
        Performs the unHold operation on all RM entities whose Ids are specified in the asArrObjectIDs input parameter. All the Hold objects (contained in the Holds collection) that are specified are disassociated from each RM object.
        Parameters:
        aoRMOS - An Objectstore object that represents a FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of RM entities from which Hold is to be removed.
        aoHolds - The Holds collection that contains the Hold objects that are to be removed.
        Returns:
        The RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RM object.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • unHold

        public RMBulkOperationResults unHold(RMObjectStore aoRMOS,
                                    java.lang.String[] asArrObjectIDs,
                                    Hold aoHold)
                                      throws RMException
        Performs the unHold operation on all RM entities whose Ids are specified in input parameter asArrObjectIDs.The Hold object that is specified is disassociated from each RM object.
        Parameters:
        aoRMOS - An Objectstore object that represents a FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of RM entities on whom unHold operation is to be performed.
        aoHold - Hold object that is to be disassociated.
        Returns:
        The RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RM object.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • close

        public RMBulkOperationResults close(RMObjectStore aoRMOS,
                                   java.lang.String[] asArrObjectIDs,
                                   java.lang.String asReasonForClose)
                                     throws RMException
        Performs the Close operation on all the RM objects whose IDs are specified in the asArrObjectIDs input parameter. All the RM Objects whose IDs are specified should extend the ClosableObject interface.
        Parameters:
        aoRMOS - An ObjectStore object that represents an FPOS.
        asArrObjectIDs - A string array that contains the GUIDs of RM objects.
        asReasonForClose - A reason for close.
        Returns:
        the RMBulkOperationResults collection that contains RMBulkOperationResult for operations performed on each RMObject.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • forcedClose

        public RMBulkOperationResults forcedClose(RMObjectStore aoRMOS,
                                         java.lang.String[] asArrObjectIDs,
                                         java.lang.String asReasonForClose)
                                           throws RMException
        Performs the close operation on all the RM objects whose IDs are specified in the asArrObjectIDs input parameter. If an RM entity is in the reOpen state, this method changes its state by calling the reOpen() method with the false parameter; else the close() method is called. All the RM objects whose IDs are specified should extend the ClosableObject interface.
        Parameters:
        aoRMOS - An ObjectStore object that represents an FPOS.
        asArrObjectIDs - A string array that contains the GUIDs of RM objects.
        asReasonForClose - A reason for close.
        Returns:
        The RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RMObject.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • batchForcedClose

        public RMBulkOperationResults batchForcedClose(RMObjectStore aoRMOS,
                                              java.lang.String[] asArrObjectIDs,
                                              java.lang.String asReasonForClose)
                                                throws RMException
        Performs the close operation on all the RM objects whose IDs are specified in the asArrObjectIDs input parameter. If an RM entity is in the reOpen state, this method changes its state by calling the reOpen() method with the false parameter; else the close() method is called. All the RM objects whose IDs are specified should extend the ClosableObject interface. This method updates the entities in the batch
        Parameters:
        aoRMOS - An ObjectStore object that represents an FPOS.
        asArrObjectIDs - A string array that contains the GUIDs of RM objects.
        asReasonForClose - A reason for close.
        Returns:
        The RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RMObject.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • inActivate

        public RMBulkOperationResults inActivate(RMObjectStore aoRMOS,
                                        java.lang.String[] asArrObjectIDs,
                                        java.lang.String asReasonforInActivate)
                                          throws RMException
        Inactivates all the RM entities whose Ids are specified in the asArrObjectIDs input parameter.
        Parameters:
        aoRMOS - An ObjectStore object that represents an FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of the RM entities that are to be inactivated.
        asReasonforInActivate - A reason to inactivate.
        Returns:
        The RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RM object.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • batchInactivate

        public RMBulkOperationResults batchInactivate(RMObjectStore aoRMOS,
                                             java.lang.String[] asArrObjectIDs,
                                             java.lang.String asReasonforInActivate)
                                               throws RMException
        Inactivates all the RM entities whose Ids are specified in the asArrObjectIDs input parameter.
        Parameters:
        aoRMOS - An ObjectStore object that represents an FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of the RM entities that are to be inactivated.
        asReasonforInActivate - A reason to inactivate.
        Returns:
        The RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RM object.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • activate

        public RMBulkOperationResults activate(RMObjectStore aoRMOS,
                                      java.lang.String[] asArrObjectIDs,
                                      java.lang.String asReasonforActivate)
                                        throws RMException
        Activates all the RM entities whose IDs are specified in the asArrObjectIDs input parameter.
        Parameters:
        aoRMOS - An ObjectStore object that represents an FPOS.
        asArrObjectIDs - A string array that contains the GUIDs of RM entities that are to be activated.
        asReasonforActivate - A Reason to activate.
        Returns:
        The RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RM object.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • batchActivate

        public RMBulkOperationResults batchActivate(RMObjectStore aoRMOS,
                                           java.lang.String[] asArrObjectIDs,
                                           java.lang.String asReasonforActivate)
                                             throws RMException
        Activates all the RM entities in batch, whose IDs are specified in the asArrObjectIDs input parameter.
        Parameters:
        aoRMOS - An ObjectStore object that represents an FPOS.
        asArrObjectIDs - A string array that contains the GUIDs of RM entities that are to be activated.
        asReasonforActivate - A Reason to activate.
        Returns:
        The RMBulkOperationResults collection that contains RMBulkOperationResult for operation performed on each RM object.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • registerExternalEvent

        public RMBulkOperationResults registerExternalEvent(RMObjectStore aoRMOS,
                                                   java.lang.String[] asArrEventIDs,
                                                   java.util.Date aoExtEventOccuranceDate)
                                                     throws RMException
        Updates the ExternalEventOccurrenceDate metadata of the Events represented by the GUIDs specified in input parameter for a particular RMObjectStore.
        Parameters:
        aoRMOS - An ObjectStore object that represents an FPOS.
        asArrEventIDs - A string array that contains the GUIDs of Disposal triggers.
        aoExtEventOccuranceDate - The date that has to be set as the value of ExternalEventOccuranceDate property of each Disposal trigger.
        Returns:
        The RMBulkOperationResults collection that contains RMBulkOperationResult for the operation performed on each Disposal Trigger object.
        Throws:
        RMException - If an ID does not represent a Disposal Trigger object.
        RMException - In case of any error, an RMException will be thrown.
      • initiateDisposition

        public RMBulkOperationResults initiateDisposition(RMObjectStore aoRMOS,
                                                 java.lang.String[] asArrObjectIDs,
                                                 filenet.vw.api.VWSession aoVWSession)
                                                   throws RMException
        Performs initiateDisposition operation on all RM entities whose Ids are specified in the asArrObjectIDs input parameter.
        Parameters:
        aoRMOS - An ObjectStore object that represents an FPOS.
        asArrObjectIDs - A String array that contains the GUIDs of RM entities for whom disposition is to be initiated.
        aoVWSession - The VWSession object.
        Returns:
        A RMBulkOperationResults collection that contains RMBulkOperationResult for operations performed on each RMObject.
        Throws:
        RMException - In case of any error, an RMException will be thrown.
      • isEDMHoldSupportedOnMarkers

        public boolean isEDMHoldSupportedOnMarkers(RMObjectStore aRMObjectStore)
      • isPhysicalRecordOnHold

        public boolean isPhysicalRecordOnHold(RMObjectStore aRMObjectStore,
                                     java.lang.String aRMEntityId,
                                     java.lang.String aRMEntityName,
                                     int aRMType)
                                       throws RMException
        Throws:
        RMException

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