OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner Class Reference

Contains functions for the validation of MPartner Partner DataTables. More...

Static Public Member Functions

static void ValidatePartnerBankManual (object AContext, PBankRow ARow, ref TVerificationResultCollection AVerificationResultCollection)
 Validates the Partner Detail data of a Partner of PartnerClass BANK. More...
 
static void ValidatePartnerPersonManual (object AContext, PPersonRow ARow, TGetCacheableDataTableFromCache ACacheRetriever, ref TVerificationResultCollection AVerificationResultCollection)
 Validates the Partner Detail data of a Partner of PartnerClass PERSON. More...
 
static void ValidatePartnerFamilyManual (object AContext, PFamilyRow ARow, ref TVerificationResultCollection AVerificationResultCollection)
 Validates the Partner Detail data of a Partner of PartnerClass FAMILY. More...
 
static void ValidatePartnerChurchManual (object AContext, PChurchRow ARow, DataTable ADenominationCacheableDT, ref TVerificationResultCollection AVerificationResultCollection)
 Validates the Partner Detail data of a Partner of PartnerClass CHURCH. More...
 
static void ValidatePartnerManual (object AContext, PPartnerRow ARow, ref TVerificationResultCollection AVerificationResultCollection)
 Validates the Partner data of a Partner. More...
 
static void ValidateSubscriptionManual (object AContext, PSubscriptionRow ARow, ref TVerificationResultCollection AVerificationResultCollection)
 Validates the Subscription data of a Partner. More...
 
static void ValidateRelationshipManual (object AContext, PPartnerRelationshipRow ARow, ref TVerificationResultCollection AVerificationResultCollection, bool AValidateForNewPartner=false, Int64 APartnerKey=0)
 Validates the Relationship data of a Partner. More...
 
static TVerificationResult IsValidPartner (Int64 APartnerKey, TPartnerClass[] AValidPartnerClasses, Boolean AMustBeActive=false, bool AZeroPartnerKeyIsValid=false, string AErrorMessageText="", object AResultContext=null, System.Data.DataColumn AResultColumn=null)
 Checks whether a Partner with a certain PartnerKey and a range of valid PartnerClasses exists. More...
 
static TVerificationResult IsValidPartnerLinks (Int32 ALedgerNumber, Int64 APartnerKey, string AErrorMessageText="", object AResultContext=null, System.Data.DataColumn AResultColumn=null)
 Checks whether a Partner with a certain PartnerKey and a range of valid PartnerClasses exists. More...
 
static TVerificationResult IsValidRecipientGiftDestination (Int64 APartnerKey, DateTime? AGiftDate, string AErrorMessageText="", object AResultContext=null, System.Data.DataColumn AResultColumn=null)
 Checks whether a Partner with a certain PartnerKey and a range of valid PartnerClasses exists. More...
 
static TVerificationResult IsValidRecipientFieldForMotivationGroup (Int64 APartnerKey, Int64 APartnerField, string AMotivationGroup, string AErrorMessageText="", object AResultContext=null, System.Data.DataColumn AResultColumn=null)
 Checks whether a Partner with Field 0 has a non-gift Motivation Group code. More...
 
static TVerificationResult IsValidUNITPartner (Int64 APartnerKey, bool AZeroPartnerKeyIsValid=false, string AErrorMessageText="", object AResultContext=null, System.Data.DataColumn AResultColumn=null)
 Checks that a Partner with a certain PartnerKey exists and is a Partner of PartnerClass UNIT. More...
 
static void ValidateMailingSetup (object AContext, PMailingRow ARow, ref TVerificationResultCollection AVerificationResultCollection)
 Validates the MPartner Mailing Setup screen data. More...
 
static void ValidateAddressBlockSetup (object AContext, PAddressBlockRow ARow, ref TVerificationResultCollection AVerificationResultCollection, PAddressBlockElementTable AAddressElementTable)
 Validates the MPartner Address Layout Setup screen data. More...
 
static void ValidateFormalitySetup (object AContext, PFormalityRow ARow, ref TVerificationResultCollection AVerificationResultCollection)
 Validates the MPartner Formality Setup screen data. More...
 
