this report is quite simple, and should be used as an example for more complex reports and extracts More...
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) |
| calculate an extract from a report: all recipient that have given to particular fields (ledgers) 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
this report is quite simple, and should be used as an example for more complex reports and extracts
Member Function Documentation
◆ AddAddressFilter()
|
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()
|
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()
|
inlinestatic |
calculate an extract from a report: all recipient that have given to particular fields (ledgers)
- Parameters
-
AParameters AResults
- Returns
◆ CalculateExtractInternal() [1/2]
|
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]
|
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()
|
inlineinherited |
Filter data by postcode (if applicable)
- Parameters
-
APartnerkeys AAddressFilterAdded AParameters ATransaction
◆ RetrieveParameters()
|
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()
|
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
|
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/MFinance/queries/ExtractRecipientByField.cs
