io.ebeaninternal.api.SpiUpdate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebean-core Show documentation

ebean core module

There is a newer version: 15.8.0

package io.ebeaninternal.api;

import io.ebean.Update;

/**
 * Internal extension to the Update interface.
 */
public interface SpiUpdate extends Update {

  /**
   * The type of the update request.
   */
  enum OrmUpdateType {
    INSERT {
      @Override
      public String toString() {
        return "Insert";
      }
    },
    UPDATE {
      @Override
      public String toString() {
        return "Update";
      }
    },
    DELETE {
      @Override
      public String toString() {
        return "Delete";
      }
    },
    UNKNOWN {
      @Override
      public String toString() {
        return "Unknown";
      }

    }
  }

  /**
   * Return the type of bean being updated.
   */
  Class beanType();

  /**
   * Return the label (for metrics collection).
   */
  String label();

  /**
   * Return the type of this - insert, update or delete.
   */
  OrmUpdateType ormUpdateType();

  /**
   * Return the name of the table being modified.
   */
  String baseTable();

  /**
   * Return the update statement. This could be either sql or an orm update with bean types and property names.
   */
  String updateStatement();

  /**
   * Return the timeout in seconds.
   */
  int timeout();

  /**
   * Return true if the cache should be notified to invalidate objects.
   */
  boolean isNotifyCache();

  /**
   * Return the bind parameters.
   */
  BindParams bindParams();

  /**
   * Set the generated sql used.
   */
  void setGeneratedSql(String sql);
}