public interface NamingPattern extends RMCustomObject
Pattern
custom object.
A specific naming pattern can be obtained using the RMFactory.NamingPattern
factory class.
The current naming pattern assigned to a file plan can be obtained using
the FilePlan.getNamingPattern
method. A specific naming pattern
instance can be assigned to a file plan using the
FilePlan.setNamingPattern
method.
A new naming pattern can be created using the factory class
method RMFactory.NamingPattern.createInstance
.
The resulting new naming pattern instance can then be further defined
followed by an eventual call to its save
in order to ensure that it is persisted to its associated file plan repository.
RMFactory.NamingPattern
Modifier and Type | Method and Description |
---|---|
NamingPatternLevel |
createNamingPatternLevel()
Creates a new
NamingPatternLevel instance that can
be further defined and then persisted to the repository
using its base class save
method. |
NamingPatternLevel |
createNamingPatternLevel(java.lang.String idStr)
Creates a new
NamingPatternLevel instance that can
be further defined and then persisted to the repository
using its base class save
method. |
ApplyToNameOrID |
getApplyToNameOrId()
Returns the
ApplyToNameOrId property value. |
java.lang.String |
getDescription()
Returns the
RMEntityDescription property value. |
NamingPatternLevel |
getNamingPatternLevel(java.lang.Integer patternLevelNumber,
AppliedForCategoryOrFolder appliedFor)
Returns the
NamingPatternLevel instance associated
with this naming pattern for the level and applied for specified. |
java.util.List<NamingPatternLevel> |
getNamingPatternLevels()
Returns the naming pattern levels that are associated with this naming pattern
|
java.lang.String |
getPatternName()
Returns the
PatternName property value. |
void |
setApplyToNameOrId(ApplyToNameOrID value)
Sets the
ApplyToNameOrId property value. |
void |
setDescription(java.lang.String value)
Sets the
RMEntityDescription property value. |
void |
setPatternName(java.lang.String patternName)
Sets the
PatternName property value. |
delete
getAccessAllowed, getClassDescription, getClassName, getClientIdentifier, getContainedBy, getDomainType, getEntityType, getName, getObjectIdentity, getPermissions, getProperties, getRepository, isCreationPending, isPlaceholder, refresh, refresh, refresh
save, setPermissions
getAuditedEvents
java.lang.String getPatternName()
PatternName
property value.String
value.void setPatternName(java.lang.String patternName)
PatternName
property value.
This name value must be unique relative to all other naming patterns
defined on the same file plan repository. Validation of
such name uniqueness does not occur until the
save
is called.
patternName
- a String
value. This entry cannot be null
.java.lang.String getDescription()
RMEntityDescription
property value.String
value. This entry can be null
or blank.void setDescription(java.lang.String value)
RMEntityDescription
property value.value
- a String
value. This entry can be null
.ApplyToNameOrID getApplyToNameOrId()
ApplyToNameOrId
property value.ApplyToNameOrID
enum String
value.void setApplyToNameOrId(ApplyToNameOrID value)
ApplyToNameOrId
property value.value
- an ApplyToNameOrID
enum value. This entry cannot be null
.NamingPatternLevel createNamingPatternLevel()
NamingPatternLevel
instance that can
be further defined and then persisted to the repository
using its base class save
method.
This new NamingPatternLevel
instance will be automatically associated
with this NamingPattern
once it has been saved.
NamingPatternLevel
instance.NamingPatternLevel createNamingPatternLevel(java.lang.String idStr)
NamingPatternLevel
instance that can
be further defined and then persisted to the repository
using its base class save
method.
This new NamingPatternLevel
instance will be automatically associated
with this NamingPattern
once it has been saved.
idStr
- a String
Id value to be assigned to the new instance.
This parameter can be null
in which case an Id value
will be automatically generated for the new instance.NamingPatternLevel
instance.NamingPatternLevel getNamingPatternLevel(java.lang.Integer patternLevelNumber, AppliedForCategoryOrFolder appliedFor)
NamingPatternLevel
instance associated
with this naming pattern for the level and applied for specified.patternLevelNumber
- the pattern level of the item you want to matchappliedFor
- the AppliedForCategoryOrFolder
value to match.NamingPatternLevel
instance.java.util.List<NamingPatternLevel> getNamingPatternLevels()
List
of NamingPatternLevel
instances.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.