Namespace: Consultingwerk.OERA
Class 
FetchDataRequest Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.JsonSerializable
Consultingwerk.OERA.FetchDataRequest

Inherits: Consultingwerk.JsonSerializable
Implements: Consultingwerk.OERA.IFetchDataBySkip, Consultingwerk.OERA.IFetchDataRequest, Consultingwerk.IJsonSerializable
Inherited by: Consultingwerk.OERA.CountRecordsRequest Consultingwerk.SmartFramework.Menu.GetMenusRequest

File:FetchDataRequests
Purpose:Parameter object for FetchData requests
Author(s):Mike Fechner
Created:Sun Mar 07 23:36:10 CET 2010

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



Top Method Summary
Options Name Purpose
Progress.Lang.Object Clone () Clones the object instance
Consultingwerk.OERA.FetchDataRequest ForKeyField (character, character, character) Factory method for the FetchDataRequest class
Consultingwerk.OERA.FetchDataRequest ForKeyField (character, character, decimal) Factory method for the FetchDataRequest class
Consultingwerk.OERA.FetchDataRequest ForKeyField (character, character, integer) Factory method for the FetchDataRequest class
Consultingwerk.OERA.FetchDataRequest ForKeyFieldOrNameField (character, character, character, character) Factory method for the FetchDataRequest class
Consultingwerk.OERA.FetchDataRequest ForKeyFieldOrNameField (character, character, character, decimal) Factory method for the FetchDataRequest class
Consultingwerk.OERA.FetchDataRequest ForKeyFieldOrNameField (character, character, character, integer) Factory method for the FetchDataRequest class
Consultingwerk.OERA.FetchDataRequest FromTempTable (table) Deserializes a FetchDataRequest object from the first eFetchDataRequest record.
Consultingwerk.OERA.FetchDataRequest SetCustomContext (character) Assigns a value to the CustomContext property
Consultingwerk.OERA.FetchDataRequest SetCustomParameter (Object) Assigns a value to the CustomParameter property
Consultingwerk.OERA.FetchDataRequest SetFields (character) Assigns a value to the Fields property
Consultingwerk.OERA.FetchDataRequest SetQueryExpression (IQueryExpression) Assigns a value to the QueryExpression property
Consultingwerk.OERA.FetchDataRequest SetStopAfter (integer) Assigns a value to the StopAfter property
Consultingwerk.OERA.FetchDataRequest SetTables (character) Assigns a value to the Tables property
CHARACTER ToString () Returns a string representation of the object instance
ToTempTable (table) Serializes the FetchDataRequest instance to a record in the eFetchDataRequest temp-table

Top Constructor Summary
Options Name Purpose
FetchDataRequest () Constructor for the FetchDataRequest class
FetchDataRequest (character) Simplified constructor when doing calls from custom code
FetchDataRequest (character, character) Simplified constructor when doing calls from custom code
FetchDataRequest (character, character, character, integer, character) Default Constructor for the FetchDataRequest class
FetchDataRequest (character, character, integer) Simplified constructor when doing calls from custom code
FetchDataRequest (character, character, integer, character) Default Constructor for the FetchDataRequest class
FetchDataRequest (character, character[]) Simplified constructor when doing calls from custom code
FetchDataRequest (character, character[], integer) Simplified constructor when doing calls from custom code
FetchDataRequest (character, integer) Simplified constructor when doing calls from custom code
FetchDataRequest (character[]) Simplified constructor when doing calls from custom code
FetchDataRequest (character[], character) Simplified constructor when doing calls from custom code
FetchDataRequest (character[], character, integer) Simplified constructor when doing calls from custom code
FetchDataRequest (character[], character[]) Simplified constructor when doing calls from custom code
FetchDataRequest (character[], character[], integer) Simplified constructor when doing calls from custom code
FetchDataRequest (character[], integer) Simplified constructor when doing calls from custom code
FetchDataRequest (ISerializable) Constructor for the FetchDataRequest class
FetchDataRequest (INamedQueryParameter) Constructor for the FetchDataRequest class

Top Property Summary
Options Name Purpose
CHARACTER AllTables
CHARACTER Context
CHARACTER CustomContext
Progress.Lang.Object CustomParameter
CHARACTER Fields
CHARACTER Joins
Progress.Json.ObjectModel.JsonConstruct JsonParameter
Consultingwerk.OERA.INamedQueryParameter NamedQuery
CHARACTER NextContext
INTEGER NumRecords
CHARACTER Positions
CHARACTER PrevContext
CHARACTER Queries
Consultingwerk.IQueryExpression QueryExpression
Consultingwerk.QueryExpressionWithSort QueryExpressionsWithSort
CHARACTER Requests
INTEGER Skip
INTEGER StopAfter
CHARACTER Tables


