Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3/**
4 * Optional backend feature: retrieve batch of records.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2010.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  Search
25 * @author   David Maus <maus@hab.de>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org
28 */
29
30namespace VuFindSearch\Feature;
31
32use VuFindSearch\ParamBag;
33
34/**
35 * Optional backend feature: retrieve batch of records.
36 *
37 * @category VuFind
38 * @package  Search
39 * @author   David Maus <maus@hab.de>
40 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
41 * @link     https://vufind.org
42 */
43interface RetrieveBatchInterface
44{
45    /**
46     * Retrieve a batch of documents.
47     *
48     * @param array    $ids    Array of document identifiers
49     * @param ParamBag $params Search backend parameters
50     *
51     * @return \VuFindSearch\Response\RecordCollectionInterface
52     */
53    public function retrieveBatch($ids, ParamBag $params = null);
54}