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

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
# AddSerializableProperties (character) Add a list of Serializable Properties to the SerializableProperties property
Inherited from Consultingwerk.JsonSerializable
+ Deserialize (longchar) Deserializes a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ DeserializeFromJsonObject (JsonObject) Initializes the object instance based on the passed in JsonObject representation of the object instance
Inherited from Consultingwerk.JsonSerializable
# DeserializeProperty (JsonObject, character, character) Deserializes a single property value to the current JsonObject
Inherited from Consultingwerk.JsonSerializable
+ Consultingwerk.OERA.FetchDataRequest FromTempTable (table) Deserializes a FetchDataRequest object from the first eFetchDataRequest record.
+ CHARACTER GetSerializableProperties () Returns the meta data of the serializable properties
Inherited from Consultingwerk.JsonSerializable
+ LONGCHAR Serialize () Returns a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
# SerializeProperty (JsonObject, character, character) Serializes a single property value to the current JsonObject
Inherited from Consultingwerk.JsonSerializable
+ Progress.Json.ObjectModel.JsonObject ToJsonObject () Returns a JsonObject representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER ToString () Returns a string representation of the object instance
+ ToTempTable (table) Serializes the FetchDataRequest instance to a record in the eFetchDataRequest temp-table
+ LONGCHAR WriteJson () Returns a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ LONGCHAR WriteXml () Returns an XML LONGCHAR representation of the object instance
Inherited from Consultingwerk.JsonSerializable
+ HANDLE XmlSerialize (handle) Serializes the properties of the current object instance to an existing X-NODEREF object
Inherited from Consultingwerk.JsonSerializable
+ XmlSerializeProperties (handle) Serializes the properties of this object instance as child nodes of the given node
Inherited from Consultingwerk.JsonSerializable
# XmlSerializeProperty (handle, character, character) Serializes a single property value to the current parent XmlNode
Inherited from Consultingwerk.JsonSerializable

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 Joins
+ Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable
+ Consultingwerk.OERA.INamedQueryParameter NamedQuery
+ CHARACTER NextContext
+ INTEGER NumRecords
+ CHARACTER Positions
+ CHARACTER PrevContext
+ CHARACTER Queries
+ Consultingwerk.IQueryExpression QueryExpression
+ CHARACTER Requests
+ LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL SerializeNullValues
Inherited from Consultingwerk.JsonSerializable
+ INTEGER Skip
+ INTEGER StopAfter
+ CHARACTER Tables
+ LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable


Method Detail
Top

PROTECTED AddSerializableProperties (character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Add a list of Serializable Properties to the SerializableProperties property
Notes: Required as a workaround to full reflection only. We *may* remove this
method once Progress Software has implemented full reflection

Parameters:
pcSerializableProperties CHARACTER
A comma delimited list of serializable properties
Top

PUBLIC Deserialize (longchar)
Inherited from Consultingwerk.JsonSerializable
Purpose: Deserializes a LONGCHAR representation of the state of the class instance
Notes:

Parameters:
pcSerializedReprasentation LONGCHAR
The stored LONGCHAR representation of the objects data
Top

PUBLIC DeserializeFromJsonObject (JsonObject)
Inherited from Consultingwerk.JsonSerializable
Purpose: Initializes the object instance based on the passed in JsonObject
representation of the object instance
Notes:

Parameters:
poJsonObject JsonObject
The stored JsonObject representation of the objects data
Top

PROTECTED DeserializeProperty (JsonObject, character, character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Deserializes a single property value to the current JsonObject
Notes: Allows to override the handling of individual properties during the
JsonSerialization
Notes:

Parameters:
poJsonObject JsonObject
The reference to the source JsonObject
pcProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property
Top

PUBLIC 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

PUBLIC CHARACTER GetSerializableProperties ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns the meta data of the serializable properties
Notes:

Returns CHARACTER
The serializable properties meta data as a comma delimited list
Top

PUBLIC LONGCHAR Serialize ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns a LONGCHAR representation of the state of the class instance
Notes: Returns the classname together with the Json serialization

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PROTECTED SerializeProperty (JsonObject, character, character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes a single property value to the current JsonObject
Notes: Allows to override the handling of individual properties during the
JsonSerialization

Parameters:
poJsonObject JsonObject
The reference to the target JsonObject
pcProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property
Top

PUBLIC Progress.Json.ObjectModel.JsonObject ToJsonObject ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns a JsonObject representation of the state of the class instance
Notes: Returns the classname together with the Json serialization of the
object

Returns Progress.Json.ObjectModel.JsonObject
The Progress.Json.ObjectModel.JsonObject representation of the ISerializable objects data
Top

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

Returns CHARACTER
The string representation of the object instance
Top

PUBLIC 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
Top

PUBLIC LONGCHAR WriteJson ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns a LONGCHAR representation of the state of the class instance
Notes: Returns the classname together with the Json serialization
This method is a facade to the JsonSerializable:Serialize method

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PUBLIC LONGCHAR WriteXml ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns an XML LONGCHAR representation of the object instance
Notes:

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PUBLIC HANDLE XmlSerialize (handle)
Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes the properties of the current object instance to
an existing X-NODEREF object
Notes:

Parameters:
phParent HANDLE
The reference to the parent XML Node or Document
Returns HANDLE
The X-NODEREF with the properties of the serialized object
Top

PUBLIC XmlSerializeProperties (handle)
Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes the properties of this object instance as child nodes of
the given node
Notes:

Parameters:
phObjectNode HANDLE
The reference to the X-NODEREF object that represents the node for the current instance
Top

PROTECTED XmlSerializeProperty (handle, character, character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes a single property value to the current parent XmlNode
Notes: Allows to override the handling of individual properties during the
XmlSerialization

Parameters:
phParentNode HANDLE
The reference to the parent XML Node
pcProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property


Constructor Detail
Top

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

Top

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

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

PUBLIC 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

PUBLIC 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 cient 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

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

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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

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

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

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

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


Property Detail
Top

PUBLIC CHARACTER AllTables

Returns CHARACTER
Top

PUBLIC CHARACTER Context

Returns CHARACTER
Top

PUBLIC CHARACTER CustomContext

Returns CHARACTER
Top

PUBLIC Progress.Lang.Object CustomParameter

Returns Progress.Lang.Object
Top

PUBLIC CHARACTER Joins

Returns CHARACTER
Top

PUBLIC Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable

Returns Consultingwerk.IJsonDateTypeFormatter
Top

PUBLIC Consultingwerk.OERA.INamedQueryParameter NamedQuery

Returns Consultingwerk.OERA.INamedQueryParameter
Top

PUBLIC CHARACTER NextContext

Returns CHARACTER
Top

PUBLIC INTEGER NumRecords

Returns INTEGER
Top

PUBLIC CHARACTER Positions

Returns CHARACTER
Top

PUBLIC CHARACTER PrevContext

Returns CHARACTER
Top

PUBLIC CHARACTER Queries

Returns CHARACTER
Top

PUBLIC Consultingwerk.IQueryExpression QueryExpression

Returns Consultingwerk.IQueryExpression
Top

PUBLIC CHARACTER Requests

Returns CHARACTER
Top

PUBLIC LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PUBLIC LOGICAL SerializeNullValues
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PUBLIC INTEGER Skip

Returns INTEGER
Top

PUBLIC INTEGER StopAfter

Returns INTEGER
Top

PUBLIC CHARACTER Tables

Returns CHARACTER
Top

PUBLIC LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.02.2020 23:13:23