public interface FilePlan extends Container, RecordCategoryContainer, DefensiblyDisposableContainerParent
A specific file plan instance can be obtained using the
RMFactory.FilePlan
factory class. All available file plans
for a specific file plan repository can be obtained using
the FilePlanRepository.getFilePlans
method.
A new file plan can be created using the FilePlanRepository.addFilePlan
method.
Modifier and Type | Method and Description |
---|---|
void |
delete()
Deletes this file plan entity.
|
java.lang.Integer |
getLastPatternIndex()
Provides the value of the
LastPatternIndex property value of this file plan. |
NamingPattern |
getNamingPattern()
Returns the associated
NamingPattern instance that can be used
to support auto-naming of record categories and record folders contained
within this file plan. |
RetainMetadata |
getRetainMetadata()
Provides the value of the
RetainMetadata property assigned to this file plan. |
void |
setLastPatternIndex(java.lang.Integer value)
Sets the value of the
LastPatternIndex property for this file plan. |
void |
setNamingPattern(NamingPattern namingPattern)
Defines a
NamingPattern instance to be used for auto-naming of
record categories and record folders contained within this file plan. |
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
addRecordCategory, addRecordCategory, fetchRecordCategories
addDefensiblyDisposableContainer, canContainDefensibleDisposalContainer
RetainMetadata getRetainMetadata()
RetainMetadata
property assigned to this file plan.RetainMetadata
value.NamingPattern getNamingPattern()
NamingPattern
instance that can be used
to support auto-naming of record categories and record folders contained
within this file plan.NamingPattern
instance. This entry can be null
.void setNamingPattern(NamingPattern namingPattern)
NamingPattern
instance to be used for auto-naming of
record categories and record folders contained within this file plan.namingPattern
- a NamingPattern
instance. This entry can be null
.java.lang.Integer getLastPatternIndex()
LastPatternIndex
property value of this file plan.Integer
value. This entry can be null
.void setLastPatternIndex(java.lang.Integer value)
LastPatternIndex
property for this file plan.value
- an Integer
object. This entry can be null
.void delete()
© Copyright IBM Corp. 2010, 2013. All Rights Reserved.