OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector Class Reference

functions for creating new partners and to edit partners More...

Static Public Member Functions

static Int64 NewPartnerKey (Int64 AFieldPartnerKey=-1)
 get a partner key for a new partner More...
 
static PartnerEditTDS CreateNewPartner (string APartnerClass, out List< string > ASubscriptions, out List< string > APartnerTypes, out string ADefaultEmailAddress, out string ADefaultPhoneMobile, out string ADefaultPhoneLandline)
 return the dataset for a new partner More...
 
static PartnerEditTDS GetPartnerDetailsSelfService (out List< string > ASubscriptions, out List< string > APartnerTypes, out string ADefaultEmailAddress, out string ADefaultPhoneMobile, out string ADefaultPhoneLandline)
 return the existing data of my own partner record for self service More...
 
static PartnerEditTDS GetPartnerDetails (Int64 APartnerKey, out List< string > ASubscriptions, out List< string > APartnerTypes, out string ADefaultEmailAddress, out string ADefaultPhoneMobile, out string ADefaultPhoneLandline, bool AWithDonationHistory)
 return the existing data of a partner More...
 
static PartnerEditTDS GetPartnerDetails (Int64 APartnerKey, bool AWithSubscriptions, bool AWithRelationships, out string APrimaryPhoneNumber, out string APrimaryEmailAddress)
 Return the existing data of a partner, including address information and primary phone and email More...
 
static void ImportPartner (PartnerEditTDS AMainDS)
 store the imported partner More...
 
static bool SavePartnerSelfService (PartnerEditTDS AMainDS, List< string > ASubscriptions, List< string > APartnerTypes, bool ASendMail, string ADefaultEmailAddress, string ADefaultPhoneMobile, string ADefaultPhoneLandline, out TVerificationResultCollection AVerificationResult)
 return the existing data of my own partner record for self service More...
 
static bool SavePartner (PartnerEditTDS AMainDS, List< string > ASubscriptions, List< string > APartnerTypes, List< string > AChanges, bool ASendMail, string ADefaultEmailAddress, string ADefaultPhoneMobile, string ADefaultPhoneLandline, out TVerificationResultCollection AVerificationResult)
 store the currently edited partner More...
 
static bool DeletePartner (Int64 APartnerKey, out TVerificationResultCollection AVerificationResult)
 delete the partner More...
 
static bool DeleteAllPartners (out TVerificationResultCollection AVerificationResult)
 delete all FAMILY and ORGANISATION partners. useful for initial import of contacts, trial and error. More...
 
static bool ValidateIBAN (string AIban, out string ABic, out string ABankName, out TVerificationResultCollection AVerificationResult)
 this will use an external web service to check the IBAN, and get the BIC and the name of the bank More...
 
static Int64 FindOrCreateBank (string ABIC, string ABankName)
 Find or create a partner for the bank with the given BIC. More...
 
static bool GetBankAccounts (Int64 APartnerKey, out PartnerEditTDSPBankingDetailsTable PBankingDetails)
 this will return the bank accounts of the partner More...
 
static bool MaintainBankAccounts (string action, Int32 ABankingDetailsKey, Int64 APartnerKey, string AAccountName, string AIban, out TVerificationResultCollection AVerificationResult)
 this will create, save and delete a bank account More...
 
static bool GetMemberships (Int64 APartnerKey, out PPartnerMembershipTable PMemberships)
 this will return the memberships of the partner More...
 
static bool MaintainMemberships (string action, Int32 APartnerMembershipKey, Int64 APartnerKey, string AMembershipCode, DateTime AStartDate, DateTime? AExpiryDate, out TVerificationResultCollection AVerificationResult)
 this will create, save and delete a membership of a partner More...
 

Detailed Description

functions for creating new partners and to edit partners

Member Function Documentation

◆ CreateNewPartner()

static PartnerEditTDS Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.CreateNewPartner ( string  APartnerClass,
out List< string >  ASubscriptions,
out List< string >  APartnerTypes,
out string  ADefaultEmailAddress,
out string  ADefaultPhoneMobile,
out string  ADefaultPhoneLandline 
)
inlinestatic

return the dataset for a new partner

Returns

◆ DeleteAllPartners()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.DeleteAllPartners ( out TVerificationResultCollection  AVerificationResult)
inlinestatic

delete all FAMILY and ORGANISATION partners. useful for initial import of contacts, trial and error.

Returns

