com.ibm.jarm.api.core

Interface DefensiblyDisposable

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void convertToDefensiblyDisposable(java.lang.String triggerPropertyName, int retentionInYears, int retentionInMonths, int retentionInDays, boolean skipValidation)
      Converts this container into a "Defensibly Disposable" type based upon the specified trigger and retention information.
      int[] getRetentionPeriod()
      For a "Defensibly Disposable" container, returns its assigned three-part retention period value.
      java.lang.String getTriggerPropertyName()
      For a "Defensibly Disposable" container, returns the symbolic name of the record DateTime-type property assigned as the trigger property.
      boolean isADefensiblyDisposableContainer()
      Indicates whether or not this container is currently a "Defensibly Disposable" container.
      RMRuntimeException isEligibleForConversion(java.lang.String triggerPropertyName)
      Indicates whether or not this container is eligible for conversion into a "Defensibly Disposable" container.
      void setRetentionPeriod(int retentionInYears, int retentionInMonths, int retentionInDays)
      Updates the assigned retention period used by an existing Defensibly Disposable container.
      void setTriggerPropertyName(java.lang.String triggerPropertyName)
      Updates the assigned record trigger property symbolic name used by an existing Defensibly Disposable container.
    • Method Detail

      • isEligibleForConversion

        RMRuntimeException isEligibleForConversion(java.lang.String triggerPropertyName)
        Indicates whether or not this container is eligible for conversion into a "Defensibly Disposable" container.

        The requirements to meet this eligibility include:

        • The container must be a "leaf" container, in other words it cannot contain any sub-containers.
        • It cannot contain any physical records.
        • It cannot contain any multi-filed records.
        • It cannot contain any records that make use of a RecordType.
        • All existing child records must support the proposed trigger property.
        • Neither the container nor any of it child records can currently be involved in disposition processing.

        Parameters:
        triggerPropertyName - the symbolic name of the proposed record property to be used as the disposition trigger property.
        Returns:
        null to indicate that this container IS eligible for conversion into a "Defensibly Disposable" container. If the container is found to NOT be eligible for conversion, a RMRuntimeException instance will be returned that describes why the container is not eligible.
      • isADefensiblyDisposableContainer

        boolean isADefensiblyDisposableContainer()
        Indicates whether or not this container is currently a "Defensibly Disposable" container.
        Returns:
        true if this container is a "Defensibly Disposable" container.
      • convertToDefensiblyDisposable

        void convertToDefensiblyDisposable(java.lang.String triggerPropertyName,
                                         int retentionInYears,
                                         int retentionInMonths,
                                         int retentionInDays,
                                         boolean skipValidation)
        Converts this container into a "Defensibly Disposable" type based upon the specified trigger and retention information.
        Parameters:
        triggerPropertyName - the symbolic name of a DateTime-type record property to be used as the disposition trigger.
        retentionInYears - integer value between 0 and 999 inclusive that represents the number of years of retention.
        retentionInMonths - integer value between 0 and 99 inclusive that represents the number of months of retention.
        retentionInDays - integer value between 0 and 99 inclusive that represents the number of days of retention.
        skipValidation - true to skip eligibility validation for this container. This parameter should ONLY be set to true if, and only if, the corresponding isADefensiblyDisposableContainer() method has been recently called and has returned with a positive result.
      • getTriggerPropertyName

        java.lang.String getTriggerPropertyName()
        For a "Defensibly Disposable" container, returns the symbolic name of the record DateTime-type property assigned as the trigger property.
        Returns:
        The record trigger property's symbolic name. Can be null.
      • setTriggerPropertyName

        void setTriggerPropertyName(java.lang.String triggerPropertyName)
        Updates the assigned record trigger property symbolic name used by an existing Defensibly Disposable container.
        Parameters:
        triggerPropertyName - the symbolic name of a DataType.DateTime record property to be used as the disposition trigger.
      • getRetentionPeriod

        int[] getRetentionPeriod()
        For a "Defensibly Disposable" container, returns its assigned three-part retention period value.
        Returns:
        An integer array containing the assigned retention period years, months and days values. The return value can be null if no retention period is assigned to this instance. When not null, the array's contents are as follows:
        • int[0] - retention years
        • int[1] - retention months
        • int[2] - retention days
      • setRetentionPeriod

        void setRetentionPeriod(int retentionInYears,
                              int retentionInMonths,
                              int retentionInDays)
        Updates the assigned retention period used by an existing Defensibly Disposable container.
        Parameters:
        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.

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