com.ibm.jarm.api.core

Interface NamingPatternSequence

  • All Superinterfaces:
    AuditableEntity, BaseEntity, Persistable, RMCustomObject


    public interface NamingPatternSequence
    extends RMCustomObject
    An interface that represents a PatternSequences custom object. A NamingPatternSequence is loosely associated with a single record category or record folder container through its ParentGUID property. It is used to maintain the index counter used for applicable naming patterns when auto-naming children of the container (both records and child containers).

    A specific naming pattern sequence can be obtained using the RMFactory.NamingPatternSequence factory class.

    A new naming pattern sequence can be created using the factory class method RMFactory.NamingPatternSequence.createInstance. The resulting new naming pattern sequence 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.

    See Also:
    RMFactory.NamingPatternSequence
    • Method Detail

      • getLastPatternIndex

        java.lang.Integer getLastPatternIndex()
        Returns the value of the LastPatternIndex property for this naming pattern sequence instance.
        Returns:
        An Integer value.
      • setLastPatternIndex

        void setLastPatternIndex(java.lang.Integer value)
        Sets the LastPatternIndex property value.
        Parameters:
        value - An Integer value. This entry cannot be null.
      • getParentIdentifier

        java.lang.String getParentIdentifier()
        Returns the value of the ParentGUID property that identifies the parent object to which this naming pattern sequence applies.
        Returns:
        A String value.
      • setParentIdentifier

        void setParentIdentifier(java.lang.String value)
        Sets the ParentGUID property value.
        Parameters:
        value - An String GUID value.

© Copyright IBM Corp. 2010, 2013. All Rights Reserved.