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 * Entity model interface for record table
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2024.
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  Database
25 * @author   Demian Katz <demian.katz@villanova.edu>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org/wiki/development:plugins:database_gateways Wiki
28 */
29
30namespace VuFind\Db\Entity;
31
32use DateTime;
33
34/**
35 * Entity model interface for record table
36 *
37 * @category VuFind
38 * @package  Database
39 * @author   Demian Katz <demian.katz@villanova.edu>
40 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
41 * @link     https://vufind.org/wiki/development:plugins:database_gateways Wiki
42 */
43interface RecordEntityInterface extends EntityInterface
44{
45    /**
46     * Get identifier (returns null for an uninitialized or non-persisted object).
47     *
48     * @return ?int
49     */
50    public function getId(): ?int;
51
52    /**
53     * Get record id.
54     *
55     * @return ?string
56     */
57    public function getRecordId(): ?string;
58
59    /**
60     * Set record id.
61     *
62     * @param ?string $recordId Record id
63     *
64     * @return RecordEntityInterface
65     */
66    public function setRecordId(?string $recordId): RecordEntityInterface;
67
68    /**
69     * Get record source.
70     *
71     * @return ?string
72     */
73    public function getSource(): ?string;
74
75    /**
76     * Set record source.
77     *
78     * @param ?string $recordSource Record source
79     *
80     * @return RecordEntityInterface
81     */
82    public function setSource(?string $recordSource): RecordEntityInterface;
83
84    /**
85     * Get record version.
86     *
87     * @return string
88     */
89    public function getVersion(): string;
90
91    /**
92     * Set record version.
93     *
94     * @param string $recordVersion Record version
95     *
96     * @return RecordEntityInterface
97     */
98    public function setVersion(string $recordVersion): RecordEntityInterface;
99
100    /**
101     * Get record data.
102     *
103     * @return ?string
104     */
105    public function getData(): ?string;
106
107    /**
108     * Set record data.
109     *
110     * @param ?string $recordData Record data
111     *
112     * @return RecordEntityInterface
113     */
114    public function setData(?string $recordData): RecordEntityInterface;
115
116    /**
117     * Get updated date.
118     *
119     * @return DateTime
120     */
121    public function getUpdated(): DateTime;
122
123    /**
124     * Set updated date.
125     *
126     * @param DateTime $dateTime Updated date
127     *
128     * @return RecordEntityInterface
129     */
130    public function setUpdated(DateTime $dateTime): RecordEntityInterface;
131}