Mercurial > repos > IBDev-IBBoard.WarFoundry.API
annotate api/Objects/IWarFoundryStagedLoadObject.cs @ 161:81abc04b3dbe
Re #192: Improve "clean coding" practice
* Move some calculation methods for equipment out of the encapsulation objects
| author | IBBoard <dev@ibboard.co.uk> |
|---|---|
| date | Sun, 04 Oct 2009 12:00:16 +0000 |
| parents | 2f3cafb69799 |
| children |
| rev | line source |
|---|---|
|
104
2f3cafb69799
Re #121: Migrate to AGPL license
IBBoard <dev@ibboard.co.uk>
parents:
51
diff
changeset
|
1 // This file (IWarFoundryStagedLoadObject.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2007, 2008, 2009 IBBoard. |
| 15 | 2 // |
|
104
2f3cafb69799
Re #121: Migrate to AGPL license
IBBoard <dev@ibboard.co.uk>
parents:
51
diff
changeset
|
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. |
| 15 | 4 |
| 0 | 5 using System; |
| 6 using ICSharpCode.SharpZipLib.Zip; | |
| 7 using IBBoard.WarFoundry.API.Factories; | |
| 8 | |
| 9 namespace IBBoard.WarFoundry.API.Objects | |
| 10 { | |
| 11 public interface IWarFoundryStagedLoadObject : IWarFoundryObject | |
| 12 { | |
| 13 /// <summary> | |
| 14 /// Checks whether the object has been fully loaded or whether only the first stage of loading has been performed. | |
| 15 /// If the object is not fully loaded then the method must finish loading the object. | |
| 16 /// </summary> | |
| 17 void EnsureFullyLoaded(); | |
| 18 | |
| 19 /// <value> | |
| 20 /// Gets the <code>AbstractNativeWarFoundryFactory</code> that created the object. | |
| 21 /// </value> | |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
0
diff
changeset
|
22 IWarFoundryFactory Factory { get; } |
| 0 | 23 |
| 24 /// <value> | |
| 25 /// Returns <code>true</code> if the object has been fully loaded with all data, else returns <code>false</code> | |
| 26 /// </value> | |
| 27 bool IsFullyLoaded { get; } | |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
0
diff
changeset
|
28 |
| 51 | 29 /// <value> |
| 30 /// Returns <code>true</code> if the object is in the process of being fully loaded with all data, else returns <code>false</code> | |
| 31 /// </value> | |
| 32 bool IsLoading { get; } | |
| 33 | |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
0
diff
changeset
|
34 /// <summary> |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
0
diff
changeset
|
35 /// Marks the object as fully loaded so that no more load checking is required. |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
0
diff
changeset
|
36 /// </summary> |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
0
diff
changeset
|
37 void SetAsFullyLoaded(); |
| 51 | 38 |
| 39 /// <summary> | |
| 40 /// Markes the object as being in the process of being fully loaded. | |
| 41 /// </summary> | |
| 42 void SetAsLoading(); | |
| 0 | 43 } |
| 44 } |