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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Timeline.Entities;
using Timeline.Models;
using Timeline.Models.Http;
namespace Timeline.Services
{
/// <summary>
/// This define the common interface of both personal timeline
/// and normal timeline.
/// </summary>
/// <remarks>
/// The "name" parameter in method means name of timeline in
/// <see cref="ITimelineService"/> while username of the owner
/// of the personal timeline in <see cref="IPersonalTimelineService"/>.
/// </remarks>
public interface IBaseTimelineService
{
/// <summary>
/// Get all the posts in the timeline.
/// </summary>
/// <param name="name">Username or the timeline name. See remarks of <see cref="IBaseTimelineService"/>.</param>
/// <returns>A list of all posts.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="name"/> is null.</exception>
/// <exception cref="TimelineNameBadFormatException">
/// Thrown when timeline name is of bad format.
/// For normal timeline, it means name is an empty string.
/// For personal timeline, it means the username is of bad format,
/// the inner exception should be a <see cref="UsernameBadFormatException"/>.
/// </exception>
/// <exception cref="TimelineNotExistException">
/// Thrown when timeline does not exist.
/// For normal timeline, it means the name does not exist.
/// For personal timeline, it means the user of that username does not exist
/// and the inner exception should be a <see cref="UserNotExistException"/>.
/// </exception>
Task<List<TimelinePostInfo>> GetPosts(string name);
/// <summary>
/// Create a new post in timeline.
/// </summary>
/// <param name="name">Username or the timeline name. See remarks of <ssee cref="IBaseTimelineService"/>.</param>
/// <param name="author">The author's username.</param>
/// <param name="content">The content.</param>
/// <param name="time">The time of the post. If null, then use current time.</param>
/// <returns>The info of the created post.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="name"/> or <paramref name="author"/> or <paramref name="content"/> is null.</exception>
/// <exception cref="TimelineNameBadFormatException">
/// Thrown when timeline name is of bad format.
/// For normal timeline, it means name is an empty string.
/// For personal timeline, it means the username is of bad format,
/// the inner exception should be a <see cref="UsernameBadFormatException"/>.
/// </exception>
/// <exception cref="TimelineNotExistException">
/// Thrown when timeline does not exist.
/// For normal timeline, it means the name does not exist.
/// For personal timeline, it means the user of that username does not exist
/// and the inner exception should be a <see cref="UserNotExistException"/>.
/// </exception>
/// <exception cref="UsernameBadFormatException">Thrown if <paramref name="author"/> is of bad format.</exception>
/// <exception cref="UserNotExistException">Thrown if <paramref name="author"/> does not exist.</exception>
Task<TimelinePostCreateResponse> CreatePost(string name, string author, string content, DateTime? time);
/// <summary>
/// Delete a post
/// </summary>
/// <param name="name">Username or the timeline name. See remarks of <see cref="IBaseTimelineService"/>.</param>
/// <param name="id">The id of the post to delete.</param>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="name"/> or <paramref name="username"/> is null.</exception>
/// <exception cref="TimelineNameBadFormatException">
/// Thrown when timeline name is of bad format.
/// For normal timeline, it means name is an empty string.
/// For personal timeline, it means the username is of bad format,
/// the inner exception should be a <see cref="UsernameBadFormatException"/>.
/// </exception>
/// <exception cref="TimelineNotExistException">
/// Thrown when timeline does not exist.
/// For normal timeline, it means the name does not exist.
/// For personal timeline, it means the user of that username does not exist
/// and the inner exception should be a <see cref="UserNotExistException"/>.
/// </exception>
/// <exception cref="TimelinePostNotExistException">
/// Thrown when the post with given id does not exist or is deleted already.
/// </exception>
/// <remarks>
/// First use <see cref="IBaseTimelineService.HasPostModifyPermission(string, long, string)"/>
/// to check the permission.
/// </remarks>
Task DeletePost(string name, long id);
/// <summary>
/// Set the properties of a timeline.
/// </summary>
/// <param name="name">Username or the timeline name. See remarks of <see cref="IBaseTimelineService"/>.</param>
/// <param name="newProperties">The new properties. Null member means not to change.</param>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="name"/> or <paramref name="newProperties"/> is null.</exception>
/// <exception cref="TimelineNameBadFormatException">
/// Thrown when timeline name is of bad format.
/// For normal timeline, it means name is an empty string.
/// For personal timeline, it means the username is of bad format,
/// the inner exception should be a <see cref="UsernameBadFormatException"/>.
/// </exception>
/// <exception cref="TimelineNotExistException">
/// Thrown when timeline does not exist.
/// For normal timeline, it means the name does not exist.
/// For personal timeline, it means the user of that username does not exist
/// and the inner exception should be a <see cref="UserNotExistException"/>.
/// </exception>
Task ChangeProperty(string name, TimelinePropertyChangeRequest newProperties);
/// <summary>
/// Remove members to a timeline.
/// </summary>
/// <param name="name">Username or the timeline name. See remarks of <see cref="IBaseTimelineService"/>.</param>
/// <param name="add">A list of usernames of members to add. May be null.</param>
/// <param name="remove">A list of usernames of members to remove. May be null.</param>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="name"/> is null.</exception>
/// <exception cref="TimelineNameBadFormatException">
/// Thrown when timeline name is of bad format.
/// For normal timeline, it means name is an empty string.
/// For personal timeline, it means the username is of bad format,
/// the inner exception should be a <see cref="UsernameBadFormatException"/>.
/// </exception>
/// <exception cref="TimelineNotExistException">
/// Thrown when timeline does not exist.
/// For normal timeline, it means the name does not exist.
/// For personal timeline, it means the user of that username does not exist
/// and the inner exception should be a <see cref="UserNotExistException"/>.
/// </exception>
/// <exception cref="TimelineMemberOperationUserException">
/// Thrown when an exception occurs on the user list.
/// The inner exception is <see cref="UsernameBadFormatException"/>
/// when one of the username is invalid.
/// The inner exception is <see cref="UserNotExistException"/>
/// when one of the user to add does not exist.
/// </exception>
/// <remarks>
/// Operating on a username that is of bad format always throws.
/// Add a user that already is a member has no effects.
/// Remove a user that is not a member also has not effects.
/// Add a user that does not exist will throw <see cref="TimelineMemberOperationUserException"/>.
/// But remove one does not throw.
/// </remarks>
Task ChangeMember(string name, IList<string>? add, IList<string>? remove);
/// <summary>
/// Verify whether a visitor has the permission to read a timeline.
/// </summary>
/// <param name="name">Username or the timeline name. See remarks of <see cref="IBaseTimelineService"/>.</param>
/// <param name="username">The user to check on. Null means visitor without account.</param>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="name"/> is null.</exception>
/// <exception cref="TimelineNameBadFormatException">
/// Thrown when timeline name is of bad format.
/// For normal timeline, it means name is an empty string.
/// For personal timeline, it means the username is of bad format,
/// the inner exception should be a <see cref="UsernameBadFormatException"/>.
/// </exception>
/// <exception cref="TimelineNotExistException">
/// Thrown when timeline does not exist.
/// For normal timeline, it means the name does not exist.
/// For personal timeline, it means the user of that username does not exist
/// and the inner exception should be a <see cref="UserNotExistException"/>.
/// </exception>
/// <returns>True if can read, false if can't read.</returns>
Task<bool> HasReadPermission(string name, string? username);
/// <summary>
/// Verify whether a user has the permission to modify a post.
/// </summary>
/// <param name="name">Username or the timeline name. See remarks of <see cref="IBaseTimelineService"/>.</param>
/// <param name="username">The user to check on.</param>
/// <returns>True if can modify, false if can't modify.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="name"/> or <paramref name="username"/> is null.</exception>
/// <exception cref="TimelineNameBadFormatException">
/// Thrown when timeline name is of bad format.
/// For normal timeline, it means name is an empty string.
/// For personal timeline, it means the username is of bad format,
/// the inner exception should be a <see cref="UsernameBadFormatException"/>.
/// </exception>
/// <exception cref="TimelineNotExistException">
/// Thrown when timeline does not exist.
/// For normal timeline, it means the name does not exist.
/// For personal timeline, it means the user of that username does not exist
/// and the inner exception should be a <see cref="UserNotExistException"/>.
/// </exception>
/// <exception cref="TimelinePostNotExistException">
/// Thrown when the post with given id does not exist or is deleted already.
/// </exception>
/// <exception cref="UsernameBadFormatException">
/// Thrown when <paramref name="username"/> is of bad format.
/// </exception>
/// <exception cref="UserNotExistException">
/// Thrown when <paramref name="username"/> does not exist.
/// </exception>
/// <remarks>
/// This method does not check whether the user is administrator.
/// It only checks whether he is the author of the post or the owner of the timeline.
/// </remarks>
Task<bool> HasPostModifyPermission(string name, long id, string username);
/// <summary>
/// Verify whether a user is member of a timeline.
/// </summary>
/// <param name="name">Username or the timeline name. See remarks of <see cref="IBaseTimelineService"/>.</param>
/// <param name="username">The user to check on.</param>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="name"/> or <paramref name="username"/> is null.</exception>
/// <exception cref="TimelineNameBadFormatException">
/// Thrown when timeline name is of bad format.
/// For normal timeline, it means name is an empty string.
/// For personal timeline, it means the username is of bad format,
/// the inner exception should be a <see cref="UsernameBadFormatException"/>.
/// </exception>
/// <exception cref="TimelineNotExistException">
/// Thrown when timeline does not exist.
/// For normal timeline, it means the name does not exist.
/// For personal timeline, it means the user of that username does not exist
/// and the inner exception should be a <see cref="UserNotExistException"/>.
/// </exception>
/// <exception cref="UsernameBadFormatException">
/// Thrown when <paramref name="username"/> is not a valid username.
/// </exception>
/// <exception cref="UserNotExistException">
/// Thrown when user <paramref name="username"/> does not exist.</exception>
/// <returns>True if it is a member, false if not.</returns>
Task<bool> IsMemberOf(string name, string username);
}
/// <summary>
/// Service for normal timeline.
/// </summary>
public interface ITimelineService : IBaseTimelineService
{
/// <summary>
/// Get the timeline info.
/// </summary>
/// <param name="name">The name of the timeline.</param>
/// <returns>The timeline info.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="name"/> is null.</exception>
/// <exception cref="TimelineNameBadFormatException">
/// Thrown when timeline name is invalid. Currently it means it is an empty string.
/// </exception>
/// <exception cref="TimelineNotExistException">
/// Thrown when timeline with the name does not exist.
/// </exception>
Task<TimelineInfo> GetTimeline(string name);
/// <summary>
/// Create a timeline.
/// </summary>
/// <param name="name">The name of the timeline.</param>
/// <param name="owner">The owner of the timeline.</param>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="name"/> or <paramref name="owner"/> is null.</exception>
/// <exception cref="TimelineNameBadFormatException">
/// Thrown when timeline name is invalid. Currently it means it is an empty string.
/// </exception>
/// <exception cref="TimelineAlreadyExistException">
/// Thrown when the timeline already exists.
/// </exception>
/// <exception cref="UsernameBadFormatException">
/// Thrown when the username of the owner is not valid.
/// </exception>
/// <exception cref="UserNotExistException">
/// Thrown when the owner user does not exist.</exception>
Task CreateTimeline(string name, string owner);
}
public interface IPersonalTimelineService : IBaseTimelineService
{
/// <summary>
/// Get the timeline info.
/// </summary>
/// <param name="username">The username of the owner of the personal timeline.</param>
/// <returns>The timeline info.</returns>
/// <exception cref="ArgumentNullException">
/// Thrown when <paramref name="username"/> is null.
/// </exception>
/// <exception cref="TimelineNameBadFormatException">
/// Thrown when <paramref name="username"/> is of bad format. Inner exception MUST be <see cref="UsernameBadFormatException"/>.
/// </exception>
/// <exception cref="TimelineNotExistException">
/// Thrown when the user does not exist. Inner exception MUST be <see cref="UserNotExistException"/>.
/// </exception>
Task<BaseTimelineInfo> GetTimeline(string username);
}
}
|
