io.github.mmm.orm.spi.access.DbSelectAccess Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mmm-orm-spi Show documentation

Service Provider API (SPI) for mmm-orm.

There is a newer version: 0.9.8

/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package io.github.mmm.orm.spi.access;

import io.github.mmm.entity.bean.EntityBean;
import io.github.mmm.entity.id.Id;
import io.github.mmm.orm.statement.NonUniqueResultException;
import io.github.mmm.orm.statement.select.SelectStatement;

/**
 * Interface providing support for {@link #select(SelectStatement)} and {@link #selectOne(SelectStatement)}.
 */
public interface DbSelectAccess {

  /**
   * @param  type of the result objects to select.
   * @param statement the {@link SelectStatement} to query the requested objects.
   * @return an {@link Iterable} with the matching objects.
   */
   Iterable select(SelectStatement statement);

  /**
   * @param  type of the result object to select.
   * @param statement the {@link SelectStatement} to query the requested object. Should produce a single result or no
   *        result.
   * @return the matching object or {@code null} if not found.
   * @throws NonUniqueResultException if the given {@link SelectStatement} produced more than one result.
   */
   R selectOne(SelectStatement statement);

  /**
   * @param  type of the {@link EntityBean} to select.
   * @param id the {@link EntityBean#Id() ID} of the {@link EntityBean} to select.
   * @param prototype the (empty) {@link EntityBean} instance to act as template.
   * @return the {@link EntityBean} with the given {@link Id} or {@code null} if no such {@link EntityBean} exists.
   */
   E selectById(Id id, E prototype);

}