com.ibm.jarm.api.constants

Enum DeleteMode

  • java.lang.Object
    • java.lang.Enum<DeleteMode>
      • com.ibm.jarm.api.constants.DeleteMode
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DeleteMode>


    public enum DeleteMode
    extends java.lang.Enum<DeleteMode>
    Enumerated values that control the "type" of deletion to take place as part of an entity delete method call.
    See Also:
    BaseEntity.delete, BaseEntity.delete
    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      CheckRetainMetadata
      Chooses between a hard and logical deletion based upon the "RetainMetadata" property value of the file plan containing the entity.
      ForceHardDelete
      Forces a hard deletion of an entity dependent on any delete validation results.
      ForceLogicalDelete
      Forces logical deletion of an entity.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static DeleteMode valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DeleteMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • ForceHardDelete

        public static final DeleteMode ForceHardDelete
        Forces a hard deletion of an entity dependent on any delete validation results.
      • ForceLogicalDelete

        public static final DeleteMode ForceLogicalDelete
        Forces logical deletion of an entity.
      • CheckRetainMetadata

        public static final DeleteMode CheckRetainMetadata
        Chooses between a hard and logical deletion based upon the "RetainMetadata" property value of the file plan containing the entity.
    • Method Detail

      • values

        public static DeleteMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (DeleteMode c : DeleteMode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static DeleteMode valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

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