Ict.Petra.Server.MCommon.UIConnectors.TOfficeSpecificDataLabelsUIConnector Class Reference

Office Specific Data Labels Screen UIConnector More...

Public Member Functions
	TOfficeSpecificDataLabelsUIConnector (Int64 APartnerKey, TOfficeSpecificDataLabelUseEnum AOfficeSpecificDataLabelUse)
	Constructor. More...
Int32	CountLabelUse (String ALabelUse, TDBTransaction AReadTransaction)
	Returns the number of Labels available for a certain LabelUse. More...
	TOfficeSpecificDataLabelsUIConnector (Int64 APartnerKey, Int32 AApplicationKey, Int64 ARegistrationOffice, TOfficeSpecificDataLabelUseEnum AOfficeSpecificDataLabelUse)
	Constructor. More...
OfficeSpecificDataLabelsTDS	GetData ()
	Passes data as a Typed DataSet to the Screen, containing multiple DataTables. More...
TSubmitChangesResult	PrepareChangesServerSide (DataTable AInspectDT, TDBTransaction AReadTransaction)
	Saves data from the Office Specific Data Label Edit Screen (contained in a DataTable). More...
Boolean	GetPartnerShortName (Int64 APartnerKey, out String APartnerShortName, out TPartnerClass APartnerClass)
	Get short name for a partner. Boolean returns result if partner was found. More...
PDataLabelValuePartnerTable	GetDataLocalPartnerDataValues (Int64 APartnerKey, out Boolean ALabelsAvailable, Boolean ACountOnly, TDBTransaction AReadTransaction)
	get the local partner data More...

Detailed Description

Office Specific Data Labels 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

TOfficeSpecificDataLabelsUIConnector() [1/2]

Ict.Petra.Server.MCommon.UIConnectors.TOfficeSpecificDataLabelsUIConnector.TOfficeSpecificDataLabelsUIConnector ( Int64  APartnerKey, TOfficeSpecificDataLabelUseEnum  AOfficeSpecificDataLabelUse  )

inline

Constructor.

Parameters

APartnerKey	PartnerKey for the Partner to instantiate this object with
AOfficeSpecificDataLabelUse	Office Specific Data Label Use

Returns

void

TOfficeSpecificDataLabelsUIConnector() [2/2]

Ict.Petra.Server.MCommon.UIConnectors.TOfficeSpecificDataLabelsUIConnector.TOfficeSpecificDataLabelsUIConnector ( Int64  APartnerKey, Int32  AApplicationKey, Int64  ARegistrationOffice, TOfficeSpecificDataLabelUseEnum  AOfficeSpecificDataLabelUse  )

inline

Constructor.

Parameters

APartnerKey	PartnerKey for the Partner to instantiate this object with
AApplicationKey	ApplicationKey for the Application to instantiate this object with
ARegistrationOffice	RegistrationOffice PartnerKey for the Application to instantiate this object with
AOfficeSpecificDataLabelUse	Office Specific Data Label Use

Returns

void

Member Function Documentation

CountLabelUse()

Int32 Ict.Petra.Server.MCommon.UIConnectors.TOfficeSpecificDataLabelsUIConnector.CountLabelUse ( String  ALabelUse, TDBTransaction  AReadTransaction  )

inline

Returns the number of Labels available for a certain LabelUse.

Parameters

ALabelUse	LabelUse as stored in p_data_label_use
AReadTransaction	Transaction for the SELECT COUNT statement

Returns

Number of Labels available for a certain LabelUse.

GetData()

OfficeSpecificDataLabelsTDS Ict.Petra.Server.MCommon.UIConnectors.TOfficeSpecificDataLabelsUIConnector.GetData ( )

inline

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

Returns

GetDataLocalPartnerDataValues()

PDataLabelValuePartnerTable Ict.Petra.Server.MCommon.UIConnectors.TOfficeSpecificDataLabelsUIConnector.GetDataLocalPartnerDataValues ( Int64  APartnerKey, out Boolean  ALabelsAvailable, Boolean  ACountOnly, TDBTransaction  AReadTransaction  )

inline

get the local partner data

GetPartnerShortName()

Boolean Ict.Petra.Server.MCommon.UIConnectors.TOfficeSpecificDataLabelsUIConnector.GetPartnerShortName ( Int64  APartnerKey, out String  APartnerShortName, out TPartnerClass  APartnerClass  )

inline

Get short name for a partner. Boolean returns result if partner was found.

@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

PrepareChangesServerSide()

TSubmitChangesResult Ict.Petra.Server.MCommon.UIConnectors.TOfficeSpecificDataLabelsUIConnector.PrepareChangesServerSide ( DataTable  AInspectDT, TDBTransaction  AReadTransaction  )

inline

Saves data from the Office Specific Data Label Edit Screen (contained in a DataTable).

The DataTable is inspected for added, changed or deleted rows by submitting them to the Business Objects that relate to them. The Business Objects check the DataRow(s) that belong to them for validity before saving the data by calling Stored Procedures for inserting, updating or deleting data are called.

Parameters

AInspectDT	DataTable that needs to be submitted
AReadTransaction	Current Transaction

Returns

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

---

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

• csharp/ICT/Petra/Server/lib/MCommon/OfficeSpecificDataLabels.cs