Contains helper functions for the shared validation of Partner data. More...

Public Member Functions
delegate bool	TVerifyPartner (Int64 APartnerKey, TPartnerClass[] AValidPartnerClasses, out bool APartnerExists, out String APartnerShortName, out TPartnerClass APartnerClass, out TStdPartnerStatusCode APartnerStatus)
	Delegate for invoking the verification of the existence of a Partner. More...

delegate Boolean	TPartnerHasActiveStatus (Int64 APartner)
	Delegate for confirming that a Partner is active. More...

delegate Boolean	TPartnerIsLinkedToCC (Int64 APartnerKey)
	Delegate to determine Partner is linked to CC More...

delegate Boolean	TPartnerOfTypeCCIsLinked (Int32 ALedgerNumber, Int64 APartnerKey)
	Delegate to determine Partner of type CC is linked More...

delegate Boolean	TPartnerHasCurrentGiftDestination (Int64 APartnerKey, DateTime ? AGiftDate)
	Delegate to determine Partner has a valid gift destination More...

Static Public Member Functions
static bool	VerifyPartner (Int64 APartnerKey, TPartnerClass[] AValidPartnerClasses, out bool APartnerExists, out String APartnerShortName, out TPartnerClass APartnerClass, out TStdPartnerStatusCode APartnerStatus)
	Verifies the existence of a Partner. More...

static Boolean	PartnerHasActiveStatus (Int64 APartnerKey)

static Boolean	PartnerIsLinkedToCC (Int64 APartnerKey)
	Attempts to call a delegate... More...

static Boolean	PartnerOfTypeCCIsLinked (Int32 ALedgerNumber, Int64 APartnerKey)
	Attempts to call a delegate... More...

static Boolean	PartnerHasCurrentGiftDestination (Int64 APartnerKey, DateTime ? AGiftDate)
	Attempts to call a delegate... More...

Properties
static TVerifyPartner	VerifyPartnerDelegate `[get, set]`
	This property is used to provide a function which invokes the verification of the existence of a Partner. More...

static TPartnerHasActiveStatus	PartnerHasActiveStatusDelegate `[get, set]`

static TPartnerIsLinkedToCC	PartnerIsLinkedToCCDelegate `[get, set]`
	A function must be provided before the helper function is called. More...

static TPartnerOfTypeCCIsLinked	PartnerOfTypeCCIsLinkedDelegate `[get, set]`
	A function must be provided before the helper function is called. More...

static TPartnerHasCurrentGiftDestination	PartnerHasCurrentGiftDestinationDelegate `[get, set]`
	A function must be provided before the helper function is called. More...

Detailed Description

Contains helper functions for the shared validation of Partner data.

Member Function Documentation

◆ PartnerHasActiveStatus()

static Boolean Ict.Petra.Server.MPartner.Validation.TPartnerValidationHelper.PartnerHasActiveStatus ( Int64 APartnerKey )

inlinestatic

Parameters

APartnerKey

Returns: True if the status of this partner is listed as Active (Bypasses the status enum.)

◆ PartnerHasCurrentGiftDestination()

static Boolean Ict.Petra.Server.MPartner.Validation.TPartnerValidationHelper.PartnerHasCurrentGiftDestination	(	Int64	APartnerKey,
		DateTime ?	AGiftDate
	)

inlinestatic

Attempts to call a delegate...

Parameters

APartnerKey
AGiftDate

Returns

◆ PartnerIsLinkedToCC()

static Boolean Ict.Petra.Server.MPartner.Validation.TPartnerValidationHelper.PartnerIsLinkedToCC ( Int64 APartnerKey )

inlinestatic

Attempts to call a delegate...

Parameters

APartnerKey

Returns

◆ PartnerOfTypeCCIsLinked()

static Boolean Ict.Petra.Server.MPartner.Validation.TPartnerValidationHelper.PartnerOfTypeCCIsLinked	(	Int32	ALedgerNumber,
		Int64	APartnerKey
	)

inlinestatic

Attempts to call a delegate...

Parameters

ALedgerNumber
APartnerKey

Returns

◆ TPartnerHasActiveStatus()

delegate Boolean Ict.Petra.Server.MPartner.Validation.TPartnerValidationHelper.TPartnerHasActiveStatus ( Int64 APartner )

Delegate for confirming that a Partner is active.

◆ TPartnerHasCurrentGiftDestination()

delegate Boolean Ict.Petra.Server.MPartner.Validation.TPartnerValidationHelper.TPartnerHasCurrentGiftDestination	(	Int64	APartnerKey,
		DateTime ?	AGiftDate
	)

Delegate to determine Partner has a valid gift destination

Parameters

