Ict.Petra.Server.MPartner.Common.TAddressTools Class Reference

useful functions for the address of a partner /summary> More...

Static Public Member Functions
static bool	GetBestAddressOnlySendMail (Int64 APartnerKey, out PLocationTable AAddress, out string ACountryNameLocal, TDBTransaction ATransaction)
	find the current best address for the partner, only return address with sendmail set. More...
static bool	GetBestAddress (Int64 APartnerKey, out PLocationTable AAddress, out string ACountryNameLocal, TDBTransaction ATransaction, bool AOnlySendMail=false)
	find the current best address for the partner More...
static DataTable	GetBestAddressForPartners (DataTable Partners, int PartnerKeyColumn, TDBTransaction ATransaction, Boolean APartnerDetails=false)
	Given a DataColumn of Partner Keys, return a table with the best address for each partner More...
static DataTable	GetBestAddressForPartners (String DonorList, TDBTransaction ATransaction, Boolean APartnerDetails=false, Boolean ASanitizeFieldNames=false)
	Given a string list of Partner Keys, return a table with the best address for each partner More...
static DataTable	GetBestAddressForPartnersAsJoinedTable (DataTable Partners, int PartnerKeyColumn, TDBTransaction ATransaction, Boolean APartnerDetails=false)
	Returns the Table handed in with the best addresses More...
static void	AddBestAddressForPartner (ref DataTable APartners, int APartnerKeyColumn, TDBTransaction ATransaction, Boolean APartnerDetails=false, Boolean ABuildAddressBlock=false)
	Adds The best address to a table of partners More...
static string	GetCountryCodeFromSiteLedger (TDBTransaction ATransaction)
	Return the country code for this installation of OpenPetra. using the SiteKey to determine the country More...
static string	GetCountryName (string CountryCode, TDBTransaction ATransaction)
	Get the printable name for this country More...

Detailed Description

useful functions for the address of a partner /summary>

Member Function Documentation

AddBestAddressForPartner()

static void Ict.Petra.Server.MPartner.Common.TAddressTools.AddBestAddressForPartner ( ref DataTable  APartners, int  APartnerKeyColumn, TDBTransaction  ATransaction, Boolean  APartnerDetails = false, Boolean  ABuildAddressBlock = false  )

inlinestatic

Adds The best address to a table of partners

Parameters

APartners
APartnerKeyColumn
ATransaction
APartnerDetails
ABuildAddressBlock

GetBestAddress()

static bool Ict.Petra.Server.MPartner.Common.TAddressTools.GetBestAddress ( Int64  APartnerKey, out PLocationTable  AAddress, out string  ACountryNameLocal, TDBTransaction  ATransaction, bool  AOnlySendMail = false  )

inlinestatic

find the current best address for the partner

GetBestAddressForPartners() [1/2]

static DataTable Ict.Petra.Server.MPartner.Common.TAddressTools.GetBestAddressForPartners ( DataTable  Partners, int  PartnerKeyColumn, TDBTransaction  ATransaction, Boolean  APartnerDetails = false  )

inlinestatic

Given a DataColumn of Partner Keys, return a table with the best address for each partner

Parameters

Partners	DataTable containing a column of partner keys
PartnerKeyColumn	Column number in Partners that contains the keys
ATransaction	The current database transaction
APartnerDetails	if true: Adds partner short name and partner class columns

Returns

GetBestAddressForPartners() [2/2]

static DataTable Ict.Petra.Server.MPartner.Common.TAddressTools.GetBestAddressForPartners ( String  DonorList, TDBTransaction  ATransaction, Boolean  APartnerDetails = false, Boolean  ASanitizeFieldNames = false  )

inlinestatic

Given a string list of Partner Keys, return a table with the best address for each partner

Parameters

DonorList	Comma-separated list of partner keys, or SQL query returning partner keys only
ATransaction	The current database transaction
APartnerDetails	if true: Adds partner short name and partner class columns
ASanitizeFieldNames	If true, fieldnames are tweaked for reporting

Returns

GetBestAddressForPartnersAsJoinedTable()

static DataTable Ict.Petra.Server.MPartner.Common.TAddressTools.GetBestAddressForPartnersAsJoinedTable ( DataTable  Partners, int  PartnerKeyColumn, TDBTransaction  ATransaction, Boolean  APartnerDetails = false  )

inlinestatic

Returns the Table handed in with the best addresses

Parameters

Partners
PartnerKeyColumn
ATransaction
APartnerDetails

Returns

GetBestAddressOnlySendMail()

static bool Ict.Petra.Server.MPartner.Common.TAddressTools.GetBestAddressOnlySendMail ( Int64  APartnerKey, out PLocationTable  AAddress, out string  ACountryNameLocal, TDBTransaction  ATransaction  )

inlinestatic

find the current best address for the partner, only return address with sendmail set.

GetCountryCodeFromSiteLedger()

static string Ict.Petra.Server.MPartner.Common.TAddressTools.GetCountryCodeFromSiteLedger ( TDBTransaction  ATransaction )

inlinestatic

Return the country code for this installation of OpenPetra. using the SiteKey to determine the country

GetCountryName()

static string Ict.Petra.Server.MPartner.Common.TAddressTools.GetCountryName ( string  CountryCode, TDBTransaction  ATransaction  )

inlinestatic

Get the printable name for this country

Parameters

CountryCode
ATransaction

Returns

---

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

• csharp/ICT/Petra/Server/lib/MPartner/Common/AddressTools.cs