◆ DeletePartner()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.DeletePartner ( Int64  APartnerKey,
out TVerificationResultCollection  AVerificationResult 
)
inlinestatic

delete the partner

Returns

◆ FindOrCreateBank()

static Int64 Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.FindOrCreateBank ( string  ABIC,
string  ABankName 
)
inlinestatic

Find or create a partner for the bank with the given BIC.

◆ GetBankAccounts()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.GetBankAccounts ( Int64  APartnerKey,
out PartnerEditTDSPBankingDetailsTable  PBankingDetails 
)
inlinestatic

this will return the bank accounts of the partner

◆ GetMemberships()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.GetMemberships ( Int64  APartnerKey,
out PPartnerMembershipTable  PMemberships 
)
inlinestatic

this will return the memberships of the partner

◆ GetPartnerDetails() [1/2]

static PartnerEditTDS Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.GetPartnerDetails ( Int64  APartnerKey,
bool  AWithSubscriptions,
bool  AWithRelationships,
out string  APrimaryPhoneNumber,
out string  APrimaryEmailAddress 
)
inlinestatic

Return the existing data of a partner, including address information and primary phone and email

Parameters
APartnerKeyThe partner
AWithSubscriptionsOption to return subscriptions information
AWithRelationshipsOption to return relationships information
APrimaryPhoneNumberReturns the primary phone
APrimaryEmailAddressReturns the primary email
Returns
A PartnerEdit data set

◆ GetPartnerDetails() [2/2]

static PartnerEditTDS Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.GetPartnerDetails ( Int64  APartnerKey,
out List< string >  ASubscriptions,
out List< string >  APartnerTypes,
out string  ADefaultEmailAddress,
out string  ADefaultPhoneMobile,
out string  ADefaultPhoneLandline,
bool  AWithDonationHistory 
)
inlinestatic

return the existing data of a partner

Returns

◆ GetPartnerDetailsSelfService()

static PartnerEditTDS Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.GetPartnerDetailsSelfService ( out List< string >  ASubscriptions,
out List< string >  APartnerTypes,
out string  ADefaultEmailAddress,
out string  ADefaultPhoneMobile,
out string  ADefaultPhoneLandline 
)
inlinestatic

return the existing data of my own partner record for self service

Returns

◆ ImportPartner()

static void Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.ImportPartner ( PartnerEditTDS  AMainDS)
inlinestatic

store the imported partner

Returns

◆ MaintainBankAccounts()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.MaintainBankAccounts ( string  action,
Int32  ABankingDetailsKey,
Int64  APartnerKey,
string  AAccountName,
string  AIban,
out TVerificationResultCollection  AVerificationResult 
)
inlinestatic

this will create, save and delete a bank account

◆ MaintainMemberships()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.MaintainMemberships ( string  action,
Int32  APartnerMembershipKey,
Int64  APartnerKey,
string  AMembershipCode,
DateTime  AStartDate,
DateTime?  AExpiryDate,
out TVerificationResultCollection  AVerificationResult 
)
inlinestatic

this will create, save and delete a membership of a partner

◆ NewPartnerKey()

static Int64 Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.NewPartnerKey ( Int64  AFieldPartnerKey = -1)
inlinestatic

get a partner key for a new partner

Parameters
AFieldPartnerKeycan be -1, then the default site key is used

◆ SavePartner()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.SavePartner ( PartnerEditTDS  AMainDS,
List< string >  ASubscriptions,
List< string >  APartnerTypes,
List< string >  AChanges,
bool  ASendMail,
string  ADefaultEmailAddress,
string  ADefaultPhoneMobile,
string  ADefaultPhoneLandline,
out TVerificationResultCollection  AVerificationResult 
)
inlinestatic

store the currently edited partner

Returns

◆ SavePartnerSelfService()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.SavePartnerSelfService ( PartnerEditTDS  AMainDS,
List< string >  ASubscriptions,
List< string >  APartnerTypes,
bool  ASendMail,
string  ADefaultEmailAddress,
string  ADefaultPhoneMobile,
string  ADefaultPhoneLandline,
out TVerificationResultCollection  AVerificationResult 
)
inlinestatic

return the existing data of my own partner record for self service

Returns

◆ ValidateIBAN()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TSimplePartnerEditWebConnector.ValidateIBAN ( string  AIban,
out string  ABic,
out string  ABankName,
out TVerificationResultCollection  AVerificationResult 
)
inlinestatic

this will use an external web service to check the IBAN, and get the BIC and the name of the bank


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