static void ValidateRelationshipSetupManual (object AContext, PRelationRow ARow, ref TVerificationResultCollection AVerificationResultCollection)
 Validates the MPartner Relationship Setup screen data. More...
 
static void ValidateBankingDetails (object AContext, PBankingDetailsRow ARow, PBankingDetailsTable ABankingDetails, string ACountryCode, ref TVerificationResultCollection AVerificationResultCollection)
 Validates the Banking Details screen data. More...
 
static void ValidateBankingDetailsExtra (object AContext, PBankingDetailsRow ARow, ref TVerificationResultCollection AVerificationResultCollection)
 Extra Validatation for the Banking Details screen data. More...
 
static void ValidatePartnerInterestManual (object AContext, PPartnerInterestRow ARow, ref TVerificationResultCollection AVerificationResultCollection, string AInterestCategory)
 Validates the Partner Interest screen data. More...
 
static void ValidateGiftDestinationRowManual (object AContext, PPartnerGiftDestinationRow ARow, ref TVerificationResultCollection AVerificationResultCollection)
 Validates a Gift Destination record More...
 
static void ValidateGiftDestinationManual (object AContext, PPartnerGiftDestinationTable ATable, ref TVerificationResultCollection AVerificationResultCollection)
 Validates whole Gift Destination data of a Partner. More...
 
static void ValidateContactDetailsManual (object AContext, PPartnerAttributeRow ARow, ref TVerificationResultCollection AVerificationResultCollection, TPartnerAttributeTypeValueKind AValueKind)
 Validates the Partner Edit screens' Contact Details Tab data. More...
 
static void ValidateInterestSetupManual (object AContext, PInterestRow ARow, ref TVerificationResultCollection AVerificationResultCollection)
 Validates the Partner Interest Setup screen data. More...
 
static void ValidateContactTypesSetupManual (object AContext, PPartnerAttributeTypeRow ARow, ref TVerificationResultCollection AVerificationResultCollection)
 Validates the Partner Contact Types Setup usercontrol data. More...
 
static void ValidateContactLogManual (object AContext, PContactLogRow ARow, ref TVerificationResultCollection VerificationResultCollection)
 

Detailed Description

Contains functions for the validation of MPartner Partner DataTables.

Member Function Documentation

◆ IsValidPartner()

static TVerificationResult Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.IsValidPartner ( Int64  APartnerKey,
TPartnerClass[]  AValidPartnerClasses,
Boolean  AMustBeActive = false,
bool  AZeroPartnerKeyIsValid = false,
string  AErrorMessageText = "",
object  AResultContext = null,
System.Data.DataColumn  AResultColumn = null 
)
inlinestatic

Checks whether a Partner with a certain PartnerKey and a range of valid PartnerClasses exists.

Parameters
APartnerKeyPartnerKey.
AValidPartnerClassesAn array of PartnerClasses. If the Partner exists, but its PartnerClass isn't in the array, a TVerificationResult is still returned.
AMustBeActiveThe Partner status.must be labelled with PartnerIsActive (Default: false)
AZeroPartnerKeyIsValidSet to true if APartnerKey 0 should be considered as valid (Default: false)
AErrorMessageTextText that should be prepended to the ResultText. (Default: empty string)
AResultContextResultContext (Default: null).
AResultColumnWhich System.Data.DataColumn failed (can be null). (Default: null).
Returns
Null if the Partner exists and its PartnerClass is in the AValidPartnerClasses array. If the Partner exists, but its PartnerClass isn't in the array, a TVerificationResult with details about the error is returned. This is also the case if the Partner doesn't exist at all or got merged into another Partner, or if APartnerKey is 0 and AZeroPartnerKeyIsValid is false.

◆ IsValidPartnerLinks()

static TVerificationResult Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.IsValidPartnerLinks ( Int32  ALedgerNumber,
Int64  APartnerKey,
string  AErrorMessageText = "",
object  AResultContext = null,
System.Data.DataColumn  AResultColumn = null 
)
inlinestatic

Checks whether a Partner with a certain PartnerKey and a range of valid PartnerClasses exists.