Method Detail
Top

Progress.Lang.Object Clone ()
Purpose: Clones the object instance
Notes: Does not perform a deep copy, CustomParameter, NamedQuery and
QueryExpression are not cloned. Here the references are cloned

Returns Progress.Lang.Object
The cloned object instance
Top

Consultingwerk.OERA.FetchDataRequest ForKeyField (character, character, character)
Purpose: Factory method for the FetchDataRequest class
Notes: Return a request instance based on a table, keyfield and value

Parameters:
pcTableName CHARACTER
The name of the temp-table to request
pcKeyFieldName CHARACTER
The name of the key field
pcKeyFieldValue CHARACTER
The value of the key field
Returns Consultingwerk.OERA.FetchDataRequest
The FetchDataRequest instance
Top

Consultingwerk.OERA.FetchDataRequest ForKeyField (character, character, decimal)
Purpose: Factory method for the FetchDataRequest class
Notes: Return a request instance based on a table, keyfield and value

Parameters:
pcTableName CHARACTER
The name of the temp-table to request
pcKeyFieldName CHARACTER
The name of the key field
pdeKeyFieldValue DECIMAL
The value of the key field
Returns Consultingwerk.OERA.FetchDataRequest
The FetchDataRequest instance
Top

Consultingwerk.OERA.FetchDataRequest ForKeyField (character, character, integer)
Purpose: Factory method for the FetchDataRequest class
Notes: Return a request instance based on a table, keyfield and value

Parameters:
pcTableName CHARACTER
The name of the temp-table to request
pcKeyFieldName CHARACTER
The name of the key field
piKeyFieldValue INTEGER
The value of the key field
Returns Consultingwerk.OERA.FetchDataRequest
The FetchDataRequest instance
Top

Consultingwerk.OERA.FetchDataRequest ForKeyFieldOrNameField (character, character, character, character)
Purpose: Factory method for the FetchDataRequest class
Notes: Return a request instance based on a table, keyfield, name field and value

Parameters:
pcTableName CHARACTER
The name of the temp-table to request
pcKeyFieldName CHARACTER
The name of the key field
pcNameFieldName CHARACTER
The name of the name field
pcKeyFieldValue CHARACTER
The value of the key field
Returns Consultingwerk.OERA.FetchDataRequest
The FetchDataRequest instance
Top

Consultingwerk.OERA.FetchDataRequest ForKeyFieldOrNameField (character, character, character, decimal)
Purpose: Factory method for the FetchDataRequest class
Notes: Return a request instance based on a table, keyfield, name field and value

Parameters:
pcTableName CHARACTER
The name of the temp-table to request
pcKeyFieldName CHARACTER
The name of the key field
pcNameFieldName CHARACTER
The name of the name field
pdeKeyFieldValue DECIMAL
The value of the key field
Returns Consultingwerk.OERA.FetchDataRequest
The FetchDataRequest instance
Top

Consultingwerk.OERA.FetchDataRequest ForKeyFieldOrNameField (character, character, character, integer)
Purpose: Factory method for the FetchDataRequest class
Notes: Return a request instance based on a table, keyfield, name field and value

Parameters:
pcTableName CHARACTER
The name of the temp-table to request
pcKeyFieldName CHARACTER
The name of the key field
pcNameFieldName CHARACTER
The name of the name field
piKeyFieldValue INTEGER
The value of the key field
Returns Consultingwerk.OERA.FetchDataRequest
The FetchDataRequest instance
Top

Consultingwerk.OERA.FetchDataRequest FromTempTable (table)
Purpose: Deserializes a FetchDataRequest object from the first
eFetchDataRequest record.
Notes:

Parameters:
eFetchDataRequest TEMP-TABLE eFetchDataRequest
INPUT TABLE with fields to use for this-objects properties
Returns Consultingwerk.OERA.FetchDataRequest
The deserialized FetchDataRequest instance
Top

Consultingwerk.OERA.FetchDataRequest SetCustomContext (character)
Purpose: Assigns a value to the CustomContext property
Notes:

Parameters:
pcCustomContext CHARACTER
The value for the CustomContext property
Returns Consultingwerk.OERA.FetchDataRequest
The reference to the FetchDataRequest instance (fluent style)
Top

