Files
BusinessMgr-2019/SaBusMgrStandardBase/Base/Core/ISbmCoreInstanceConsole.cs
T

59 lines
2.0 KiB
C#

using Sarand.BusinessMgr.Net.Standard.Base.Bus;
using Sarand.BusinessMgr.Net.Standard.Base.Data;
namespace Sarand.BusinessMgr.Net.Standard.Base.Core
{
//=======================================================================
/// <summary>
/// Utilitiy functions relating to a core BusinessMgr database instance.
/// <para>For instance:</para>
/// <para>- Verifying repository status.</para>
/// <para>- Initialisation of new repository.</para>
/// <para>- Bringing static (tax codes etc) and reference data up to date.</para>
/// </summary>
public interface ISbmCoreInstanceConsole
{
//-------------------------------------------------------------------
// Methods.
/// <summary>
/// Is repository database valid.
/// <para>- Contains core tables (Affiliate, Association, Commodity etc).</para>
/// </summary>
bool IsRepositoryValid();
/// <summary>
/// Is repository database initialised.
/// <para>- Has a valid internal association.</para>
/// <para>- Has at least one user.</para>
/// </summary>
bool IsRepositoryInitialised();
/// <summary>
/// Validate repository initialisation data.
/// <para>- Organisation properties.</para>
/// <para>- User properties.</para>
/// <para>- User security properties.</para>
/// </summary>
bool ValidateRepositoryInitialisionData(SbmRepositoryInitialisationData initData);
/// <summary>
/// Initialise repository.
/// <para>- Organisation contact.</para>
/// <para>- Internal association.</para>
/// <para>- Security item and 'Super' group.</para>
/// <para>- User contact.</para>
/// <para>- User member association.</para>
/// </summary>
bool InitialiseRepository(SbmRepositoryInitialisationData initData);
/// <summary>
/// Add User Account.
/// </summary>
bool AddUserAccount(SbmRepositoryPopulationData.UserAccount userAccount);
//-------------------------------------------------------------------
}
//=======================================================================
}