com.ibm.jarm.api.core

Interface AlternateRetention

  • All Superinterfaces:
    AuditableEntity, BaseEntity, Persistable, RMCustomObject


    public interface AlternateRetention
    extends RMCustomObject
    An interface that represents an AlternateRetention custom object that can be an optional member of a DispositionPhase instance.

    Alternate retention instances are created and managed using the DispositionPhase and AlternateRetentionList interfaces.

    A new alternate retention is created using the DispositionPhase instance to which it belongs, for example:

       // The disposition phase to which a new alternate retention is added.
       DispositionPhase dispPhase = ...;
       AlternateRetentionList altRetents = dispPhase.getAlternateRetentions();
       AlternateRetention newAltRetent = dispPhase.createAlternateRetention();
       newAltRetent.setXXX(); ... // Further define the new alternate retention.
       // Add the new alternate retention to the phase's existing collection.
       altRetents.add(newAltRetent);
       // Finally save the phase or schedule in order to persist the new alternate
       //  retention to the repository.
       dispPhase.save(RMRefreshMode.Refresh);
     
    See Also:
    DispositionPhase.createAlternateRetention(), AlternateRetentionList
    • Method Detail

      • getRetentionNumber

        java.lang.Integer getRetentionNumber()
        Returns the 1-based positional order of this alternate retention instance within its containing DispositionPhase parent.
        Returns:
        An Integer value.
      • getRetentionBase

        java.lang.String getRetentionBase()
        Returns the symbolic property name that defines the retention base for this alternate retention instance.
        Returns:
        A String value.
      • setRetentionBase

        void setRetentionBase(java.lang.String propSymbolicName)
        Defines the DateTime-type property that is used as the retention base value by this alternate retention instance.
        Parameters:
        propSymbolicName - a symbolic name String value. Cannot be null or blank.
      • getRetentionPeriod

        java.lang.Integer[] getRetentionPeriod()
        Returns the three Integer values that define the retention time period in years, months and days, respectively, for this alternate retention.
        Returns:
        An Integer[] of a fixed size of three entries. The first entry represents years The second entry represents months. The third entry represents days. Any of these values can be null or an Integer value greater than or equal to 0.
      • setRetentionPeriod

        void setRetentionPeriod(java.lang.Integer years,
                              java.lang.Integer months,
                              java.lang.Integer days)
        Sets the retention time period for this alternate retention.
        Parameters:
        years - an Integer value greater than or equal to 0. If null, will be saved as Integer(0).
        months - an Integer value greater than or equal to 0. If null, will be saved as Integer(0).
        days - an Integer value greater than or equal to 0. If null, will be saved as Integer(0).
      • getConditionXML

        java.lang.String getConditionXML()
        Returns an XML string fragment describing the condition defined for this alternate retention.
        Returns:
        A String XML fragment.
      • setConditionXML

        void setConditionXML(java.lang.String xmlFragment)
        Sets the XML string fragment that describes the condition defined for this alternate retention.
        Parameters:
        xmlFragment - a String value. Cannot be null or blank.

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