Consultingwerk.OERA.FetchDataRequest SetCustomParameter (Object)
Purpose: Assigns a value to the CustomParameter property
Notes:

Parameters:
poCustomParameter Progress.Lang.Object
The value for the CustomContext property
Returns Consultingwerk.OERA.FetchDataRequest
The reference to the FetchDataRequest instance (fluent style)
Top

Consultingwerk.OERA.FetchDataRequest SetFields (character)
Purpose: Assigns a value to the Fields property
Notes:

Parameters:
pcFields CHARACTER
The value for the Fields property
Returns Consultingwerk.OERA.FetchDataRequest
The reference to the FetchDataRequest instance (fluent style)
Top

Consultingwerk.OERA.FetchDataRequest SetQueryExpression (IQueryExpression)
Purpose: Assigns a value to the QueryExpression property
Notes:

Parameters:
poQueryExpression Consultingwerk.IQueryExpression
The value for the CustomContext property
Returns Consultingwerk.OERA.FetchDataRequest
The reference to the FetchDataRequest instance (fluent style)
Top

Consultingwerk.OERA.FetchDataRequest SetStopAfter (integer)
Purpose: Assigns a value to the StopAfter property
Notes:

Parameters:
piStopAfter INTEGER
The value for the CustomContext property
Returns Consultingwerk.OERA.FetchDataRequest
The reference to the FetchDataRequest instance (fluent style)
Top

Consultingwerk.OERA.FetchDataRequest SetTables (character)
Purpose: Assigns a value to the Tables property
Notes:

Parameters:
pcTables CHARACTER
The value for the Tables property
Returns Consultingwerk.OERA.FetchDataRequest
The reference to the FetchDataRequest instance (fluent style)
Top

CHARACTER ToString ()
Purpose: Returns a string representation of the object instance
Notes:

Returns CHARACTER
The string representation of the object instance
Top

ToTempTable (table)
Purpose: Serializes the FetchDataRequest instance to a record in the
eFetchDataRequest temp-table
Notes:

Parameters:
eFetchDataRequest TEMP-TABLE eFetchDataRequest
OUTPUT TABLE with fields to populate from this-objects properties


Constructor Detail
Top

FetchDataRequest ()
Purpose: Constructor for the FetchDataRequest class
Notes:

Top

FetchDataRequest (character)
Purpose: Simplified constructor when doing calls from custom code
Notes:

Parameters:
pcTables CHARACTER
The tables to retrieve, Tables attribute
Top

FetchDataRequest (character, character)
Purpose: Simplified constructor when doing calls from custom code
Notes:

Parameters:
pcTables CHARACTER
The tables to retrieve, Tables attribute
pcQueries CHARACTER
The CHR(1) delimited list of query strings per table, Queries attribute
Top

FetchDataRequest (character, character, character, integer, character)
Purpose: Default Constructor for the FetchDataRequest class
Notes: This is the constructor used by the SmartBusinessEntityAdapter
when making requests to the back end.

Parameters:
pcTables CHARACTER
The tables to retrieve, Tables attribute
pcQueries CHARACTER
The CHR(1) delimited list of query strings per table, Queries attribute
pcRequests CHARACTER
The request types (typically ADM2 client only), Requests attribute
piNumRecords INTEGER
The number of records to retrieve from the first table (batch size), NumRecords attribute
pcContext CHARACTER
The request context, Context attribute
Top

FetchDataRequest (character, character, integer)
Purpose: Simplified constructor when doing calls from custom code
Notes:

Parameters:
pcTables CHARACTER
The tables to retrieve, Tables attribute
pcQueries CHARACTER
The CHR(1) delimited list of query strings per table, Queries attribute
piNumRecords INTEGER
The number of records to retrieve from the first table (batch size), NumRecords attribute
Top

FetchDataRequest (character, character, integer, character)
Purpose: Default Constructor for the FetchDataRequest class
Notes: This is the constructor used by the SmartBusinessEntityAdapter
when making requests to the back end.

Parameters:
pcTables CHARACTER
The tables to retrieve, Tables attribute
pcQueries CHARACTER
The CHR(1) delimited list of query strings per table, Queries attribute
piNumRecords INTEGER
The number of records to retrieve from the first table (batch size), NumRecords attribute
pcContext CHARACTER
The request context, Context attribute
Top

FetchDataRequest (character, character[])
Purpose: Simplified constructor when doing calls from custom code
Notes:

Parameters:
pcTables CHARACTER
The tables to retrieve, Tables attribute
pcQueries CHARACTER
The CHR(1) delimited list of query strings per table, Queries attribute
Top

