Mercurial > repos > IBDev-IBBoard.WarFoundry.API

comparison API/Objects/IWarFoundryStagedLoadObject.cs @ 337:3c4a6403a88c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Fix capitalisation so that new files are in the namespace no-open-ticket
author IBBoard <dev@ibboard.co.uk>
date Sun, 03 Apr 2011 18:50:32 +0000
parents
children
comparison
equal deleted inserted replaced
336:3631c1493c7f 337:3c4a6403a88c
1 // This file (IWarFoundryStagedLoadObject.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2007, 2008, 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 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>
22 IWarFoundryFactory Factory { get; }
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; }
28
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
34 /// <summary>
35 /// Marks the object as fully loaded so that no more load checking is required.
36 /// </summary>
37 void SetAsFullyLoaded();
38
39 /// <summary>
40 /// Markes the object as being in the process of being fully loaded.
41 /// </summary>
42 void SetAsLoading();
43 }
44 }