Enum EntityItem.Status

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<EntityItem.Status>
    Enclosing class:
    EntityItem

    public static enum EntityItem.Status
    extends java.lang.Enum<EntityItem.Status>
    Resulting status of an operation.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DELETED
      A record was deleted.
      EXCEPTION
      The proposed change was tried but failed.
      FAILED
      The proposed change was tried but failed.
      INSERTED
      A new record was inserted.
      PROCESSING
      Connector has started processing but not yet finished.
      UPDATED
      An existing record was updated.
      UPSERTED
      The data have been placed into the content system.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getMessage()
      Textual message describing this status in general.
      static EntityItem.Status valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static EntityItem.Status[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

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

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

      • EXCEPTION

        public static final EntityItem.Status EXCEPTION
        The proposed change was tried but failed. A rollback could not be accomplished or failed.
      • FAILED

        public static final EntityItem.Status FAILED
        The proposed change was tried but failed. A rollback was successful.
      • INSERTED

        public static final EntityItem.Status INSERTED
        A new record was inserted. Probably a new identifier was generated and can be read via value.getIdentifier(). This may be the result of an UPDATE or UPSERT operation.
      • PROCESSING

        public static final EntityItem.Status PROCESSING
        Connector has started processing but not yet finished. E.g. Database transaction was started BEGIN but COMMIT has not completed yet.
      • UPDATED

        public static final EntityItem.Status UPDATED
        An existing record was updated. Identifier will be the same, but value.getVersion() may have been changed. This may be the result of an UPDATE or UPSERT operation.
      • UPSERTED

        public static final EntityItem.Status UPSERTED
        The data have been placed into the content system. We have no information whether the entry was updated or inserted or whether we have a new identifier.
    • Method Detail

      • values

        public static EntityItem.Status[] 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 (EntityItem.Status c : EntityItem.Status.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static EntityItem.Status 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
      • getMessage

        public java.lang.String getMessage()
        Textual message describing this status in general.
        Returns:
        message