FetchDataRequest (character, character[], integer)
Purpose: Simplified constructor when doing calls from custom code
Notes:

Parameters:
pcTables CHARACTER
The tables to retrieve, Tables attribute
pcQueries CHARACTER
The CHR(1) delimited list of query strings per table, Queries attribute
piNumRecords INTEGER
The number of records to retrieve from the first table (batch size), NumRecords attribute
Top

FetchDataRequest (character, integer)
Purpose: Simplified constructor when doing calls from custom code
Notes:

Parameters:
pcTables CHARACTER
The tables to retrieve, Tables attribute
piNumRecords INTEGER
The number of records to retrieve from the first table (batch size), NumRecords attribute
Top

FetchDataRequest (character[])
Purpose: Simplified constructor when doing calls from custom code
Notes:

Parameters:
pcTables CHARACTER
The tables to retrieve, Tables attribute
Top

FetchDataRequest (character[], character)
Purpose: Simplified constructor when doing calls from custom code
Notes:

Parameters:
pcTables CHARACTER
The tables to retrieve, Tables attribute
pcQueries CHARACTER
The CHR(1) delimited list of query strings per table, Queries attribute
Top

FetchDataRequest (character[], character, integer)
Purpose: Simplified constructor when doing calls from custom code
Notes:

Parameters:
pcTables CHARACTER
The tables to retrieve, Tables attribute
pcQueries CHARACTER
The CHR(1) delimited list of query strings per table, Queries attribute
piNumRecords INTEGER
The number of records to retrieve from the first table (batch size), NumRecords attribute
Top

FetchDataRequest (character[], character[])
Purpose: Simplified constructor when doing calls from custom code
Notes:

Parameters:
pcTables CHARACTER
The tables to retrieve, Tables attribute
pcQueries CHARACTER
The CHR(1) delimited list of query strings per table, Queries attribute
Top

FetchDataRequest (character[], character[], integer)
Purpose: Simplified constructor when doing calls from custom code
Notes:

Parameters:
pcTables CHARACTER
The tables to retrieve, Tables attribute
pcQueries CHARACTER
The CHR(1) delimited list of query strings per table, Queries attribute
piNumRecords INTEGER
The number of records to retrieve from the first table (batch size), NumRecords attribute
Top

FetchDataRequest (character[], integer)
Purpose: Simplified constructor when doing calls from custom code
Notes:

Parameters:
pcTables CHARACTER
The tables to retrieve, Tables attribute
piNumRecords INTEGER
The number of records to retrieve from the first table (batch size), NumRecords attribute
Top

FetchDataRequest (ISerializable)
Purpose: Constructor for the FetchDataRequest class
Notes:

Parameters:
poParameter Consultingwerk.ISerializable
The value for the CustomParameter property
Top

FetchDataRequest (INamedQueryParameter)
Purpose: Constructor for the FetchDataRequest class
Notes:

Parameters:
poNamedQuery Consultingwerk.OERA.INamedQueryParameter
The value for the NamedQuery property


Property Detail
Top

CHARACTER AllTables

Returns CHARACTER
Top

CHARACTER Context

Returns CHARACTER
Top

CHARACTER CustomContext

Returns CHARACTER
Top

Progress.Lang.Object CustomParameter

Returns Progress.Lang.Object
Top

CHARACTER Fields

Returns CHARACTER
Top

CHARACTER Joins

Returns CHARACTER
Top

Progress.Json.ObjectModel.JsonConstruct JsonParameter

Returns Progress.Json.ObjectModel.JsonConstruct
Top

Consultingwerk.OERA.INamedQueryParameter NamedQuery

Returns Consultingwerk.OERA.INamedQueryParameter
Top

CHARACTER NextContext

Returns CHARACTER
Top

INTEGER NumRecords

Returns INTEGER
Top

CHARACTER Positions

Returns CHARACTER
Top

CHARACTER PrevContext

Returns CHARACTER
Top

CHARACTER Queries

Returns CHARACTER
Top

Consultingwerk.IQueryExpression QueryExpression

Returns Consultingwerk.IQueryExpression
Top

Consultingwerk.QueryExpressionWithSort QueryExpressionsWithSort

Returns Consultingwerk.QueryExpressionWithSort
Top

CHARACTER Requests

Returns CHARACTER
Top

INTEGER Skip

Returns INTEGER
Top

INTEGER StopAfter

Returns INTEGER
Top

CHARACTER Tables

Returns CHARACTER


Temp-Table Detail

Temp-Table eFetchDataRequest

Defined in:


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