public interface RecordCategory extends Container, RecordCategoryContainer, RecordFolderContainer, RecordContainer, DispositionAllocatable
RecordCategory
instances or RecordFolder
instances,
and can also directly contain Record
instances.
A given RecordCategory
parent can only contain immediate child
sub-containers of all the same container types (all RecordCategory
or all RecordFolder
). The allowed child container type is defined
by the type of the first child container added to a parent RecordCategory
.
A new RecordCategory
can be created using the
RecordCategoryContainer.addRecordCategory
method.
An existing RecordCategory
instance can be acquired using one of the following methods:
RMFactory.RecordCategory.fetchInstance
method.RecordCategory
collection using the RecordCategoryContainer.fetchRecordCategories
method.RMSearch
class to perform a query.
An existing RecordCategory
can be updated by using its Persistable.save
method.
An existing RecordCategory
can be deleted by using its superclass BaseEntity.delete
method.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getRecordCategoryIdentifier()
Returns the
RecordCategoryIdentifier property value. |
java.lang.String |
getRecordCategoryName()
Returns the
RecordCategoryName property value. |
void |
move(RecordCategoryContainer destinationContainer,
java.lang.String reason)
Moves this
RecordCategory instance into the specified
RecordCategoryContainer parent. |
addRecordCategory, addRecordCategory, fetchRecordCategories
addRecordFolder, addRecordFolder, fetchRecordFolders
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 getRecordCategoryIdentifier()
RecordCategoryIdentifier
property value.String
value.java.lang.String getRecordCategoryName()
RecordCategoryName
property value.String
value.void move(RecordCategoryContainer destinationContainer, java.lang.String reason)
RecordCategory
instance into the specified
RecordCategoryContainer
parent.
If the RecordCategory
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 RecordCategory
nor to any of its sub-containers.
destinationContainer
- The RecordCategoryContainer
parent to move this RecordCategory
into.
This parameter cannot be null
.reason
- a String
specifying a reason for the move operation.
This parameter cannot be null
or blank.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 (for example, access permission deny)© Copyright IBM Corp. 2010, 2013. All Rights Reserved.