xtendm3-sdk.0.18.3.source-code.DBAction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xtendm3-sdk Show documentation
XtendM3 SDK for developing XtendM3 Extensions locally
The newest version!
import groovy.lang.Closure;

/**
 * Action API for database access
 *
 * @param  Generic table
 * @since API Version 0.5.0
 */
public interface DBAction {

  /**
   * Read a record in the database, matching the keys in the container
   *
   * @param container The container filled with values from read record
   * @return {@code true} if a record is found
   * @since API Version 0.5.0
   */
  boolean read(DBContainer container);

  /**
   * Lock a record in the database, matching the keys in the container and execute the callback method if the record exists
   *
   * @param container The container filled with values from read record
   * @param callback  A defined Closure method to call for the locked record in database, matching the container key
   * @return {@code true} if a record is found
   * @since API Version 0.5.0
   */
  boolean readLock(DBContainer container, Closure callback);

  /**
   * Read all records in the database matching the keys in the container
   *
   * @param keyContainer The key container used to match records in the database
   * @param nrOfKeys     The number of keys to use when match records in database
   * @param callback     A defined Closure method to call for each record in database, matching the key
   * @return The number of records read from database
   * @since API Version 0.5.0
   */
  int readAll(DBContainer keyContainer, int nrOfKeys, Closure callback);

  /**
   * Read all records in the database matching the keys in the container
   *
   * @param keyContainer  The key container used to match records in the database
   * @param nrOfKeys      The number of keys to use when match records in database
   * @param nrOfRecords   The number of records to read from the database
   * @param callback      A defined Closure method to call for each record in database, matching the key
   * @return The number of records read from database
   */
  int readAll(DBContainer keyContainer, int nrOfKeys, int nrOfRecords, Closure callback);

  /**
   * Read all records in the database matching the keys in the container and execute the callback method for each existing record
   *
   * @param keyContainer The key container used to match records in the database
   * @param nrOfKeys     The number of keys to use when match records in database
   * @param callback     A defined Closure method to call for each record in database, matching the key
   * @return The number of records read from database
   * @since API Version 0.8.0
   */
  int readAllLock(DBContainer keyContainer, int nrOfKeys, Closure callback);

  /**
   * Try to insert a record into the database
   *
   * @param container The container to insert in database
   * @return {@code true} if the insert succeeds
   * @since API Version 0.5.0
   */
  boolean insert(DBContainer container);

  /**
   * Try to insert a record in to the database. If the record exists, the callback method will be executed
   *
   * @param container The container to insert in database
   * @param callback  A defined Closure method to call when the record exists
   * @return {@code true} if the insert succeeds
   * @since API Version 0.5.0
   */
  boolean insert(DBContainer container, Closure callback);

  /**
   * Create a new database container
   *
   * @return New database container
   * @since API Version 0.5.0
   */
  DBContainer createContainer();

  /**
   * Get a database container with the current state
   *
   * @return Container with the current state
   * @since API Version 0.5.0
   */
  DBContainer getContainer();
}