OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Server.MPartner.Extracts.UIConnectors.TPartnerNewExtractUIConnector Class Reference

New Extract User Interface Connector It contains methods to create new extracts in m_extract_master data table More...

Public Member Functions

 TPartnerNewExtractUIConnector ()
 Constructor More...
 
bool CreateNewExtract (String AExtractName, String AExtractDescription, out Int32 AExtractID, out Boolean AExtractAlreadyExists)
 Creates a new extract with the given extract name and extract descriptionin the m_extract_master data table. The extract name must be unique. More...
 
bool CreateExtractFromListOfPartnerKeys (String AExtractName, String AExtractDescription, out Int32 ANewExtractId, DataTable APartnerKeysTable, Int32 APartnerKeyColumn, bool AAddressFilterAdded)
 create an extract from a list of best addresses More...
 
void DeleteExtractAgain ()
 Deletes the Extract again that was created by this UIConnector. This is needed if a client-side process that involved creating a new Extract failed somehow and the created Extract needs to be deleted again. More...
 

Detailed Description

New Extract User Interface Connector It contains methods to create new extracts in m_extract_master data table

Constructor & Destructor Documentation

◆ TPartnerNewExtractUIConnector()

Ict.Petra.Server.MPartner.Extracts.UIConnectors.TPartnerNewExtractUIConnector.TPartnerNewExtractUIConnector ( )
inline

Constructor

Member Function Documentation

◆ CreateExtractFromListOfPartnerKeys()

bool Ict.Petra.Server.MPartner.Extracts.UIConnectors.TPartnerNewExtractUIConnector.CreateExtractFromListOfPartnerKeys ( String  AExtractName,
String  AExtractDescription,
out Int32  ANewExtractId,
DataTable  APartnerKeysTable,
Int32  APartnerKeyColumn,
bool  AAddressFilterAdded 
)
inline

create an extract from a list of best addresses

Parameters
AExtractNameName of the Extract to be created.
AExtractDescriptionDescription of the Extract to be created.
ANewExtractIdExtract Id of the created Extract, or -1 if the creation of the Extract was not successful.
APartnerKeysTable
APartnerKeyColumnnumber of the column that contains the partner keys
AAddressFilterAddedtrue if location key fields exist in APartnerKeysTable
Returns
True if the new Extract was created, otherwise false.

◆ CreateNewExtract()

bool Ict.Petra.Server.MPartner.Extracts.UIConnectors.TPartnerNewExtractUIConnector.CreateNewExtract ( String  AExtractName,
String  AExtractDescription,
out Int32  AExtractID,
out Boolean  AExtractAlreadyExists 
)
inline

Creates a new extract with the given extract name and extract descriptionin the m_extract_master data table. The extract name must be unique.

Parameters
AExtractNameName of the extract to be created
AExtractDescriptionDescription of the extract to be created
AExtractIDExtract Id of the new created extract. -1 if not successfull
AExtractAlreadyExistsTrue if there is already an extract with the given name. Otherwise false
Returns
true if the new extract was created. Otherwise false

◆ DeleteExtractAgain()

void Ict.Petra.Server.MPartner.Extracts.UIConnectors.TPartnerNewExtractUIConnector.DeleteExtractAgain ( )
inline

Deletes the Extract again that was created by this UIConnector. This is needed if a client-side process that involved creating a new Extract failed somehow and the created Extract needs to be deleted again.


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