Parameters
ALedgerNumberLedgerNumber.
APartnerKeyPartnerKey.
AErrorMessageTextText that should be prepended to the ResultText. (Default: empty string)
AResultContextResultContext (Default: null).
AResultColumnWhich System.Data.DataColumn failed (can be null). (Default: null).
Returns
Not Null if the Partner is of type CC and does not have a link setup

◆ IsValidRecipientFieldForMotivationGroup()

static TVerificationResult Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.IsValidRecipientFieldForMotivationGroup ( Int64  APartnerKey,
Int64  APartnerField,
string  AMotivationGroup,
string  AErrorMessageText = "",
object  AResultContext = null,
System.Data.DataColumn  AResultColumn = null 
)
inlinestatic

Checks whether a Partner with Field 0 has a non-gift Motivation Group code.

Parameters
APartnerKeyPartnerKey.
APartnerFieldThe field associated with the partner key
AMotivationGroupThe current motivation group
AErrorMessageTextText that should be prepended to the ResultText. (Default: empty string)
AResultContextResultContext (Default: null).
AResultColumnWhich System.Data.DataColumn failed (can be null). (Default: null).
Returns
Null if the Partner Field is non-zero or Motivation Group code is not Gift. If the Partner Field is zero and Motivation Group is Gift, a TVerificationResult with details about the error is returned.

◆ IsValidRecipientGiftDestination()

static TVerificationResult Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.IsValidRecipientGiftDestination ( Int64  APartnerKey,
DateTime?  AGiftDate,
string  AErrorMessageText = "",
object  AResultContext = null,
System.Data.DataColumn  AResultColumn = null 
)
inlinestatic

Checks whether a Partner with a certain PartnerKey and a range of valid PartnerClasses exists.

Parameters
APartnerKeyPartnerKey.
AGiftDateLedgerNumber.
AErrorMessageTextText that should be prepended to the ResultText. (Default: empty string)
AResultContextResultContext (Default: null).
AResultColumnWhich System.Data.DataColumn failed (can be null). (Default: null).
Returns
Not Null if the Partner is of type CC and does not have a link setup

◆ IsValidUNITPartner()

static TVerificationResult Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.IsValidUNITPartner ( Int64  APartnerKey,
bool  AZeroPartnerKeyIsValid = false,
string  AErrorMessageText = "",
object  AResultContext = null,
System.Data.DataColumn  AResultColumn = null 
)
inlinestatic

Checks that a Partner with a certain PartnerKey exists and is a Partner of PartnerClass UNIT.

Parameters
APartnerKeyPartnerKey.
AZeroPartnerKeyIsValidSet to true if APartnerKey 0 should be considered as valid (Default: false)
AErrorMessageTextText that should be prepended to the ResultText. (Default: empty string)
AResultContextResultContext (optional).
AResultColumnWhich System.Data.DataColumn failed (can be null). (Default: null).
Returns
Null if the Partner exists and its PartnerClass is UNIT. If the Partner exists, but its PartnerClass isn't UNIT, a TVerificationResult with details about the error is returned. This is also the case if the Partner doesn't exist at all or got merged into another Partner, or if APartnerKey is 0 and AZeroPartnerKeyIsValid is false.

◆ ValidateAddressBlockSetup()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidateAddressBlockSetup ( object  AContext,
PAddressBlockRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection,
PAddressBlockElementTable  AAddressElementTable 
)
inlinestatic

Validates the MPartner Address Layout Setup screen data.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.
AAddressElementTableA table of all available Address Block Elements

