Ict.Petra.Server.MFinance.AP.UIConnectors.TFindUIConnector Class Reference

This UIConnector provides data for the finance Accounts Payable screens More...

Public Member Functions
	TFindUIConnector ()
	default constructor More...
void	FindSupplier (DataTable ACriteriaData)
	Find a supplier or a list of suppliers matching the search criteria More...
void	FindInvoices (DataTable ACriteriaData)
	Find a list of invoices matching the search criteria More...
void	FindSupplierTransactions (Int32 ALedgerNumber, Int64 ASupplierKey)
void	PerformSearch (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...

Static Public Member Functions
static Decimal	GetPartPaidAmount (Int32 ApDocumentId)
	Find out how much has already been paid off this invoice. (Also called from EditTransaction.) More...

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

Detailed Description

This UIConnector provides data for the finance Accounts Payable screens

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. /summary>

Constructor & Destructor Documentation

TFindUIConnector()

Ict.Petra.Server.MFinance.AP.UIConnectors.TFindUIConnector.TFindUIConnector ( )

inline

default constructor

Member Function Documentation

FindInvoices()

void Ict.Petra.Server.MFinance.AP.UIConnectors.TFindUIConnector.FindInvoices ( DataTable  ACriteriaData )

inline

Find a list of invoices matching the search criteria

Parameters

ACriteriaData

Optional HashTable containing "DaysPlus" for "due by" calculation

FindSupplier()

void Ict.Petra.Server.MFinance.AP.UIConnectors.TFindUIConnector.FindSupplier ( DataTable  ACriteriaData )

inline

Find a supplier or a list of suppliers matching the search criteria

Parameters

ACriteriaData

HashTable containing non-empty Find parameters

FindSupplierTransactions()

void Ict.Petra.Server.MFinance.AP.UIConnectors.TFindUIConnector.FindSupplierTransactions ( Int32  ALedgerNumber, Int64  ASupplierKey  )

inline

Parameters

ALedgerNumber
ASupplierKey

GetDataPagedResult()

DataTable Ict.Petra.Server.MFinance.AP.UIConnectors.TFindUIConnector.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

GetPartPaidAmount()

static Decimal Ict.Petra.Server.MFinance.AP.UIConnectors.TFindUIConnector.GetPartPaidAmount ( Int32  ApDocumentId )

inlinestatic

Find out how much has already been paid off this invoice. (Also called from EditTransaction.)

Parameters

ApDocumentId

Returns

Amount already paid

PerformSearch()

void Ict.Petra.Server.MFinance.AP.UIConnectors.TFindUIConnector.PerformSearch ( 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.

Parameters

ACriteriaData

HashTable containing non-empty Find parameters.

Property Documentation

Progress

TProgressState Ict.Petra.Server.MFinance.AP.UIConnectors.TFindUIConnector.Progress

get

Get the current state of progress

---

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

• csharp/ICT/Petra/Server/lib/MFinance/AP/AP.Find.cs