1	<?php
2	/**
3	* Interface for record writer strategies.
4	*
5	* PHP version 7
6	*
7	* Copyright (c) Demian Katz 2016.
8	*
9	* This program is free software; you can redistribute it and/or modify
10	* it under the terms of the GNU General Public License version 2,
11	* as published by the Free Software Foundation.
12	*
13	* This program is distributed in the hope that it will be useful,
14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16	* GNU General Public License for more details.
17	*
18	* You should have received a copy of the GNU General Public License
19	* along with this program; if not, write to the Free Software
20	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21	*
22	* @category VuFind
23	* @package  Harvest_Tools
24	* @author   Demian Katz <demian.katz@villanova.edu>
25	* @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
26	* @link     https://vufind.org/wiki/indexing:oai-pmh Wiki
27	*/
28	namespace VuFindHarvest\RecordWriterStrategy;
29
30	/**
31	* Interface for record writer strategies.
32	*
33	* @category VuFind
34	* @package  Harvest_Tools
35	* @author   Demian Katz <demian.katz@villanova.edu>
36	* @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
37	* @link     https://vufind.org/wiki/indexing:oai-pmh Wiki
38	*/
39	interface RecordWriterStrategyInterface
40	{
41	/**
42	* Get base path for writes.
43	*
44	* @return string
45	*/
46	public function getBasePath();
47
48	/**
49	* Called before the writing process begins.
50	*
51	* @return void
52	*/
53	public function beginWrite();
54
55	/**
56	* Add the ID of a deleted record.
57	*
58	* @param string $id ID
59	*
60	* @return void
61	*/
62	public function addDeletedRecord($id);
63
64	/**
65	* Add a non-deleted record.
66	*
67	* @param string $id     ID
68	* @param string $record Record XML
69	*
70	* @return void
71	*/
72	public function addRecord($id, $record);
73
74	/**
75	* Close out the writing process.
76	*
77	* @return void
78	*/
79	public function endWrite();
80	}