Ict.Petra.Server.MCommon.MCommonMain Class Reference

Contains utility and helper functions that are Petra Server specific and are shared between several Petra modules. More...

Static Public Member Functions
static Boolean	RetrievePartnerShortName (Int64 APartnerKey, out String APartnerShortName, out TPartnerClass APartnerClass, out TStdPartnerStatusCode APartnerStatus, TDBTransaction ATransaction)
	Retrieves the Partner ShortName, the PartnerClass and PartnerStatus. More...
static bool	CheckPartnerExists1 (Int64 APartnerKey, bool AMustNotBeMergedPartner)
	Checks for the existance of a Partner. More...
static PPartnerRow	CheckPartnerExists2 (Int64 APartnerKey, bool AMustNotBeMergedPartner, TDataBase ADataBase=null)
	Checks for the existance of a Partner. More...

Detailed Description

Contains utility and helper functions that are Petra Server specific and are shared between several Petra modules.

Member Function Documentation

CheckPartnerExists1()

static bool Ict.Petra.Server.MCommon.MCommonMain.CheckPartnerExists1 ( Int64  APartnerKey, bool  AMustNotBeMergedPartner  )

inlinestatic

Checks for the existance of a Partner.

Parameters

APartnerKey	PartnerKey of the Partner to check for.
AMustNotBeMergedPartner	Set to true to check whether the Partner must not be a Merged Partner.

Returns

True if the Partner exists (taking AMustNotBeMergedPartner into consideration), otherwise False.

CheckPartnerExists2()

static PPartnerRow Ict.Petra.Server.MCommon.MCommonMain.CheckPartnerExists2 ( Int64  APartnerKey, bool  AMustNotBeMergedPartner, TDataBase  ADataBase = null  )

inlinestatic

Checks for the existance of a Partner.

Parameters

APartnerKey	PartnerKey of the Partner to check for.
AMustNotBeMergedPartner	Set to true to check whether the Partner must not be a Merged Partner.

Returns

An instance of PPartnerRow if the Partner exists (taking AMustNotBeMergedPartner into consideration), otherwise null.

Parameters

ADataBase

An instantiated TDataBase object, or null (default = null). If null gets passed then the Method executes DB commands with a new Database connection

RetrievePartnerShortName()

static Boolean Ict.Petra.Server.MCommon.MCommonMain.RetrievePartnerShortName ( Int64  APartnerKey, out String  APartnerShortName, out TPartnerClass  APartnerClass, out TStdPartnerStatusCode  APartnerStatus, TDBTransaction  ATransaction  )

inlinestatic

Retrieves the Partner ShortName, the PartnerClass and PartnerStatus.

Parameters

APartnerKey	PartnerKey to identify the Partner.
APartnerShortName	Returns the ShortName.
APartnerClass	Returns the PartnerClass (FAMILY, ORGANISATION, etc).
APartnerStatus	Returns the PartnerStatus (eg. ACTIVE, DIED).
ATransaction	Open DB Transaction.

Returns

True if partner was found, otherwise false.

---

The documentation for this class was generated from the following file:

• csharp/ICT/Petra/Server/lib/MCommon/Main.cs