Ict.Petra.Server.MPartner.queries.QueryFamilyExtractForPersons Class Reference

query finds all family records for person records given in a base extract More...

Inheritance diagram for Ict.Petra.Server.MPartner.queries.QueryFamilyExtractForPersons:

Public Member Functions
void	PostcodeFilter (ref DataTable APartnerkeys, ref bool AAddressFilterAdded, TParameterList AParameters, TDBTransaction ATransaction)
	Filter data by postcode (if applicable) More...
bool	AddressMeetsPostCodeCriteriaOrEmpty (string APostcode, String APostalRegion, String APostCodeFrom, String APostCodeTo)
	this will return true if the best address is in the given postal region, postcode range and county it will not reset the data returned by best address More...

Static Public Member Functions
static bool	CalculateExtract (TParameterList AParameters, TResultList AResults, out int AExtractId)
	calculate an extract from a report: all partners living in a given city More...

Protected Member Functions
override void	RetrieveParameters (TParameterList AParameters, ref string ASqlStmt, ref List< OdbcParameter >ASQLParameterList)
	retrieve parameters from client sent in AParameters and build up AParameterList to run SQL query More...
bool	CalculateExtractInternal (TParameterList AParameters, string ASqlStmt, TResultList AResults)
	calculate an extract from a report: all partners of a given type (or selection of multiple types) More...
bool	CalculateExtractInternal (TParameterList AParameters, string ASqlStmt, TResultList AResults, out int AExtractId)
	calculate an extract from a report: all partners of a given type (or selection of multiple types) More...
virtual bool	RunSpecialTreatment (TParameterList AParameters, TDBTransaction ATransaction, out int AExtractId)
	This method needs to be implemented by extracts that can't follow the default processing with just one query. More...

Static Protected Member Functions
static bool	AddAddressFilter (TParameterList AParameters, ref string ASqlStmt, ref List< OdbcParameter >AOdbcParameterList)
	extend query statement and query parameter list by address filter information given in extract parameters More...

Protected Attributes
bool	FSpecialTreatment = false
	Extracts who need special treatment need to set this to true. It is needed if there is more than one query involved in running the extract. More...

Detailed Description

query finds all family records for person records given in a base extract

Member Function Documentation

AddAddressFilter()

static bool Ict.Petra.Server.MCommon.queries.ExtractQueryBase.AddAddressFilter ( TParameterList  AParameters, ref string  ASqlStmt, ref List< OdbcParameter >  AOdbcParameterList  )

inlinestaticprotectedinherited

extend query statement and query parameter list by address filter information given in extract parameters

Parameters

AParameters
ASqlStmt
AOdbcParameterList

Returns

true if address tables and fields were added

AddressMeetsPostCodeCriteriaOrEmpty()

bool Ict.Petra.Server.MCommon.queries.ExtractQueryBase.AddressMeetsPostCodeCriteriaOrEmpty ( string  APostcode, String  APostalRegion, String  APostCodeFrom, String  APostCodeTo  )

inlineinherited

this will return true if the best address is in the given postal region, postcode range and county it will not reset the data returned by best address

Returns

void

CalculateExtract()

static bool Ict.Petra.Server.MPartner.queries.QueryFamilyExtractForPersons.CalculateExtract ( TParameterList  AParameters, TResultList  AResults, out int  AExtractId  )

inlinestatic

calculate an extract from a report: all partners living in a given city

Parameters

AParameters
AResults
AExtractId

Returns

CalculateExtractInternal() [1/2]

bool Ict.Petra.Server.MCommon.queries.ExtractQueryBase.CalculateExtractInternal ( TParameterList  AParameters, string  ASqlStmt, TResultList  AResults  )

inlineprotectedinherited

calculate an extract from a report: all partners of a given type (or selection of multiple types)

Parameters

AParameters
ASqlStmt
AResults

Returns

CalculateExtractInternal() [2/2]

bool Ict.Petra.Server.MCommon.queries.ExtractQueryBase.CalculateExtractInternal ( TParameterList  AParameters, string  ASqlStmt, TResultList  AResults, out int  AExtractId  )

inlineprotectedinherited

calculate an extract from a report: all partners of a given type (or selection of multiple types)

Parameters

AParameters
ASqlStmt
AResults
AExtractId

Returns

PostcodeFilter()

void Ict.Petra.Server.MCommon.queries.ExtractQueryBase.PostcodeFilter ( ref DataTable  APartnerkeys, ref bool  AAddressFilterAdded, TParameterList  AParameters, TDBTransaction  ATransaction  )

inlineinherited

Filter data by postcode (if applicable)

Parameters

APartnerkeys
AAddressFilterAdded
AParameters
ATransaction

RetrieveParameters()

override void Ict.Petra.Server.MPartner.queries.QueryFamilyExtractForPersons.RetrieveParameters ( TParameterList  AParameters, ref string  ASqlStmt, ref List< OdbcParameter >  ASQLParameterList  )

inlineprotectedvirtual

retrieve parameters from client sent in AParameters and build up AParameterList to run SQL query

Parameters

AParameters
ASqlStmt
ASQLParameterList

Implements Ict.Petra.Server.MCommon.queries.ExtractQueryBase.

RunSpecialTreatment()

virtual bool Ict.Petra.Server.MCommon.queries.ExtractQueryBase.RunSpecialTreatment ( TParameterList  AParameters, TDBTransaction  ATransaction, out int  AExtractId  )

inlineprotectedvirtualinherited

This method needs to be implemented by extracts that can't follow the default processing with just one query.

Parameters

AParameters
ATransaction
AExtractId

Reimplemented in Ict.Petra.Server.MFinance.queries.QueryDonorByAmount, and Ict.Petra.Server.MPersonnel.queries.QueryPartnerByField.

Member Data Documentation

FSpecialTreatment

bool Ict.Petra.Server.MCommon.queries.ExtractQueryBase.FSpecialTreatment = false

protectedinherited

Extracts who need special treatment need to set this to true. It is needed if there is more than one query involved in running the extract.

---

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

• csharp/ICT/Petra/Server/lib/MPartner/queries/ExtractFamilyForPersons.cs