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

Partner Find Screen UIConnector More...

Public Member Functions
	TPartnerFindUIConnector ()
	constructor More...
void	PerformSearch (DataTable ACriteriaData, bool ADetailedResults)
	Procedure to execute a Find query. Although the full query results are retrieved from the DB and stored internally in an object, data will be returned in 'pages' of data, each page holding a defined number of records. More...
void	PerformSearchByBankDetails (DataTable ACriteriaData)
	Procedure to execute a Find query. Although the full query results are retrieved from the DB and stored internally in an object, data will be returned in 'pages' of data, each page holding a defined number of records. More...
DataTable	GetDataPagedResult (System.Int16 APage, System.Int16 APageSize, out System.Int32 ATotalRecords, out System.Int16 ATotalPages)
	Returns the specified find results page. More...
Int16	GetPageNumberContainingPartnerKey (Int64 APartnerKey, System.Int16 AStartPage, System.Int16 APageSize)
	Gets the page number containing given partner key. More...
Int32	AddAllFoundPartnersToExtract (string AExtractName, string AExtractDescription, int AExtractID, out TVerificationResultCollection AVerificationResult)
	Adds all Partners that were last found to an Extract. More...
DataTable	FilterResultByBestAddress ()
	modify search result: filter each result partner for best address only More...
bool	CheckIfResultsContainPartnerKey (long APartnerKey)
	Checks if a search result contains a given partner More...

Properties
TProgressState	Progress [get]
	Get the current state of progress More...

Detailed Description

Partner Find Screen UIConnector

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

TPartnerFindUIConnector()

Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerFindUIConnector.TPartnerFindUIConnector ( )

inline

constructor

Member Function Documentation

AddAllFoundPartnersToExtract()

Int32 Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerFindUIConnector.AddAllFoundPartnersToExtract ( string  AExtractName, string  AExtractDescription, int  AExtractID, out TVerificationResultCollection  AVerificationResult  )

inline

Adds all Partners that were last found to an Extract.

Parameters

AExtractName	Name of the Extract to add the Partners to.
AExtractDescription	Description of the Extract to add the Partners to.
AExtractID	ExtractID of the Extract to add the Partners to.
AVerificationResult	Contains DB call exceptions, if there are any.

Returns

The number of Partners that were added to the Extract, or -1 if DB call exeptions occured.

CheckIfResultsContainPartnerKey()

bool Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerFindUIConnector.CheckIfResultsContainPartnerKey ( long  APartnerKey )

inline

Checks if a search result contains a given partner

Parameters

APartnerKey

Partner key of partner

Returns

True if partner is included, false if not.

FilterResultByBestAddress()

DataTable Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerFindUIConnector.FilterResultByBestAddress ( )

inline

modify search result: filter each result partner for best address only

Returns

DataTable with filtered result

GetDataPagedResult()

DataTable Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerFindUIConnector.GetDataPagedResult ( System.Int16  APage, System.Int16  APageSize, out System.Int32  ATotalRecords, out System.Int16  ATotalPages  )

inline

Returns the specified find results page.

@comment Pages can be requested in any order!

Parameters

APage	Page to return
APageSize	Number of records to return per page
ATotalRecords	The amount of rows found by the SELECT statement
ATotalPages	The number of pages that will be needed on client-side to hold all rows found by the SELECT statement

Returns

DataTable containing the find result records for the specified page

GetPageNumberContainingPartnerKey()

Int16 Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerFindUIConnector.GetPageNumberContainingPartnerKey ( Int64  APartnerKey, System.Int16  AStartPage, System.Int16  APageSize  )

inline

Gets the page number containing given partner key.

Parameters

APartnerKey	Partner key to search for
AStartPage	Page to start searching
APageSize	Size of a page.

Returns

PerformSearch()

void Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerFindUIConnector.PerformSearch ( DataTable  ACriteriaData, bool  ADetailedResults  )

inline

Procedure to execute a Find query. Although the full query results are retrieved from the DB and stored internally in an object, data will be returned in 'pages' of data, each page holding a defined number of records.

Parameters

ACriteriaData	HashTable containing non-empty Partner Find parameters
ADetailedResults	Returns more (when true) or less (when false) columns

PerformSearchByBankDetails()

void Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerFindUIConnector.PerformSearchByBankDetails ( DataTable  ACriteriaData )

inline

Procedure to execute a Find query. Although the full query results are retrieved from the DB and stored internally in an object, data will be returned in 'pages' of data, each page holding a defined number of records.

Property Documentation

Progress

TProgressState Ict.Petra.Server.MPartner.Partner.UIConnectors.TPartnerFindUIConnector.Progress

get

Get the current state of progress

---

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

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