view api/Objects/IWarFoundryStagedLoadObject.cs @ 10:607c3232d689

Re #11 - Documentation * Document Stats and SystemStats at class level to explain the difference * Document WarFoundryXmlFactory at class level Re #13 - XPath for XML loading * Load categories using XPath - needs fixing so we can do a proper "categories/cat" query Re #10 - Refactoring for readability * Fix method signature for getting number from attribute added in r19 * Refactor more code in to GetExtraData method * Separate out loading of categories for GameSystem
author IBBoard <dev@ibboard.co.uk>
date Sun, 04 Jan 2009 20:43:36 +0000
parents 613bc5eaac59
children 306558904c2a
line wrap: on
line source

using System;
using ICSharpCode.SharpZipLib.Zip;
using IBBoard.WarFoundry.API.Factories;

namespace IBBoard.WarFoundry.API.Objects
{
	public interface IWarFoundryStagedLoadObject : IWarFoundryObject
	{	
		/// <summary>
		/// Checks whether the object has been fully loaded or whether only the first stage of loading has been performed.
		/// If the object is not fully loaded then the method must finish loading the object.
		/// </summary>
		void EnsureFullyLoaded();
		
		/// <value>
		/// Gets the <code>AbstractNativeWarFoundryFactory</code> that created the object.
		/// </value>
		IWarFoundryFactory Factory	{ get; }
		
		/// <value>
		/// Returns <code>true</code> if the object has been fully loaded with all data, else returns <code>false</code>
		/// </value>
		bool IsFullyLoaded { get; }
		
		/// <summary>
		/// Marks the object as fully loaded so that no more load checking is required.
		/// </summary>
		void SetAsFullyLoaded();
	}
}