com.ibm.jarm.api.core

Interface NamingPattern

    • Method Detail

      • getPatternName

        java.lang.String getPatternName()
        Returns the PatternName property value.
        Returns:
        A String value.
      • setPatternName

        void setPatternName(java.lang.String patternName)
        Sets the 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.

        Parameters:
        patternName - a String value. This entry cannot be null.
      • getDescription

        java.lang.String getDescription()
        Returns the RMEntityDescription property value.
        Returns:
        A String value. This entry can be null or blank.
      • setDescription

        void setDescription(java.lang.String value)
        Sets the RMEntityDescription property value.
        Parameters:
        value - a String value. This entry can be null.
      • setApplyToNameOrId

        void setApplyToNameOrId(ApplyToNameOrID value)
        Sets the ApplyToNameOrId property value.
        Parameters:
        value - an ApplyToNameOrID enum value. This entry cannot be null.
      • createNamingPatternLevel

        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.

        This new NamingPatternLevel instance will be automatically associated with this NamingPattern once it has been saved.

        Parameters:
        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.
        Returns:
        A new NamingPatternLevel instance.
      • getNamingPatternLevels

        java.util.List<NamingPatternLevel> getNamingPatternLevels()
        Returns the naming pattern levels that are associated with this naming pattern
        Returns:
        A List of NamingPatternLevel instances.

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