OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Server.MFinance.Validation.TFinanceValidation_Gift Class Reference

Contains functions for the validation of MFinance Gift DataTables. More...

Static Public Member Functions

static bool ValidateGiftBatchManual (object AContext, AGiftBatchRow ARow, ref TVerificationResultCollection AVerificationResultCollection, AAccountTable AAccountTableRef=null, ACostCentreTable ACostCentreTableRef=null, AAccountPropertyTable AAccountPropertyTableRef=null, AAccountingPeriodTable AAccountingPeriodTableRef=null, ACorporateExchangeRateTable ACorporateExchangeTableRef=null, ACurrencyTable ACurrencyTableRef=null, string ABaseCurrency=null, string AInternationalCurrency=null, bool AValidateAccountCostCentre=false)
 Validates the Gift Batch data. More...
 
static bool ValidateGiftDetailManual (object AContext, GiftBatchTDSAGiftDetailRow ARow, ref TVerificationResultCollection AVerificationResultCollection, bool? ASetupForILT=null, ACostCentreTable ACostCentres=null, AAccountTable AAccounts=null, AMotivationGroupTable AMotivationGroups=null, AMotivationDetailTable AMotivationDetails=null, PMailingTable AMailingTable=null, Int64 ARecipientField=-1, bool ARecipientZeroIsValid=true)
 Validates the Gift Detail data. More...
 
static bool ValidateTaxDeductiblePct (object AContext, GiftBatchTDSAGiftDetailRow ARow, ref TVerificationResultCollection AVerificationResultCollection)
 Validates the Gift Detail data. More...
 
static bool ValidateGiftManual (object AContext, AGiftRow ARow, Int32 AYear, Int32 APeriod, ref TVerificationResultCollection AVerificationResultCollection, AMethodOfGivingTable AMethodOfGivingRef=null, AMethodOfPaymentTable AMethodOfPaymentRef=null, PFormTable AFormLetterCodeTbl=null, bool ADonorZeroIsValid=false)
 Validation for Gift table More...
 
static bool ValidateRecurringGiftBatchManual (object AContext, ARecurringGiftBatchRow ARow, ref TVerificationResultCollection AVerificationResultCollection)
 Validates the Recurring Gift Batch data. More...
 
static bool ValidateRecurringGiftManual (object AContext, ARecurringGiftRow ARow, ref TVerificationResultCollection AVerificationResultCollection, bool ADonorZeroIsValid=false)
 Validation for Recurring Gift table More...
 
static bool ValidateRecurringGiftDetailManual (object AContext, GiftBatchTDSARecurringGiftDetailRow ARow, ref TVerificationResultCollection AVerificationResultCollection, Int64 ARecipientField=-1, bool ARecipientZeroIsValid=true)
 Validates the Recurring Gift Detail data. More...
 
static void ValidateGiftMotivationSetupManual (object AContext, AMotivationDetailRow ARow, bool ATaxDeductiblePercentageEnabled, ref TVerificationResultCollection AVerificationResultCollection)
 Validates the Gift Motivation Setup. More...
 

Detailed Description

Contains functions for the validation of MFinance Gift DataTables.

Member Function Documentation

◆ ValidateGiftBatchManual()

static bool Ict.Petra.Server.MFinance.Validation.TFinanceValidation_Gift.ValidateGiftBatchManual ( object  AContext,
AGiftBatchRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection,
AAccountTable  AAccountTableRef = null,
ACostCentreTable  ACostCentreTableRef = null,
AAccountPropertyTable  AAccountPropertyTableRef = null,
AAccountingPeriodTable  AAccountingPeriodTableRef = null,
ACorporateExchangeRateTable  ACorporateExchangeTableRef = null,
ACurrencyTable  ACurrencyTableRef = null,
string  ABaseCurrency = null,
string  AInternationalCurrency = null,
bool  AValidateAccountCostCentre = false 
)
inlinestatic

Validates the Gift Batch 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.
AAccountTableRefAccount Table. A reference to this table is REQUIRED when importing - optional otherwise
ACostCentreTableRefCost centre table. A reference to this table is REQUIRED when importing - optional otherwise
AAccountPropertyTableRefAccount Property Table. A reference to this table is REQUIRED when importing - optional otherwise
AAccountingPeriodTableRefAccounting Period Table. A reference to this table is REQUIRED when importing - optional otherwise
ACorporateExchangeTableRefCorporate exchange rate table. A reference to this table is REQUIRED when importing - optional otherwise
ACurrencyTableRefCurrency table. A reference to this table is REQUIRED when importing - optional otherwise
ABaseCurrencyLedger base currency. Required when importing
AInternationalCurrencyLedger international currency. Required when importing
AValidateAccountCostCentreDetermines whether or not to
Returns
True if the validation found no data validation errors, otherwise false.

