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

general methods for use in partner module More...

Static Public Member Functions

static bool AddRecentlyUsedPartner (Int64 APartnerKey, TPartnerClass APartnerClass, Boolean ANewPartner, TLastPartnerUse ALastPartnerUse)
 adds partner to list of recently used partners for given use scenario More...
 
static TLocationPK DetermineBestAddress (Int64 APartnerKey)
 return the location key and site key for the best address for that partner More...
 
static bool ChangeFamily (Int64 APersonKey, Int64 AOldFamilyKey, Int64 ANewFamilyKey, out String AProblemMessage)
 performs database changes to move person from current (old) family to new family record More...
 
static Int64 GetBankBySortCode (string ABranchCode)
 get the correct bank partner, according to the sortcode/branchcode. if it does not exist yet, create a new bank partner with empty location More...
 
static bool CanPartnerBeDeleted (Int64 APartnerKey, out String ADisplayMessage, TDataBase ADataBase=null)
 check if partner is allowed to be deleted More...
 
static bool GetPartnerStatisticsForDeletion (Int64 APartnerKey, out String APartnerShortName, out String ADisplayMessage)
 collect information to be displayed so user can confirm if this partner record should be deleted More...
 
static bool DeletePartner (Int64 APartnerKey, out TVerificationResultCollection AVerificationResult, TDataBase ADataBase=null)
 delete partner record and related database entries More...
 
static bool CancelExpiredSubscriptions ()
 Cancel all subscriptions that have a past expiry date and that are not cancelled yet More...
 
static PPartnerRelationshipTable GetPartnerRelationships (Int64 APartnerRelationKey)
 Gets a data table containing the relationships associated with the specified partner key More...
 

Detailed Description

general methods for use in partner module

Member Function Documentation

◆ AddRecentlyUsedPartner()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TPartnerWebConnector.AddRecentlyUsedPartner ( Int64  APartnerKey,
TPartnerClass  APartnerClass,
Boolean  ANewPartner,
TLastPartnerUse  ALastPartnerUse 
)
inlinestatic

adds partner to list of recently used partners for given use scenario

Parameters
APartnerKey
APartnerClass
ANewPartner
ALastPartnerUse
Returns
true if action was successful

◆ CancelExpiredSubscriptions()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TPartnerWebConnector.CancelExpiredSubscriptions ( )
inlinestatic

Cancel all subscriptions that have a past expiry date and that are not cancelled yet

Returns
true if cancellation was successful

◆ CanPartnerBeDeleted()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TPartnerWebConnector.CanPartnerBeDeleted ( Int64  APartnerKey,
out String  ADisplayMessage,
TDataBase  ADataBase = null 
)
inlinestatic

check if partner is allowed to be deleted

Parameters
APartnerKey
ADisplayMessage
ADataBase
Returns
true if partner can be deleted

◆ ChangeFamily()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TPartnerWebConnector.ChangeFamily ( Int64  APersonKey,
Int64  AOldFamilyKey,
Int64  ANewFamilyKey,
out String  AProblemMessage 
)
inlinestatic

performs database changes to move person from current (old) family to new family record

Parameters
APersonKey
AOldFamilyKey
ANewFamilyKey
AProblemMessage
Returns
true if change of family completed successfully

◆ DeletePartner()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TPartnerWebConnector.DeletePartner ( Int64  APartnerKey,
out TVerificationResultCollection  AVerificationResult,
TDataBase  ADataBase = null 
)
inlinestatic

delete partner record and related database entries

Parameters
APartnerKey
AVerificationResult
ADataBase
Returns
true if deletion was successful

◆ DetermineBestAddress()

static TLocationPK Ict.Petra.Server.MPartner.Partner.WebConnectors.TPartnerWebConnector.DetermineBestAddress ( Int64  APartnerKey)
inlinestatic

return the location key and site key for the best address for that partner

◆ GetBankBySortCode()

static Int64 Ict.Petra.Server.MPartner.Partner.WebConnectors.TPartnerWebConnector.GetBankBySortCode ( string  ABranchCode)
inlinestatic

get the correct bank partner, according to the sortcode/branchcode. if it does not exist yet, create a new bank partner with empty location

◆ GetPartnerRelationships()

static PPartnerRelationshipTable Ict.Petra.Server.MPartner.Partner.WebConnectors.TPartnerWebConnector.GetPartnerRelationships ( Int64  APartnerRelationKey)
inlinestatic

Gets a data table containing the relationships associated with the specified partner key

Parameters
APartnerRelationKeyThe specific relation key in the PPartnerRelationshipTable
Returns
A data table

◆ GetPartnerStatisticsForDeletion()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TPartnerWebConnector.GetPartnerStatisticsForDeletion ( Int64  APartnerKey,
out String  APartnerShortName,
out String  ADisplayMessage 
)
inlinestatic

collect information to be displayed so user can confirm if this partner record should be deleted

Parameters
APartnerKey
APartnerShortName
ADisplayMessage
Returns
true if partner was found

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