Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector Class Reference

Partner Edit Screen UIConnector working with a Typed DataSet More...

Public Member Functions
	TPartnerEditUIConnector (System.Int64 APartnerKey, TDataBase ADataBase=null)
	Constructor which automatically loads data for the Partner. More...
	TPartnerEditUIConnector (Int64 APartnerKey, Int64 ASiteKey, Int32 ALocationKey, TDataBase ADataBase=null)
	Constructor which automatically loads data for the Partner. More...
	TPartnerEditUIConnector (TDataBase ADataBase=null)
	Constructor for creating a new Partner. More...
PartnerEditTDS	GetBankingDetails ()
	get the banking details of the current partner More...
bool	IsTaxDeductiblePercentageEnabled ()
	gets system default TaxDeductOnRecipient (default false) More...
bool	IsGovIdEnabled ()
	gets system default GovIdEnabled (default false) More...
PartnerEditTDS	GetData (Boolean ADelayedDataLoading, TPartnerEditTabPageEnum ATabPage)
	Passes data as a Typed DataSet to the Partner Edit Screen, containing multiple DataTables. More...
PartnerEditTDS	GetData (Boolean ADelayedDataLoading)
	overload More...
PartnerEditTDS	GetData ()
	overload More...
PartnerEditTDS	GetDataAddresses ()
	todoComment More...
PartnerEditTDS	GetDataFoundation (Boolean ABaseTableOnly)
	todoComment More...
PartnerEditTDSPPartnerInterestTable	GetDataPartnerInterests ()
	todoComment More...
PInterestTable	GetDataInterests ()
	todoComment More...
PLocationTable	GetDataLocation (Int64 ASiteKey, Int32 ALocationKey)
	todoComment More...
PartnerEditTDS	GetDataNewPartner (System.Int64 ASiteKey, System.Int64 APartnerKey, TPartnerClass APartnerClass, String ADesiredCountryCode, String AAcquisitionCode, Boolean APrivatePartner, Int64 AFamilyPartnerKey, Int64 AFamilySiteKey, Int32 AFamilyLocationKey, out String ASiteCountryCode)
	Passes data as a Typed DataSet to the Partner Edit Screen, containing multiple DataTables. The DataSets tables are with default data for a new Partner. More...
IndividualDataTDS	GetDataPersonnelIndividualData (TIndividualDataItemEnum AIndividualDataItem)
	todoComment More...
PPartnerTypeTable	GetDataPartnerTypes ()
	todoComment More...
PSubscriptionTable	GetDataSubscriptions ()
	todoComment More...
PContactLogTable	GetDataContacts ()
	todoComment More...
PartnerEditTDSPPartnerRelationshipTable	GetDataPartnerRelationships ()
	todoComment More...
PartnerEditTDSPPartnerLocationTable	GetDataPartnerLocations (ref PLocationTable ALocations)
	todoComment More...
PDataLabelValuePartnerTable	GetDataLocalPartnerDataValues ()
	todoComment More...
PartnerEditTDSFamilyMembersTable	GetDataFamilyMembers (Int64 AFamilyPartnerKey, String AWorkWithSpecialType)
	todoComment More...
TSubmitChangesResult	SubmitChanges (ref PartnerEditTDS AInspectDS, ref DataSet AResponseDS, out TVerificationResultCollection AVerificationResult)
	Saves data from the Partner Edit Screen (contained in a Typed DataSet). More...
TSubmitChangesResult	SubmitChangesContinue (out PartnerEditTDS AInspectDS, ref DataSet AResponseDS, out TVerificationResultCollection AVerificationResult)
	todoComment More...
Int64	GetPartnerKeyForNewPartner (System.Int64 AFieldPartnerKey)
Boolean	GetPartnerShortName (Int64 APartnerKey, out String APartnerShortName, out TPartnerClass APartnerClass)
	Get short name for a partner. More...
Boolean	HasPartnerCostCentreLink (out String ACostCentreCode)
	todoComment More...
Boolean	HasPartnerCostCentreLink (System.Int64 APartnerKey, out String ACostCentreCode)
	todoComment More...
Boolean	HasPartnerLocationOtherPartnerReferences (Int64 ASiteKey, Int32 ALocationKey)
	todoComment More...
bool	SubmitPartnerKeyForNewPartner (System.Int64 AFieldPartnerKey, System.Int64 AOriginalDefaultKey, ref System.Int64 ANewPartnerKey)
	todoComment More...
PPartnerGiftDestinationTable	GetCurrentAndFutureGiftDestinationData (long AFamilyKey)
	Get valid current and future Gift Destination records More...

Detailed Description

Partner Edit Screen UIConnector working with a Typed DataSet

UIConnector Objects are instantiated by the Client's User Interface via the Instantiator classes. They handle requests for data retrieval and saving of data (including data verification).

Their role is to

