// This file (Requirement.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2011 IBBoard // // 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. using System; using IBBoard.WarFoundry.API.Objects.Requirement.Context; namespace IBBoard.WarFoundry.API.Objects.Requirement { /// /// Base interface for a Requirement that constrains the IWarFoundryObjects that can be taken in an army /// public interface IRequirement { /// /// Gets the ID of the requirement type. This is used by the requirement factories. /// It may be, but is not required to be, the name of the class. /// /// /// The ID of the requirement type. /// string RequirementID { get; } /// /// Checks whether the supplied IWarFoundryObject can be added to the supplied army. /// /// /// A Validation enum to show the result of the validation /// /// /// The object that we want to add. This may be involved in the check, or it may not affect the evaluation of the requirement /// /// /// The army to add the object to. /// Validation AllowsAdding(IWarFoundryObject wfObject, Army toArmy, AddingContext context); /// /// Checks whether the supplied army is currently valid according to this requirement. /// /// /// A Validation enum to show the result of the validation /// /// /// The army to validate /// Validation ValidatesArmy(Army army); /// /// Gets the validation message from validating the army /// /// /// A validation message, if the validation fails, else an empty string. /// /// /// The army to validate. /// string GetValidationMessage(Army army); /// /// Gets the validation message for adding an IWarFoundryObject to the army /// /// /// A validation message, if the object cannot be added, else an empty string. /// /// /// The IWarFoundryObject to try to add /// /// /// The army the object will be added to /// /// /// The context of the addition /// string GetAllowsAddingMessage(IWarFoundryObject toAdd, Army toArmy, AddingContext context); } }