◆ ValidateBankingDetails()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidateBankingDetails ( object  AContext,
PBankingDetailsRow  ARow,
PBankingDetailsTable  ABankingDetails,
string  ACountryCode,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates the Banking Details screen data.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
ABankingDetailstest if there is only one main account
ACountryCodeCountry Code for ARow's corresponding Bank's country
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.

◆ ValidateBankingDetailsExtra()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidateBankingDetailsExtra ( object  AContext,
PBankingDetailsRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Extra Validatation for the Banking Details screen data.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.

◆ ValidateContactDetailsManual()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidateContactDetailsManual ( object  AContext,
PPartnerAttributeRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection,
TPartnerAttributeTypeValueKind  AValueKind 
)
inlinestatic

Validates the Partner Edit screens' Contact Details Tab data.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.
AValueKindThe PPartnerAttributeType.AttributeValueKind of the DataRow passed in in ARow .

◆ ValidateContactLogManual()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidateContactLogManual ( object  AContext,
PContactLogRow  ARow,
ref TVerificationResultCollection  VerificationResultCollection 
)
inlinestatic

Parameters
AContext
ARow
VerificationResultCollection

◆ ValidateContactTypesSetupManual()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidateContactTypesSetupManual ( object  AContext,
PPartnerAttributeTypeRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates the Partner Contact Types Setup usercontrol data.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.

◆ ValidateFormalitySetup()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidateFormalitySetup ( object  AContext,
PFormalityRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates the MPartner Formality Setup screen data.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.

◆ ValidateGiftDestinationManual()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidateGiftDestinationManual ( object  AContext,
PPartnerGiftDestinationTable  ATable,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates whole Gift Destination data of a Partner.

Parameters
AContextContext that describes where the data validation failed.
ATableThe DataTable which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.
Returns
void

◆ ValidateGiftDestinationRowManual()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidateGiftDestinationRowManual ( object  AContext,
PPartnerGiftDestinationRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates a Gift Destination record

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.
Returns
void

◆ ValidateInterestSetupManual()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidateInterestSetupManual ( object  AContext,
PInterestRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates the Partner Interest Setup screen data.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.

◆ ValidateMailingSetup()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidateMailingSetup ( object  AContext,
PMailingRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates the MPartner Mailing Setup screen data.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.

◆ ValidatePartnerBankManual()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidatePartnerBankManual ( object  AContext,
PBankRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates the Partner Detail data of a Partner of PartnerClass BANK.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.
Returns
void

◆ ValidatePartnerChurchManual()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidatePartnerChurchManual ( object  AContext,
PChurchRow  ARow,
DataTable  ADenominationCacheableDT,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates the Partner Detail data of a Partner of PartnerClass CHURCH.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
ADenominationCacheableDTThe contents of the Cacheable DataTable 'DenominationList'.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.
Returns
void

◆ ValidatePartnerFamilyManual()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidatePartnerFamilyManual ( object  AContext,
PFamilyRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates the Partner Detail data of a Partner of PartnerClass FAMILY.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.
Returns
void

◆ ValidatePartnerInterestManual()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidatePartnerInterestManual ( object  AContext,
PPartnerInterestRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection,
string  AInterestCategory 
)
inlinestatic

Validates the Partner Interest screen data.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.
AInterestCategoryThe chosen interest category.

◆ ValidatePartnerManual()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidatePartnerManual ( object  AContext,
PPartnerRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates the Partner data of a Partner.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.
Returns
void

◆ ValidatePartnerPersonManual()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidatePartnerPersonManual ( object  AContext,
PPersonRow  ARow,
TGetCacheableDataTableFromCache  ACacheRetriever,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates the Partner Detail data of a Partner of PartnerClass PERSON.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
ACacheRetrieverDelegate that returns the specified DataTable from the data cache (client- or serverside). Delegate Method needs to be for the MPartner Cache (that is, it needs to work with the TCacheablePartnerTablesEnum Enum!
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.
Returns
void

◆ ValidateRelationshipManual()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidateRelationshipManual ( object  AContext,
PPartnerRelationshipRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection,
bool  AValidateForNewPartner = false,
Int64  APartnerKey = 0 
)
inlinestatic

Validates the Relationship data of a Partner.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.
AValidateForNewPartnertrue if validation is run for a new partner record
APartnerKeymain partner key this validation is run for
Returns
void

◆ ValidateRelationshipSetupManual()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidateRelationshipSetupManual ( object  AContext,
PRelationRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates the MPartner Relationship Setup screen data.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.
Returns
void

◆ ValidateSubscriptionManual()

static void Ict.Petra.Server.MPartner.Validation.TPartnerValidation_Partner.ValidateSubscriptionManual ( object  AContext,
PSubscriptionRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates the Subscription data of a Partner.

Parameters
AContextContext that describes where the data validation failed.
ARowThe DataRow which holds the the data against which the validation is run.
AVerificationResultCollectionWill be filled with any TVerificationResult items if data validation errors occur.
Returns
void

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