APartnerKey
AGiftDate

Returns

◆ TPartnerIsLinkedToCC()

delegate Boolean Ict.Petra.Server.MPartner.Validation.TPartnerValidationHelper.TPartnerIsLinkedToCC ( Int64 APartnerKey )

Delegate to determine Partner is linked to CC

Parameters

APartnerKey

Returns

◆ TPartnerOfTypeCCIsLinked()

delegate Boolean Ict.Petra.Server.MPartner.Validation.TPartnerValidationHelper.TPartnerOfTypeCCIsLinked	(	Int32	ALedgerNumber,
		Int64	APartnerKey
	)

Delegate to determine Partner of type CC is linked

Parameters

ALedgerNumber
APartnerKey

Returns

◆ TVerifyPartner()

delegate bool Ict.Petra.Server.MPartner.Validation.TPartnerValidationHelper.TVerifyPartner	(	Int64	APartnerKey,
		TPartnerClass[]	AValidPartnerClasses,
		out bool	APartnerExists,
		out String	APartnerShortName,
		out TPartnerClass	APartnerClass,
		out TStdPartnerStatusCode	APartnerStatus
	)

Delegate for invoking the verification of the existence of a Partner.

◆ VerifyPartner()

static bool Ict.Petra.Server.MPartner.Validation.TPartnerValidationHelper.VerifyPartner	(	Int64	APartnerKey,
		TPartnerClass[]	AValidPartnerClasses,
		out bool	APartnerExists,
		out String	APartnerShortName,
		out TPartnerClass	APartnerClass,
		out TStdPartnerStatusCode	APartnerStatus
	)

inlinestatic

Verifies the existence of a Partner.

Parameters

APartnerKey	PartnerKey of Partner to find the short name for
AValidPartnerClasses	Pass in a Set of valid PartnerClasses that the Partner is allowed to have (eg. [PERSON, FAMILY], or an empty Set ( [] ).
APartnerExists	True if the Partner exists in the database or if PartnerKey is 0.
APartnerShortName	ShortName for the found Partner ('' if Partner doesn't exist or PartnerKey is 0)
APartnerClass	Partner Class of the found Partner (FAMILY if Partner doesn't exist or PartnerKey is 0)
APartnerStatus	Partner Status

Returns: true if Partner was found in DB (except if AValidPartnerClasses isn't an empty Set and the found Partner isn't of a PartnerClass that is in the Set) or PartnerKey is 0, otherwise false

Property Documentation

◆ PartnerHasActiveStatusDelegate

TPartnerHasActiveStatus Ict.Petra.Server.MPartner.Validation.TPartnerValidationHelper.PartnerHasActiveStatusDelegate

staticgetset

◆ PartnerHasCurrentGiftDestinationDelegate

TPartnerHasCurrentGiftDestination Ict.Petra.Server.MPartner.Validation.TPartnerValidationHelper.PartnerHasCurrentGiftDestinationDelegate

staticgetset

A function must be provided before the helper function is called.

◆ PartnerIsLinkedToCCDelegate

TPartnerIsLinkedToCC Ict.Petra.Server.MPartner.Validation.TPartnerValidationHelper.PartnerIsLinkedToCCDelegate

staticgetset

A function must be provided before the helper function is called.

◆ PartnerOfTypeCCIsLinkedDelegate

TPartnerOfTypeCCIsLinked Ict.Petra.Server.MPartner.Validation.TPartnerValidationHelper.PartnerOfTypeCCIsLinkedDelegate

staticgetset

A function must be provided before the helper function is called.

◆ VerifyPartnerDelegate

TVerifyPartner Ict.Petra.Server.MPartner.Validation.TPartnerValidationHelper.VerifyPartnerDelegate

staticgetset

This property is used to provide a function which invokes the verification of the existence of a Partner.

The Delegate is set up at the start of the application.

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

csharp/ICT/Petra/Server/lib/MPartner/validation/Helper.cs

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ PartnerHasActiveStatus()

◆ PartnerHasCurrentGiftDestination()

◆ PartnerIsLinkedToCC()

◆ PartnerOfTypeCCIsLinked()

◆ TPartnerHasActiveStatus()

◆ TPartnerHasCurrentGiftDestination()

◆ TPartnerIsLinkedToCC()

◆ TPartnerOfTypeCCIsLinked()

◆ TVerifyPartner()

◆ VerifyPartner()

Property Documentation

◆ PartnerHasActiveStatusDelegate

◆ PartnerHasCurrentGiftDestinationDelegate

◆ PartnerIsLinkedToCCDelegate

◆ PartnerOfTypeCCIsLinkedDelegate

◆ VerifyPartnerDelegate