public interface RecordFolder extends Container, RecordFolderContainer, RecordVolumeContainer, RecordContainer, DispositionAllocatable
RecordFolder
instances or RecordVolume
instances,
and might also directly contain Record
instances
(See the RecordContainer.requiresChildVolume()
method).
A new RecordFolder
is created using the
RecordFolderContainer.addRecordFolder
method.
An existing RecordFolder
instance is acquired using one of the following methods:
RMFactory.RecordFolder.fetchInstance
method.RecordFolder
collection using the RecordFolderContainer.fetchRecordFolders
method.RMSearch
class to perform a query.
An existing RecordFolder
is updated by using its Persistable.save
method.
An existing RecordFolder
is deleted by using its superclass BaseEntity.delete
method.
RMFactory.RecordFolder
,
RecordFolderContainer
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getFolderUniqueIdentifier()
Returns the
RecordFolderIdentifier property value. |
java.lang.String |
getRecordFolderName()
Returns the
RecordFolderName property value. |
void |
move(RecordFolderContainer destinationContainer,
java.lang.String reason)
Moves this
RecordFolder into the specified destination
RecordFolderContainer . |
addRecordFolder, addRecordFolder, fetchRecordFolders
addRecordVolume, addRecordVolume, fetchRecordVolumes, getActiveRecordVolume
close, declare, declare, declare, exportUsingP8_XML, fileRecord, fileRecord, getFilePlan, getRecords, isAnyParentClosed, isClosed, isInactive, isOpen, isPhysicalRecordContainer, isReopened, reopen, requiresChildVolume, setActive, setInactive, unfileRecord, unfileRecord
canContain, delete, getAllowedContaineeTypes, getFolderName, getImmediateSubContainers, getParent, getPathName
getAccessAllowed, getClassDescription, getClassName, getClientIdentifier, getContainedBy, getDomainType, getEntityType, getName, getObjectIdentity, getPermissions, getProperties, getRepository, isCreationPending, isPlaceholder, refresh, refresh, refresh
save, setPermissions
completePhaseExecution, destroy, destroy, executeInterimTransferUsingExternalExport, executeInterimTransferUsingP8_XML, exportUsingExternalExport, exportUsingP8_XML, initiateDisposition, isReadyForInitiateDisposition, resetDispositionData, resetVitalData, review, transferUsingExternalExport, transferUsingP8_XML, updatePhaseDataOnEntity, validateForDispositionExport
getAssociatedHolds, getParentsOnHold, isAnyChildOnHold, isAnyParentOnHold, isOnHold, placeHold, removeHold
executeVital, isVital, setVital, updateVitalStatus
getAuditedEvents
convertToDefensiblyDisposable, getRetentionPeriod, getTriggerPropertyName, isADefensiblyDisposableContainer, isEligibleForConversion, setRetentionPeriod, setTriggerPropertyName
addDefensiblyDisposableContainer, canContainDefensibleDisposalContainer
assignDispositionSchedule, clearDispositionAssignment, getAssignedSchedule
java.lang.String getFolderUniqueIdentifier()
RecordFolderIdentifier
property value.String
value.java.lang.String getRecordFolderName()
RecordFolderName
property value.String
value.void move(RecordFolderContainer destinationContainer, java.lang.String reason)
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.
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.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.