1	<?php
2
3	/**
4	* Interface for record writer strategies.
5	*
6	* PHP version 7
7	*
8	* Copyright (c) Demian Katz 2016.
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  Harvest_Tools
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/indexing:oai-pmh Wiki
28	*/
29
30	namespace VuFindHarvest\RecordWriterStrategy;
31
32	/**
33	* Interface for record writer strategies.
34	*
35	* @category VuFind
36	* @package  Harvest_Tools
37	* @author   Demian Katz <demian.katz@villanova.edu>
38	* @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
39	* @link     https://vufind.org/wiki/indexing:oai-pmh Wiki
40	*/
41	interface RecordWriterStrategyInterface
42	{
43	/**
44	* Get base path for writes.
45	*
46	* @return string
47	*/
48	public function getBasePath();
49
50	/**
51	* Called before the writing process begins.
52	*
53	* @return void
54	*/
55	public function beginWrite();
56
57	/**
58	* Add the ID of a deleted record.
59	*
60	* @param string $id ID
61	*
62	* @return void
63	*/
64	public function addDeletedRecord($id);
65
66	/**
67	* Add a non-deleted record.
68	*
69	* @param string $id     ID
70	* @param string $record Record XML
71	*
72	* @return void
73	*/
74	public function addRecord($id, $record);
75
76	/**
77	* Close out the writing process.
78	*
79	* @return void
80	*/
81	public function endWrite();
82	}