• retrieve (and possibly aggregate) data using Business Objects,
• put this data into///one* DataSet that is passed to the Client and make sure that no unnessary data is transferred to the Client,
• optionally provide functionality to retrieve additional, different data if requested by the Client (for Client screens that load data initially as well as later, eg. when a certain tab on the screen is clicked),
• save data using Business Objects.

@Comment These Objects would usually not be instantiated by other Server Objects, but only by the Client UI via the Instantiator classes. However, Server Objects that derive from these objects and that are also UIConnectors are feasible.

Constructor & Destructor Documentation

TPartnerEditUIConnector() [1/3]

Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.TPartnerEditUIConnector ( System.Int64  APartnerKey, TDataBase  ADataBase = null  )

inline

Constructor which automatically loads data for the Partner.

Parameters

APartnerKey	PartnerKey for the Partner to instantiate this object with
ADataBase

Returns

void

TPartnerEditUIConnector() [2/3]

Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.TPartnerEditUIConnector ( Int64  APartnerKey, Int64  ASiteKey, Int32  ALocationKey, TDataBase  ADataBase = null  )

inline

Constructor which automatically loads data for the Partner.

@Comment Use this overload to specify which Address should be selected when the Partner Edit screen is shown.

Parameters

APartnerKey	PartnerKey for the Partner to instantiate this object with
ASiteKey	SiteKey of the PartnerLocation record of the Partner
ALocationKey	LocationKey of the PartnerLocation record of the Partner
ADataBase

Returns

void

TPartnerEditUIConnector() [3/3]

Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.TPartnerEditUIConnector ( TDataBase  ADataBase = null )

inline

Constructor for creating a new Partner.

Returns

void

Member Function Documentation

GetBankingDetails()

PartnerEditTDS Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetBankingDetails ( )

inline

get the banking details of the current partner

GetCurrentAndFutureGiftDestinationData()

PPartnerGiftDestinationTable Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetCurrentAndFutureGiftDestinationData ( long  AFamilyKey )

inline

Get valid current and future Gift Destination records

Parameters

AFamilyKey

Returns

GetData() [1/3]

PartnerEditTDS Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetData ( )

inline

overload

Returns

GetData() [2/3]

PartnerEditTDS Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetData ( Boolean  ADelayedDataLoading )

inline

overload

Parameters

ADelayedDataLoading

Returns

GetData() [3/3]

PartnerEditTDS Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetData ( Boolean  ADelayedDataLoading, TPartnerEditTabPageEnum  ATabPage  )

inline

Passes data as a Typed DataSet to the Partner Edit Screen, containing multiple DataTables.

Parameters

ADelayedDataLoading	Tells whether Delayed Data Loading is activated on the Client side, or not
ATabPage	Tab Page the Client wants to display initially.

Returns

void

GetDataAddresses()

PartnerEditTDS Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetDataAddresses ( )

inline

todoComment

Returns

GetDataContacts()

PContactLogTable Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetDataContacts ( )

inline

todoComment

Returns

GetDataFamilyMembers()

PartnerEditTDSFamilyMembersTable Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetDataFamilyMembers ( Int64  AFamilyPartnerKey, String  AWorkWithSpecialType  )

inline

todoComment

Parameters

AFamilyPartnerKey
AWorkWithSpecialType

Returns

GetDataFoundation()

PartnerEditTDS Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetDataFoundation ( Boolean  ABaseTableOnly )

inline

todoComment

Parameters

ABaseTableOnly

Returns

GetDataInterests()

PInterestTable Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetDataInterests ( )

inline

todoComment

Returns

GetDataLocalPartnerDataValues()

PDataLabelValuePartnerTable Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetDataLocalPartnerDataValues ( )

inline

todoComment

Returns

GetDataLocation()

PLocationTable Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetDataLocation ( Int64  ASiteKey, Int32  ALocationKey  )

inline

todoComment

Parameters

ASiteKey
ALocationKey

Returns

GetDataNewPartner()

PartnerEditTDS Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetDataNewPartner ( System.Int64  ASiteKey, System.Int64  APartnerKey, TPartnerClass  APartnerClass, String  ADesiredCountryCode, String  AAcquisitionCode, Boolean  APrivatePartner, Int64  AFamilyPartnerKey, Int64  AFamilySiteKey, Int32  AFamilyLocationKey, out String  ASiteCountryCode  )

inline

Passes data as a Typed DataSet to the Partner Edit Screen, containing multiple DataTables. The DataSets tables are with default data for a new Partner.

Parameters

ASiteKey	SiteKey for which the Partner should be created (optional)
APartnerKey	PartnerKey that the Partner should have (optional)
APartnerClass	PartnerClass that the Partner should have (optional)
ADesiredCountryCode	Country Code that the Partner's first address should have (if <> '', this overrides the Country Code that would be found out from the Site Key)
AAcquisitionCode	AcquisitionCode that the Partner should have (optional)
APrivatePartner	Set to true if this should become a Private Partner of the current user
AFamilyPartnerKey	PartnerKey of the Family (only needed if new Partner is of Partner Class PERSON)
AFamilySiteKey
AFamilyLocationKey	LocationKey of the selected Location of the Family (only needed if new Partner is of Partner Class PERSON)
ASiteCountryCode

