OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Server.MPartner.Common.Calculations.TOverallContactSettings Class Reference

Holds the 'Overall Contact Settings' of an arbitrary number of Partners. More...

Inheritance diagram for Ict.Petra.Server.MPartner.Common.Calculations.TOverallContactSettings:

Public Member Functions

 TOverallContactSettings ()
 Constructor. Simply calls the base Constructor. More...
 
string GetPartnersPrimaryEmailAddress (Int64 APartnerKey)
 Convenient Method for getting the 'Primary E-Mail Address' of a Partner. More...
 
string GetPartnersPrimaryPhoneNumber (Int64 APartnerKey)
 Convenient Method for getting the 'Primary Phone Number' of a Partner. More...
 
string GetPartnersOvrlContAttribute (Int64 APartnerKey, TOverallContSettingKind AOverallContSettingKind)
 Gets the value of a Partners' 'Overall Contact Setting'. More...
 

Detailed Description

Holds the 'Overall Contact Settings' of an arbitrary number of Partners.

Use the public Method GetPartnersPrimaryEmailAddress to get the 'Primary E-Mail Address' of a specific Partner!

Constructor & Destructor Documentation

◆ TOverallContactSettings()

Ict.Petra.Server.MPartner.Common.Calculations.TOverallContactSettings.TOverallContactSettings ( )
inline

Constructor. Simply calls the base Constructor.

Member Function Documentation

◆ GetPartnersOvrlContAttribute()

string Ict.Petra.Server.MPartner.Common.Calculations.TOverallContactSettings.GetPartnersOvrlContAttribute ( Int64  APartnerKey,
TOverallContSettingKind  AOverallContSettingKind 
)
inline

Gets the value of a Partners' 'Overall Contact Setting'.

Other Methods that start with the name 'GetPartners...' exist that return a specific 'Overall Contact Setting' without the need of specifying AOverallContSettingKind .

Parameters
APartnerKeyPartnerKey of a Partner.
AOverallContSettingKindThe Partners' 'Overall Contact Setting' that the value should be retrieved for.
Returns
The value of the Partners' 'Overall Contact Setting' specified with AOverallContSettingKind of the Partner with PartnerKey APartnerKey , or null in case the Partner hasn't got a a value set for the specified Partners' 'Overall Contact Setting'. null is also returned if the Partner doesn't exist in this instance of TOverallContactSettings.

◆ GetPartnersPrimaryEmailAddress()

string Ict.Petra.Server.MPartner.Common.Calculations.TOverallContactSettings.GetPartnersPrimaryEmailAddress ( Int64  APartnerKey)
inline

Convenient Method for getting the 'Primary E-Mail Address' of a Partner.

Parameters
APartnerKeyPartnerKey of a Partner.
Returns
The 'Primary E-Mail Address' of the Partner with PartnerKey APartnerKey , or null in case the Partner hasn't got a Primary Email Address set. null is also returned if the Partner doesn't exist in this instance of TOverallContactSettings.

◆ GetPartnersPrimaryPhoneNumber()

string Ict.Petra.Server.MPartner.Common.Calculations.TOverallContactSettings.GetPartnersPrimaryPhoneNumber ( Int64  APartnerKey)
inline

Convenient Method for getting the 'Primary Phone Number' of a Partner.

Parameters
APartnerKeyPartnerKey of a Partner.
Returns
The 'Primary Phone Number' of the Partner with PartnerKey APartnerKey , or null in case the Partner hasn't got a Primary Phone Number set. null is also returned if the Partner doesn't exist in this instance of TOverallContactSettings.

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