Namespace: Consultingwerk.OERA.Query
Class 
FilteredDsQueryString Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.Query.QueryString
Consultingwerk.OERA.Query.DSQueryString
Consultingwerk.OERA.Query.FilteredDsQueryString

Inherits: Consultingwerk.OERA.Query.DSQueryString
Implements: Consultingwerk.OERA.IDSQueryString, Consultingwerk.OERA.Query.IQueryMap, Consultingwerk.OERA.Query.IThrowsErrorsOnInvalidSourceMapping

File:FilteredDsQueryString
Purpose:An overload class for DSQueryString to provide for default
filtering like a globally used Company Id based on login.
Syntax:See NewDSQueryString in Consultingwerk.OeraTests.SCL769.OrderCustomer.OrderDataAccess
Description:Typically the business logic will be implemented in the data access class
of business entity by overwriting the NewDSQueryString method. There this
class will be instantiated and replaces the normally DSQueryString instance.
There the 'default' filter options (based on the specific business rules)
are set.
Author(s):Richard Kelters / Consultingwerk Ltd.
Created:Tue Feb 06 11:53:02 CET 2018

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
AddFilter (character, character, CharacterList) Add record to the eFilter temp-table.
CHARACTER DefaultQuery () Manipulate the default query with 'default' application/business logic filters. For instance login company ID.
CHARACTER SourceBufferFilterWhereString (character, handle) Create where string for source buffer based on filter.

Top Constructor Summary
Options Name Purpose
FilteredDsQueryString (character, DataAccess, character, logical) Constructor for the DSQueryString class
FilteredDsQueryString (IQueryExpression, ListSortField, IDSQueryStringSource, character, logical, logical) Constructor for the DSQueryString class

Top Property Summary
Options Name Purpose
Consultingwerk.OERA.DataAccess DataAccess


Method Detail
Top

AddFilter (character, character, CharacterList)
Purpose: Add record to the eFilter temp-table.
Notes:

Parameters:
pcTable CHARACTER
Temp-table name that needs to get filled.
pcField CHARACTER
Source buffer name plus dot plus field name.
poList Consultingwerk.Framework.Collections.CharacterList
List of values the field in the source buffer may have.
Top

CHARACTER DefaultQuery ()
Purpose: Manipulate the default query with 'default' application/business logic
filters. For instance login company ID.
Notes: Also has the ability to have several values for one field so that for
instance the 'default' query is restricted to more than one login company ID.
Typically the business logic will be implemented in the data access class
of business entity by overwriting the NewDSQueryString method. There this
class will be instantiated and replaces the normally DSQueryString instance.
Than one or more CharacterList are instantiated before calling the AddFilter
method one or more times in this class.

Returns CHARACTER
default query string
Top

CHARACTER SourceBufferFilterWhereString (character, handle)
Purpose: Create where string for source buffer based on filter.
Notes: For instance: '(Customer.Salesrep EQ "BBB" OR Customer.Salesrep EQ "HXM")'

Parameters:
pcTempTableName CHARACTER
temp-table name that needs to get filled
phSourceBuffer HANDLE
source buffer handle to validate fieldnames
Returns CHARACTER
where string


Constructor Detail
Top

FilteredDsQueryString (character, DataAccess, character, logical)
Purpose: Constructor for the DSQueryString class
Notes: Alternative Constructor that allows setting of the
FilterUsingInnerJoin property of the QueryString class.

Parameters:
pcQueryString CHARACTER
The query string from the current read request
phInstance Consultingwerk.OERA.DataAccess
The reference to the owning DataAccess class (for call backs)
pcTable CHARACTER
The name of the temp-table this DSQueryString instance is providing source query manipulation for
plFilterUsingInnerJoin LOGICAL
The value for the FilterUsingInnerJoin property
Top

FilteredDsQueryString (IQueryExpression, ListSortField, IDSQueryStringSource, character, logical, logical)
Purpose: Constructor for the DSQueryString class
Notes: Alternative Constructor that allows setting of the
FilterUsingInnerJoin property of the QueryString class

Parameters:
poQueryExpression Consultingwerk.IQueryExpression
The query string from the current read request
poQuerySort Consultingwerk.ListSortField
The list of sort fields
phInstance Consultingwerk.OERA.Query.IDSQueryStringSource
The reference to the owning DataAccess class (for call backs)
pcTable CHARACTER
The name of the temp-table this DSQueryString instance is providing source query manipulation for
plFilterUsingInnerJoin LOGICAL
The value for the FilterUsingInnerJoin property
plThrowErrorsOnInvalidSourceMapping LOGICAL
Throw errors on invalid source field mapping


Property Detail
Top

Consultingwerk.OERA.DataAccess DataAccess

Returns Consultingwerk.OERA.DataAccess


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       13.04.2026 10:22:32