Mercurial > repos > IBBoard.WarFoundry.API
annotate API/Objects/Requirement/IRequirement.cs @ 455:afc6410e4efc
Re #379: Fix validation of requirements to check for unit
* Move to "Unit" requirements, since we assume things depend on units
* Rename some classes to more meaningful names from unit-based change
* Rename "requires N for M" requirement as we can make it more flexible
author | IBBoard <dev@ibboard.co.uk> |
---|---|
date | Wed, 22 Feb 2012 20:45:39 +0000 |
parents | 8f5125740316 |
children | 248df19652f9 |
rev | line source |
---|---|
358
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
1 // This file (Requirement.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2011 IBBoard |
347 | 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 using System; | |
5 | |
6 namespace IBBoard.WarFoundry.API.Objects.Requirement | |
358
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
7 { |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
8 /// <summary> |
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
428
diff
changeset
|
9 /// Base interface for a Requirement that constrains the IWarFoundryObjects that can be taken in an army |
347 | 10 /// </summary> |
11 public interface IRequirement | |
358
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
12 { |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
13 /// <summary> |
428
8f5125740316
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
364
diff
changeset
|
14 /// Gets the ID of the requirement type. This is used by the requirement factories. |
8f5125740316
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
364
diff
changeset
|
15 /// It may be, but is not required to be, the name of the class. |
8f5125740316
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
364
diff
changeset
|
16 /// </summary> |
8f5125740316
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
364
diff
changeset
|
17 /// <value> |
8f5125740316
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
364
diff
changeset
|
18 /// The ID of the requirement type. |
8f5125740316
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
364
diff
changeset
|
19 /// </value> |
8f5125740316
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
364
diff
changeset
|
20 string RequirementID { get; } |
8f5125740316
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
364
diff
changeset
|
21 |
8f5125740316
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
364
diff
changeset
|
22 /// <summary> |
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
428
diff
changeset
|
23 /// Checks whether the supplied IWarFoundryObject can be added to the supplied army. |
358
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
24 /// </summary> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
25 /// <returns> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
26 /// A <code>Validation</code> enum to show the result of the validation |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
27 /// </returns> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
28 /// <param name='wfObject'> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
29 /// The object that we want to add. This may be involved in the check, or it may not affect the evaluation of the requirement |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
30 /// </param> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
31 /// <param name='toArmy'> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
32 /// The army to add the object to. |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
33 /// </param> |
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
428
diff
changeset
|
34 Validation AllowsAdding(IWarFoundryObject wfObject, Army toArmy); |
358
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
35 |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
36 /// <summary> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
37 /// Checks whether the supplied army is currently valid according to this requirement. |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
38 /// </summary> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
39 /// <returns> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
40 /// A <code>Validation</code> enum to show the result of the validation |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
41 /// </returns> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
42 /// <param name='toValidate'> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
43 /// The army to validate |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
44 /// </param> |
347 | 45 Validation ValidatesArmy(Army army); |
358
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
46 |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
47 /// <summary> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
48 /// Gets the validation message from validating the army |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
49 /// </summary> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
50 /// <returns> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
51 /// A validation message, if the validation fails, else an empty string. |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
52 /// </returns> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
53 /// <param name='army'> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
54 /// The army to validate. |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
55 /// </param> |
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
347
diff
changeset
|
56 string GetValidationMessage(Army army); |
364
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
57 |
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
58 /// <summary> |
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
428
diff
changeset
|
59 /// Gets the validation message for adding an IWarFoundryObject to the army |
364
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
60 /// </summary> |
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
61 /// <returns> |
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
428
diff
changeset
|
62 /// A validation message, if the object cannot be added, else an empty string. |
364
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
63 /// </returns> |
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
64 /// <param name='toAdd'> |
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
428
diff
changeset
|
65 /// The IWarFoundryObject to try to add |
364
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
66 /// </param> |
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
67 /// <param name='toArmy'> |
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
428
diff
changeset
|
68 /// The army the object will be added to |
364
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
69 /// </param> |
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
428
diff
changeset
|
70 string GetAllowsAddingMessage(IWarFoundryObject toAdd, Army toArmy); |
347 | 71 } |
72 } | |
73 |