com.ibm.jarm.api.core

Interface RecordFolder

    • Method Detail

      • getFolderUniqueIdentifier

        java.lang.String getFolderUniqueIdentifier()
        Returns the RecordFolderIdentifier property value.
        Returns:
        A String value.
      • getRecordFolderName

        java.lang.String getRecordFolderName()
        Returns the RecordFolderName property value.
        Returns:
        A String value.
      • move

        void move(RecordFolderContainer destinationContainer,
                java.lang.String reason)
        Moves this RecordFolder into the specified destination RecordFolderContainer.

        If the RecordFolder is currently inheriting a disposition schedule from its pre-move parent container, it will now have this same schedule directly assigned to it. No other schedule-related changes are made to the RecordFolder nor to any of its sub-containers.

        Parameters:
        destinationContainer - the RecordFolderContainer to move the record folder into. This parameter cannot be null.
        reason - a String specifying a reason for the move operation. This parameter cannot be null nor blank.
        Throws:
        E_NULL_OR_EMPTY_INPUT_PARAM - For bad input parameter.
        RAL_SOURCE_DESTINATION_SAME - For an attempt to move into existing parent container.
        API_CANNOT_CONTAIN_CHILDTYPE - If destination container cannot contain this instance type.
        API_CANNOT_MOVE_OBJECT - For any other error (e.g. access permission deny, etc.)

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