com.filenet.api.constants

Class RetentionConstants

  • java.lang.Object
    • com.filenet.api.constants.RetentionConstants

  • public class RetentionConstants
extends java.lang.Object
    Provides a set of constants for specifying special retention period values for a CmRetentionDate or DefaultRetentionPeriod property.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.util.Date INDEFINITE
      Specifies an indefinite retention period for a CmRetentionDate property.
      static java.lang.Integer INDEFINITE_PERIOD
      Specifies an indefinite retention period for a DefaultRetentionPeriod property.
      static int INDEFINITE_PERIOD_AS_INT
      An int value associated with the INDEFINITE_PERIOD instance of this class.
      static java.util.Date PERMANENT
      Specifies a permanent retention period for a CmRetentionDate property.
      static java.lang.Integer PERMANENT_PERIOD
      Specifies a permanent retention period for a DefaultRetentionPeriod property.
      static int PERMANENT_PERIOD_AS_INT
      An int value associated with the PERMANENT_PERIOD instance of this class.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static java.lang.String toString(java.lang.Object val)
      Returns a String representation of this instance.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • PERMANENT_PERIOD_AS_INT

        public static final int PERMANENT_PERIOD_AS_INT
        An int value associated with the PERMANENT_PERIOD instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility from release to release.
        See Also:
        Constant Field Values

      • PERMANENT_PERIOD

        public static final java.lang.Integer PERMANENT_PERIOD
        Specifies a permanent retention period for a DefaultRetentionPeriod property. An object with a permanent retention period can never be deleted.

      • PERMANENT

        public static final java.util.Date PERMANENT
        Specifies a permanent retention period for a CmRetentionDate property. An object with a permanent retention period can never be deleted.

      • INDEFINITE_PERIOD_AS_INT

        public static final int INDEFINITE_PERIOD_AS_INT
        An int value associated with the INDEFINITE_PERIOD instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values

      • INDEFINITE_PERIOD

        public static final java.lang.Integer INDEFINITE_PERIOD
        Specifies an indefinite retention period for a DefaultRetentionPeriod property. An object with an indefinite retention period can be deleted only if its CmRetentionDate property is changed to an expiration date and time and that date and time is in the past.

      • INDEFINITE

        public static final java.util.Date INDEFINITE
        Specifies an indefinite retention period for a CmRetentionDate property. An object with an indefinite retention period can be deleted only if its CmRetentionDate property is changed to an expiration date and time and that date and time is in the past.

    • Method Detail

      • toString

        public static java.lang.String toString(java.lang.Object val)
        Returns a String representation of this instance.
        Returns:
        A String representing the instance.

© Copyright IBM Corporation 2006, 2013. All rights reserved.