◆ ValidateGiftDetailManual()

static bool Ict.Petra.Server.MFinance.Validation.TFinanceValidation_Gift.ValidateGiftDetailManual ( object  AContext,
GiftBatchTDSAGiftDetailRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection,
bool?  ASetupForILT = null,
ACostCentreTable  ACostCentres = null,
AAccountTable  AAccounts = null,
AMotivationGroupTable  AMotivationGroups = null,
AMotivationDetailTable  AMotivationDetails = null,
PMailingTable  AMailingTable = null,
Int64  ARecipientField = -1,
bool  ARecipientZeroIsValid = true 
)
inlinestatic

Validates the Gift Detail 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.
ASetupForILTOptional - Is the recipient set up for inter-ledger transfers.
ACostCentresOptional - a CostCentres table. Is required for import validation.
AAccountsOptional - a Accounts table. Is required for import validation.
AMotivationGroupsOptional - a MotivationGroups table. Is required for import validation.
AMotivationDetailsOptional - a MotivationDetails table. Is required for import validation.
AMailingTableOptional - a Mailing table. Is required for import validation.
ARecipientFieldOptional The recipient field for the gift. Is required for import validation.
ARecipientZeroIsValidOptional Wether or not the Recipient can be zero.
Returns
True if the validation found no data validation errors, otherwise false.

◆ ValidateGiftManual()

static bool Ict.Petra.Server.MFinance.Validation.TFinanceValidation_Gift.ValidateGiftManual ( object  AContext,
AGiftRow  ARow,
Int32  AYear,
Int32  APeriod,
ref TVerificationResultCollection  AVerificationResultCollection,
AMethodOfGivingTable  AMethodOfGivingRef = null,
AMethodOfPaymentTable  AMethodOfPaymentRef = null,
PFormTable  AFormLetterCodeTbl = null,
bool  ADonorZeroIsValid = false 
)
inlinestatic

Validation for Gift table

Parameters
AContext
ARow
AYear
APeriod
AVerificationResultCollection
AMethodOfGivingRefRequired for import validation
AMethodOfPaymentRefRequired for
AFormLetterCodeTblSupplied in import validation
ADonorZeroIsValidWhether or not donor zero is valid
Returns

◆ ValidateGiftMotivationSetupManual()

static void Ict.Petra.Server.MFinance.Validation.TFinanceValidation_Gift.ValidateGiftMotivationSetupManual ( object  AContext,
AMotivationDetailRow  ARow,
bool  ATaxDeductiblePercentageEnabled,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates the Gift Motivation Setup.

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

◆ ValidateRecurringGiftBatchManual()

static bool Ict.Petra.Server.MFinance.Validation.TFinanceValidation_Gift.ValidateRecurringGiftBatchManual ( object  AContext,
ARecurringGiftBatchRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates the Recurring Gift Batch 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
True if the validation found no data validation errors, otherwise false.

◆ ValidateRecurringGiftDetailManual()

static bool Ict.Petra.Server.MFinance.Validation.TFinanceValidation_Gift.ValidateRecurringGiftDetailManual ( object  AContext,
GiftBatchTDSARecurringGiftDetailRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection,
Int64  ARecipientField = -1,
bool  ARecipientZeroIsValid = true 
)
inlinestatic

Validates the Recurring Gift Detail 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.
ARecipientFieldOptional
ARecipientZeroIsValidOptional
Returns
True if the validation found no data validation errors, otherwise false.

◆ ValidateRecurringGiftManual()

static bool Ict.Petra.Server.MFinance.Validation.TFinanceValidation_Gift.ValidateRecurringGiftManual ( object  AContext,
ARecurringGiftRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection,
bool  ADonorZeroIsValid = false 
)
inlinestatic

Validation for Recurring Gift table

Parameters
AContext
ARow
AVerificationResultCollection
ADonorZeroIsValid
Returns

◆ ValidateTaxDeductiblePct()

static bool Ict.Petra.Server.MFinance.Validation.TFinanceValidation_Gift.ValidateTaxDeductiblePct ( object  AContext,
GiftBatchTDSAGiftDetailRow  ARow,
ref TVerificationResultCollection  AVerificationResultCollection 
)
inlinestatic

Validates the Gift Detail 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
True if the validation found no data validation errors, otherwise false.

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