com.ibm.jarm.api.core

Interface FilePlan

    • Method Detail

      • getRetainMetadata

        RetainMetadata getRetainMetadata()
        Provides the value of the RetainMetadata property assigned to this file plan.
        Returns:
        A RetainMetadata value.
      • getNamingPattern

        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.
        Returns:
        A NamingPattern instance. This entry can be null.
      • setNamingPattern

        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.
        Parameters:
        namingPattern - a NamingPattern instance. This entry can be null.
      • getLastPatternIndex

        java.lang.Integer getLastPatternIndex()
        Provides the value of the LastPatternIndex property value of this file plan.
        Returns:
        An Integer value. This entry can be null.
      • setLastPatternIndex

        void setLastPatternIndex(java.lang.Integer value)
        Sets the value of the LastPatternIndex property for this file plan.
        Parameters:
        value - an Integer object. This entry can be null.
      • delete

        void delete()
        Deletes this file plan entity. File plan must be empty.

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