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 change_tracker 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 change_tracker 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 ChangeTrackerEntityInterface extends EntityInterface
44{
45    /**
46     * Setter for identifier.
47     *
48     * @param string $id Id
49     *
50     * @return ChangeTrackerEntityInterface
51     */
52    public function setId(string $id): ChangeTrackerEntityInterface;
53
54    /**
55     * Getter for identifier.
56     *
57     * @return string
58     */
59    public function getId(): string;
60
61    /**
62     * Setter for index name (formerly core).
63     *
64     * @param string $name Index name
65     *
66     * @return ChangeTrackerEntityInterface
67     */
68    public function setIndexName(string $name): ChangeTrackerEntityInterface;
69
70    /**
71     * Getter for index name (formerly core).
72     *
73     * @return string
74     */
75    public function getIndexName(): string;
76
77    /**
78     * FirstIndexed setter.
79     *
80     * @param ?DateTime $dateTime Time first added to index.
81     *
82     * @return ChangeTrackerEntityInterface
83     */
84    public function setFirstIndexed(?DateTime $dateTime): ChangeTrackerEntityInterface;
85
86    /**
87     * FirstIndexed getter.
88     *
89     * @return ?DateTime
90     */
91    public function getFirstIndexed(): ?DateTime;
92
93    /**
94     * LastIndexed setter.
95     *
96     * @param ?DateTime $dateTime Last time changed in index.
97     *
98     * @return ChangeTrackerEntityInterface
99     */
100    public function setLastIndexed(?DateTime $dateTime): ChangeTrackerEntityInterface;
101
102    /**
103     * LastIndexed getter.
104     *
105     * @return ?DateTime
106     */
107    public function getLastIndexed(): ?DateTime;
108
109    /**
110     * LastRecordChange setter.
111     *
112     * @param ?DateTime $dateTime Last time original record was edited
113     *
114     * @return ChangeTrackerEntityInterface
115     */
116    public function setLastRecordChange(?DateTime $dateTime): ChangeTrackerEntityInterface;
117
118    /**
119     * LastRecordChange getter.
120     *
121     * @return ?DateTime
122     */
123    public function getLastRecordChange(): ?DateTime;
124
125    /**
126     * Deleted setter.
127     *
128     * @param ?DateTime $dateTime Time record was removed from index
129     *
130     * @return ChangeTrackerEntityInterface
131     */
132    public function setDeleted(?DateTime $dateTime): ChangeTrackerEntityInterface;
133
134    /**
135     * Deleted getter.
136     *
137     * @return ?DateTime
138     */
139    public function getDeleted(): ?DateTime;
140}