com.ibm.jarm.api.core

Interface DefensiblyDisposableContainerParent

    • Method Detail

      • canContainDefensibleDisposalContainer

        boolean canContainDefensibleDisposalContainer()
        Indicates whether or not this container is eligible to be the parent of a "Defensibly Disposable" child container.
        Returns:
        true if this container is eligible.
      • addDefensiblyDisposableContainer

        RecordContainer addDefensiblyDisposableContainer(java.lang.String triggerPropertyName,
                                                       int retentionInYears,
                                                       int retentionInMonths,
                                                       int retentionInDays,
                                                       RMProperties props,
                                                       java.util.List<RMPermission> perms,
                                                       java.lang.String idStr)
        Creates a new DefensiblyDisposable container as an immediate child of this container and saves it to the associated FilePlanRepository.
        Parameters:
        triggerPropertyName - the symbolic name of a DataType.DateTime record property to be used as the disposition trigger.
        retentionInYears - integer value between 0 and 9999 inclusive that represents the number of years of retention.
        retentionInMonths - integer value between 0 and 9999 inclusive that represents the number of months of retention.
        retentionInDays - integer value between 0 and 9999 inclusive that represents the number of days of retention.
        props - the RMProperties collection to assign to the new instance.
        perms - an optional RMPermission collection to assign to the new instance. This parameter can be null.
        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 RecordContainer instance that supports "Defensibly Disposable".

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