OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Server.MPartner.ImportExport.WebConnectors.TImportExportWebConnector Class Reference

import and export partner data More...

Static Public Member Functions

static PartnerImportExportTDS ReadPartnerDataForCSV (Int64 APartnerKey, List< String >ACSVColumns)
 read data from db for partner with given key according to csv columns needed More...
 
static PartnerImportExportTDS ImportFromCSVFileReturnDataSet (string ACSVPartnerData, string ADateFormat, string ASeparator, out TVerificationResultCollection AVerificationResult)
 This imports partners from a CSV file and returns the imported data as a dataset More...
 
static bool ImportFromCSVFile (string ACSVPartnerData, string ADateFormat, string ASeparator, out TVerificationResultCollection AVerificationResult)
 This imports partners from a CSV file More...
 
static bool ImportFromODSFile (byte[] AODSPartnerData, out TVerificationResultCollection AVerificationResult)
 This imports partners from a ODS file More...
 
static bool ImportFromXLSXFile (byte[] AXLSXPartnerData, out TVerificationResultCollection AVerificationResult)
 This imports partners from a XLSX file More...
 
static Boolean CommitChanges (PartnerImportExportTDS MainDS, Boolean AReplaceAddress, Boolean AIgnoreImportAddress, Int64 ASiteKeyToBeReplaced, Int32 ALocationKeyToBeReplaced, out TVerificationResultCollection AVerificationResult)
 Web connector for commit changes after importing a partner Before calling SubmitChanges on the dataset, this does a load of checks and supplies values to index tables. More...
 
static bool CheckExtractContainsFamily (int AExtractId)
 Checks to see if an extract contains at least one family partner More...
 

Detailed Description

import and export partner data

Member Function Documentation

◆ CheckExtractContainsFamily()

static bool Ict.Petra.Server.MPartner.ImportExport.WebConnectors.TImportExportWebConnector.CheckExtractContainsFamily ( int  AExtractId)
inlinestatic

Checks to see if an extract contains at least one family partner

◆ CommitChanges()

static Boolean Ict.Petra.Server.MPartner.ImportExport.WebConnectors.TImportExportWebConnector.CommitChanges ( PartnerImportExportTDS  MainDS,
Boolean  AReplaceAddress,
Boolean  AIgnoreImportAddress,
Int64  ASiteKeyToBeReplaced,
Int32  ALocationKeyToBeReplaced,
out TVerificationResultCollection  AVerificationResult 
)
inlinestatic

Web connector for commit changes after importing a partner Before calling SubmitChanges on the dataset, this does a load of checks and supplies values to index tables.

Parameters
MainDS
AReplaceAddress
AIgnoreImportAddress
ASiteKeyToBeReplaced
ALocationKeyToBeReplaced
AVerificationResult
Returns
true if no error

◆ ImportFromCSVFile()

static bool Ict.Petra.Server.MPartner.ImportExport.WebConnectors.TImportExportWebConnector.ImportFromCSVFile ( string  ACSVPartnerData,
string  ADateFormat,
string  ASeparator,
out TVerificationResultCollection  AVerificationResult 
)
inlinestatic

This imports partners from a CSV file

Parameters
ACSVPartnerDataThe data to import
ADateFormatA date format string like MDY or DMY. Only the first character is significant and must be M for month first. The date format string is only relevant to ambiguous dates which typically have a 1 or 2 digit month
AVerificationResultA collection of import errors
ASeparatorComma or Semicolon

◆ ImportFromCSVFileReturnDataSet()

static PartnerImportExportTDS Ict.Petra.Server.MPartner.ImportExport.WebConnectors.TImportExportWebConnector.ImportFromCSVFileReturnDataSet ( string  ACSVPartnerData,
string  ADateFormat,
string  ASeparator,
out TVerificationResultCollection  AVerificationResult 
)
inlinestatic

This imports partners from a CSV file and returns the imported data as a dataset

Parameters
ACSVPartnerDataThe data to import
ADateFormatA date format string like MDY or DMY. Only the first character is significant and must be M for month first. The date format string is only relevant to ambiguous dates which typically have a 1 or 2 digit month
AVerificationResultA collection of import errors
ASeparatorComma or Semicolon

◆ ImportFromODSFile()

static bool Ict.Petra.Server.MPartner.ImportExport.WebConnectors.TImportExportWebConnector.ImportFromODSFile ( byte[]  AODSPartnerData,
out TVerificationResultCollection  AVerificationResult 
)
inlinestatic

This imports partners from a ODS file

Parameters
AODSPartnerDataThe data to import
AVerificationResultA collection of import errors

◆ ImportFromXLSXFile()

static bool Ict.Petra.Server.MPartner.ImportExport.WebConnectors.TImportExportWebConnector.ImportFromXLSXFile ( byte[]  AXLSXPartnerData,
out TVerificationResultCollection  AVerificationResult 
)
inlinestatic

This imports partners from a XLSX file

Parameters
AXLSXPartnerDataThe data to import
AVerificationResultA collection of import errors

◆ ReadPartnerDataForCSV()

static PartnerImportExportTDS Ict.Petra.Server.MPartner.ImportExport.WebConnectors.TImportExportWebConnector.ReadPartnerDataForCSV ( Int64  APartnerKey,
List< String >  ACSVColumns 
)
inlinestatic

read data from db for partner with given key according to csv columns needed

Returns

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