57
|
1 // This file (ILimit.cs) is a part of the IBBoard project and is copyright 2009 IBBoard
|
|
2 //
|
|
3 // The file and the library/program it is in are licensed and distributed, without warranty, under the GNU Affero GPL license, either version 3 of the License or (at your option) any later version. Please see COPYING for more information and the full license.
|
|
4
|
|
5 using System;
|
|
6
|
|
7 namespace IBBoard.Limits
|
|
8 {
|
|
9 /// <summary>
|
|
10 /// The interface for all limits
|
|
11 /// </summary>
|
|
12 public interface ILimit
|
|
13 {
|
|
14 /// <summary>
|
|
15 /// Gets the limited number, based on the limit that this <code>Limit</code> represents and the number it is limiting (<code>size</code>).
|
|
16 /// </summary>
|
|
17 /// <param name="size">
|
|
18 /// The number to be limited
|
|
19 /// </param>
|
|
20 /// <returns>
|
|
21 /// the limited number, as defined by the implementation of the limit
|
|
22 /// </returns>
|
|
23 int GetLimit(int size);
|
|
24 }
|
|
25 }
|