com.ibm.jarm.api.core

Interface NamingPatternLevel

All Superinterfaces:

AuditableEntity, BaseEntity, Persistable, RMCustomObject

public interface NamingPatternLevel
extends RMCustomObject

An interface that represents a PatternLevel custom object. Each naming pattern level represents the file plan hierarchy level to which a NamingPattern applies.

A specific naming pattern level belonging to a NamingPattern instance can be acquired using the NamingPattern.getNamingPatternLevel method. All naming pattern levels belonging to a NamingPattern instance can be acquired using the NamingPattern.getNamingPatternLevels method.

A new naming pattern level instance can be created using the NamingPattern.createNamingPatternLevel method. The resulting new naming pattern level can then be further defined. The new naming pattern level is persisted to the file plan repository when its save method is called.

See Also:

NamingPattern

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.jarm.api.core.Persistable

Persistable.UpdateValidationOptions

Method Summary

Methods

Modifier and Type	Method and Description
AppliedForCategoryOrFolder	getAppliedFor() Returns the AppliedFor property value.
java.lang.Integer	getIncrementedBy() Returns the IncrementedBy property value.
NamingPattern	getNamingPattern() Returns the NamingPattern instance to which this naming pattern level belongs.
java.lang.Integer	getPatternLevelNumber() Returns the LevelNumber property value.
java.lang.String	getPatternString() Returns the PatternString property value.
void	setAppliedFor(AppliedForCategoryOrFolder value) Sets the AppliedFor property value.
void	setIncrementedBy(java.lang.Integer value) Sets the IncrementedBy property value.
void	setPatternLevelNumber(java.lang.Integer value) Sets the LevelNumber property value.
void	setPatternString(java.lang.String value) Sets the PatternString property value.

Methods inherited from interface com.ibm.jarm.api.core.RMCustomObject

delete

Methods inherited from interface com.ibm.jarm.api.core.BaseEntity

getAccessAllowed, getBaseObject, getClassDescription, getClassName, getClientIdentifier, getContainedBy, getDomainType, getEntityType, getName, getObjectIdentity, getPermissions, getProperties, getRepository, isCreationPending, isPlaceholder, refresh, refresh, refresh

Methods inherited from interface com.ibm.jarm.api.core.Persistable

save, save, setPermissions

Methods inherited from interface com.ibm.jarm.api.core.AuditableEntity

getAuditedEvents

Method Detail

getPatternLevelNumber

java.lang.Integer getPatternLevelNumber()

Returns the LevelNumber property value.

Returns:

An Integer value.

setPatternLevelNumber

void setPatternLevelNumber(java.lang.Integer value)

Sets the LevelNumber property value.

Parameters:

value - An Integer value. This entry cannot be null.

getPatternString

java.lang.String getPatternString()

Returns the PatternString property value.

Returns:

A String value.

setPatternString

void setPatternString(java.lang.String value)

Sets the PatternString property value.

Parameters:

value - A String value. This entry cannot be null.

getIncrementedBy

java.lang.Integer getIncrementedBy()

Returns the IncrementedBy property value.

Returns:

An Integer value. This entry can be null.

setIncrementedBy

void setIncrementedBy(java.lang.Integer value)

Sets the IncrementedBy property value.

Parameters:

value - An Integer value.

getAppliedFor

AppliedForCategoryOrFolder getAppliedFor()

Returns the AppliedFor property value.

Returns:

A AppliedForCategoryOrFolder value.

setAppliedFor

void setAppliedFor(AppliedForCategoryOrFolder value)

Sets the AppliedFor property value.

Parameters:

value - a AppliedForCategoryOrFolder value. This entry cannot be null.

getNamingPattern

NamingPattern getNamingPattern()

Returns the NamingPattern instance to which this naming pattern level belongs.

Returns:

A NamingPattern instance.