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

Inherits: Consultingwerk.OERA.FetchDataRequest
Implements: Consultingwerk.OERA.IFetchDataBySkip, Consultingwerk.OERA.IFetchDataRequest, IJsonSerializable

File:FetchDataAccessRequest
Purpose:Extension to FetchDataRequest with specific instructions
for the Data Access class. It is only expected to be used
from within a Business Entity
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Thu Oct 01 20:55:50 CEST 2015
/* Mike Fechner, Consultingwerk Ltd. 13.09.2017
Preprocessor variables for SmartComponentLibrary, WinKit and SmartFramework
based on Consultingwerk/packages.i now

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



Top Method Summary
Options Name Purpose
# AddSerializableProperties () Adds serializable properties from the calling class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
# AddSerializableProperties (character) Add a list of Serializable Properties to the SerializableProperties property
Inherited from Consultingwerk.JsonSerializable
# AddSerializableProperties (Class) Adds serializable properties from the given class using ABL reflection. Supported from OpenEdge 11.6 on only.
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.
Inherited from Consultingwerk.OERA.FetchDataRequest
+ 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
+ ToTempTable (table) Serializes the FetchDataRequest instance to a record in the eFetchDataRequest temp-table
Inherited from Consultingwerk.OERA.FetchDataRequest
+ 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
+ FetchDataAccessRequest () Constructor for the FetchDataRequest class
+ FetchDataAccessRequest (character) Simplified constructor when doing calls from custom code
+ FetchDataAccessRequest (character, character) Simplified constructor when doing calls from custom code
+ FetchDataAccessRequest (character, character, character, integer, character) Constructor for the FetchDataRequest class
+ FetchDataAccessRequest (character, character, integer) Simplified constructor when doing calls from custom code
+ FetchDataAccessRequest (character, character, integer, character) Constructor for the FetchDataRequest class
+ FetchDataAccessRequest (character, integer) Simplified constructor when doing calls from custom code
+ FetchDataAccessRequest (ISerializable) Constructor for the FetchDataRequest class
+ FetchDataAccessRequest (INamedQueryParameter) Constructor for the FetchDataRequest class
+ FetchDataAccessRequest (IFetchDataRequest) Constructor for the FetchDataRequest class

Top Property Summary
Options Name Purpose
+ CHARACTER AllTables
Inherited from Consultingwerk.OERA.FetchDataRequest
+ LOGICAL AppendFetchData
+ CHARACTER Context
Inherited from Consultingwerk.OERA.FetchDataRequest
+ CHARACTER CustomContext
Inherited from Consultingwerk.OERA.FetchDataRequest
+ Progress.Lang.Object CustomParameter
Inherited from Consultingwerk.OERA.FetchDataRequest
+ CHARACTER FillMode
+ CHARACTER Joins
Inherited from Consultingwerk.OERA.FetchDataRequest
+ IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable
+ Consultingwerk.OERA.INamedQueryParameter NamedQuery
Inherited from Consultingwerk.OERA.FetchDataRequest
+ CHARACTER NextContext
Inherited from Consultingwerk.OERA.FetchDataRequest
+ INTEGER NumRecords
Inherited from Consultingwerk.OERA.FetchDataRequest
+ CHARACTER Positions
Inherited from Consultingwerk.OERA.FetchDataRequest
+ CHARACTER PrevContext
Inherited from Consultingwerk.OERA.FetchDataRequest
+ CHARACTER Queries
Inherited from Consultingwerk.OERA.FetchDataRequest
+ Consultingwerk.IQueryExpression QueryExpression
Inherited from Consultingwerk.OERA.FetchDataRequest
+ CHARACTER Requests
Inherited from Consultingwerk.OERA.FetchDataRequest
+ LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL SerializeNullValues
Inherited from Consultingwerk.JsonSerializable
+ INTEGER Skip
Inherited from Consultingwerk.OERA.FetchDataRequest
+ INTEGER StopAfter
Inherited from Consultingwerk.OERA.FetchDataRequest
+ CHARACTER Tables
Inherited from Consultingwerk.OERA.FetchDataRequest
+ LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable


Method Detail
Top

PROTECTED AddSerializableProperties ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the calling class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes: Adds properties of the following types, does not add properties of
the base classes, adds only PUBLIC properties:
- CHARACTER
- CHARACTER EXTENT
- DATE
- DATE EXTENT
- DATETIME
- DATETIME EXTENT
- DATETIME-TZ
- DATETIME-TZ EXTENT
- DECIMAL
- DECIMAL EXTENT
- INT64
- INT64 EXTENT
- INTEGER
- INTEGER EXTENT
- LOGICAL
- LOGICAL EXTENT
- LONGCHAR
- LONGCHAR EXTENT
- RAW
- RAW EXTENT
- RECID
- RECID EXTENT
- ROWID
- ROWID EXTENT
- Progress.Json.ObjectModel.JsonArray
- Progress.Json.ObjectModel.JsonObject
- ENUM
- Consultingwerk.Enum
- Consultingwerk.JsonSerializable
- Consultingwerk.Framework.Base.IEnumerable

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

PROTECTED AddSerializableProperties (Class)
Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the given class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes: Adds properties of the following types, does not add properties of
the base classes, adds only PUBLIC properties:
- CHARACTER
- CHARACTER EXTENT
- DATE
- DATE EXTENT
- DATETIME
- DATETIME EXTENT
- DATETIME-TZ
- DATETIME-TZ EXTENT
- DECIMAL
- DECIMAL EXTENT
- INT64
- INT64 EXTENT
- INTEGER
- INTEGER EXTENT
- LOGICAL
- LOGICAL EXTENT
- LONGCHAR
- LONGCHAR EXTENT
- RAW
- RAW EXTENT
- RECID
- RECID EXTENT
- ROWID
- ROWID EXTENT
- Progress.Json.ObjectModel.JsonArray
- Progress.Json.ObjectModel.JsonObject
- ENUM
- Consultingwerk.Enum
- Consultingwerk.Framework.Base.IEnumerable
- Consultingwerk.JsonSerializable

Parameters:
poClass Progress.Lang.Class
The declaring class
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)
Inherited from Consultingwerk.OERA.FetchDataRequest
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 ToTempTable (table)
Inherited from Consultingwerk.OERA.FetchDataRequest
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 FetchDataAccessRequest ()
Purpose: Constructor for the FetchDataRequest class
Notes:

Top

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

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

PUBLIC FetchDataAccessRequest (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 FetchDataAccessRequest (character, character, character, integer, character)
Purpose: 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 FetchDataAccessRequest (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 FetchDataAccessRequest (character, character, integer, character)
Purpose: 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 FetchDataAccessRequest (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 FetchDataAccessRequest (ISerializable)
Purpose: Constructor for the FetchDataRequest class
Notes:

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

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

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

PUBLIC FetchDataAccessRequest (IFetchDataRequest)
Purpose: Constructor for the FetchDataRequest class
Notes: Copies property values from a given IFetchDataRequest instance

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The source FetchDataRequest instance to copy the values from


Property Detail
Top

PUBLIC CHARACTER AllTables
Inherited from Consultingwerk.OERA.FetchDataRequest

Returns CHARACTER
Top

PUBLIC LOGICAL AppendFetchData

Returns LOGICAL
Top

PUBLIC CHARACTER Context
Inherited from Consultingwerk.OERA.FetchDataRequest

Returns CHARACTER
Top

PUBLIC CHARACTER CustomContext
Inherited from Consultingwerk.OERA.FetchDataRequest

Returns CHARACTER
Top

PUBLIC Progress.Lang.Object CustomParameter
Inherited from Consultingwerk.OERA.FetchDataRequest

Returns Progress.Lang.Object
Top

PUBLIC CHARACTER FillMode

Returns CHARACTER
Top

PUBLIC CHARACTER Joins
Inherited from Consultingwerk.OERA.FetchDataRequest

Returns CHARACTER
Top

PUBLIC IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable

Returns IJsonDateTypeFormatter
Top

PUBLIC Consultingwerk.OERA.INamedQueryParameter NamedQuery
Inherited from Consultingwerk.OERA.FetchDataRequest

Returns Consultingwerk.OERA.INamedQueryParameter
Top

PUBLIC CHARACTER NextContext
Inherited from Consultingwerk.OERA.FetchDataRequest

Returns CHARACTER
Top

PUBLIC INTEGER NumRecords
Inherited from Consultingwerk.OERA.FetchDataRequest

Returns INTEGER
Top

PUBLIC CHARACTER Positions
Inherited from Consultingwerk.OERA.FetchDataRequest

Returns CHARACTER
Top

PUBLIC CHARACTER PrevContext
Inherited from Consultingwerk.OERA.FetchDataRequest

Returns CHARACTER
Top

PUBLIC CHARACTER Queries
Inherited from Consultingwerk.OERA.FetchDataRequest

Returns CHARACTER
Top

PUBLIC Consultingwerk.IQueryExpression QueryExpression
Inherited from Consultingwerk.OERA.FetchDataRequest

Returns Consultingwerk.IQueryExpression
Top

PUBLIC CHARACTER Requests
Inherited from Consultingwerk.OERA.FetchDataRequest

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
Inherited from Consultingwerk.OERA.FetchDataRequest

Returns INTEGER
Top

PUBLIC INTEGER StopAfter
Inherited from Consultingwerk.OERA.FetchDataRequest

Returns INTEGER
Top

PUBLIC CHARACTER Tables
Inherited from Consultingwerk.OERA.FetchDataRequest

Returns CHARACTER
Top

PUBLIC LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL


©2006-2019 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.08.2019 23:28:39