Returns

void

GetDataPartnerInterests()

PartnerEditTDSPPartnerInterestTable Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetDataPartnerInterests ( )

inline

todoComment

Returns

GetDataPartnerLocations()

PartnerEditTDSPPartnerLocationTable Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetDataPartnerLocations ( ref PLocationTable  ALocations )

inline

todoComment

Returns

GetDataPartnerRelationships()

PartnerEditTDSPPartnerRelationshipTable Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetDataPartnerRelationships ( )

inline

todoComment

Returns

GetDataPartnerTypes()

PPartnerTypeTable Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetDataPartnerTypes ( )

inline

todoComment

Returns

GetDataPersonnelIndividualData()

IndividualDataTDS Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetDataPersonnelIndividualData ( TIndividualDataItemEnum  AIndividualDataItem )

inline

todoComment

Returns

GetDataSubscriptions()

PSubscriptionTable Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetDataSubscriptions ( )

inline

todoComment

Returns

GetPartnerKeyForNewPartner()

Int64 Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetPartnerKeyForNewPartner ( System.Int64  AFieldPartnerKey )

inline

Parameters

AFieldPartnerKey

Returns

GetPartnerShortName()

Boolean Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.GetPartnerShortName ( Int64  APartnerKey, out String  APartnerShortName, out TPartnerClass  APartnerClass  )

inline

Get short name for a partner.

@Comment Calling this function should soon be no longer necessary since it can be replaced with a call to Ict.Petra.Client.App.Core.ServerLookups!

Parameters

APartnerKey	PartnerKey to find the short name for
APartnerShortName	short name found for partner key
APartnerClass	Partner Class for partner that was found

Returns

true if Partner was found in DB, otherwise false

HasPartnerCostCentreLink() [1/2]

Boolean Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.HasPartnerCostCentreLink ( out String  ACostCentreCode )

inline

todoComment

Parameters

ACostCentreCode

Returns

HasPartnerCostCentreLink() [2/2]

Boolean Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.HasPartnerCostCentreLink ( System.Int64  APartnerKey, out String  ACostCentreCode  )

inline

todoComment

Parameters

APartnerKey
ACostCentreCode

Returns

HasPartnerLocationOtherPartnerReferences()

Boolean Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.HasPartnerLocationOtherPartnerReferences ( Int64  ASiteKey, Int32  ALocationKey  )

inline

todoComment

Parameters

ASiteKey
ALocationKey

Returns

IsGovIdEnabled()

bool Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.IsGovIdEnabled ( )

inline

gets system default GovIdEnabled (default false)

Returns

IsTaxDeductiblePercentageEnabled()

bool Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.IsTaxDeductiblePercentageEnabled ( )

inline

gets system default TaxDeductOnRecipient (default false)

Returns

SubmitChanges()

TSubmitChangesResult Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.SubmitChanges ( ref PartnerEditTDS  AInspectDS, ref DataSet  AResponseDS, out TVerificationResultCollection  AVerificationResult  )

inline

Saves data from the Partner Edit Screen (contained in a Typed DataSet).

All DataTables contained in the Typed DataSet are inspected for added, changed or deleted rows by submitting them to the DataStore.

Parameters

AInspectDS	Typed DataSet that needs to contain known DataTables
AResponseDS	DataSet containing data to be used on the Client side (eg. for displaying Address Change dialogs with data in it)
AVerificationResult	Nil if all verifications are OK and all DB calls succeded, otherwise filled with 1..n TVerificationResult objects (can also contain DB call exceptions)

Returns

true if all verifications are OK and all DB calls succeeded, false if any verification or DB call failed

SubmitChangesContinue()

TSubmitChangesResult Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.SubmitChangesContinue ( out PartnerEditTDS  AInspectDS, ref DataSet  AResponseDS, out TVerificationResultCollection  AVerificationResult  )

inline

todoComment

Parameters

AInspectDS
AResponseDS
AVerificationResult

Returns

SubmitPartnerKeyForNewPartner()

bool Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerEditUIConnector.SubmitPartnerKeyForNewPartner ( System.Int64  AFieldPartnerKey, System.Int64  AOriginalDefaultKey, ref System.Int64  ANewPartnerKey  )

inline

todoComment

Parameters

AFieldPartnerKey
AOriginalDefaultKey
ANewPartnerKey

Returns

---

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

• csharp/ICT/Petra/Server/lib/MPartner/connect/Partner.PartnerEdit.cs
• csharp/ICT/Petra/Server/lib/MPartner/connect/Partner.PartnerEdit.Validation.cs