blob: ccab3188e74443f94025da13744f2c8c71d3a99d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
/*
* Copyright (c) 2023 Vaughn Nugent
*
* Library: CMNext
* Package: Content.Publishing.Blog.Admin
* File: IRecordDb.cs
*
* CMNext is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* CMNext is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
using System.IO;
using System.Collections.Generic;
namespace Content.Publishing.Blog.Admin.Model
{
/// <summary>
/// Represents a simple primary-key record based database
/// </summary>
/// <typeparam name="T">The record type</typeparam>
internal interface IRecordDb<T>
{
/// <summary>
/// Sets a record in the database. Adds or overwrites the entire record if it already exists.
/// </summary>
/// <param name="record">The record to set</param>
void SetRecord(T record);
/// <summary>
/// Removes a record from the database by its id
/// </summary>
/// <param name="id">The id of the record to delete</param>
void RemoveRecord(string id);
/// <summary>
/// Gets a record from the database by its id
/// </summary>
/// <param name="id">The id of the item to get</param>
/// <returns>The item if found, null otherwise</returns>
T? GetRecord(string id);
/// <summary>
/// Gets all records in the database
/// </summary>
/// <returns>A enumeration of the current collection of records</returns>
IEnumerable<T> GetRecords();
/// <summary>
/// Writes the entire state of the current store to the given stream
/// </summary>
/// <param name="stream">The stream to write the state data to</param>
void Store(Stream stream);
/// <summary>
/// Loads the entire state of the store from the given stream
/// </summary>
/// <param name="stream">The stream to read the state from</param>
void Load(Stream stream);
}
}
|
