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

Inherits: Consultingwerk.XmlSerializable
Implements: Consultingwerk.OERA.IFetchDataBySkip, Consultingwerk.OERA.IFetchDataRequest, Consultingwerk.ISerializable
Inherited by: Consultingwerk.OERA.FetchDataAccessRequest, 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



Top Method Summary
Options Name Purpose
# AddSerializableProperties (character) Add a list of Serializable Properties to the SerializableProperties property
Inherited from Consultingwerk.XmlSerializable
+ Deserialize (longchar) Initializes the object instance based on the passed in LONGCHAR representation of the object instance
Inherited from Consultingwerk.XmlSerializable
+ DeserializeFromNode (handle) Deserializes the object instance based on the passed in X-NODEREF instance
Inherited from Consultingwerk.XmlSerializable
# DeserializeProperty (handle, character, character) Deserializes a single property value to the current Object
Inherited from Consultingwerk.XmlSerializable
+ Consultingwerk.OERA.FetchDataRequest FromTempTable (table) Deserializes a FetchDataRequest object from the first eFetchDataRequest record.
# CHARACTER GetCharacterProperty (character) Returns a value from a CHARACTER property in the property store
Inherited from Consultingwerk.XmlSerializable
# DATE GetDateProperty (character) Returns a value from a DATE property in the property store
Inherited from Consultingwerk.XmlSerializable
# DATETIME-TZ GetDateTime-TZProperty (character) Returns a value from a DATETIME-TZ property in the property store
Inherited from Consultingwerk.XmlSerializable
# DATETIME GetDateTimeProperty (character) Returns a value from a DATETIME property in the property store
Inherited from Consultingwerk.XmlSerializable
# DECIMAL GetDecimalProperty (character) Returns a value from a DECIMAL property in the property store
Inherited from Consultingwerk.XmlSerializable
# INT64 GetInt64Property (character) Returns a value from a INTEGER property in the property store
Inherited from Consultingwerk.XmlSerializable
# INTEGER GetIntegerProperty (character) Returns a value from a INTEGER property in the property store
Inherited from Consultingwerk.XmlSerializable
# LOGICAL GetLogicalProperty (character) Returns a value from a INTEGER property in the property store
Inherited from Consultingwerk.XmlSerializable
# LONGCHAR GetLongCharProperty (character) Returns a value from a LONGCHAR property in the property store
Inherited from Consultingwerk.XmlSerializable
# Progress.Lang.Object GetObjectProperty (character) Returns a value from a Progress.Lang.Object property in the property store
Inherited from Consultingwerk.XmlSerializable
# RAW GetRawProperty (character) Returns a value from a RAW property in the property store
Inherited from Consultingwerk.XmlSerializable
# CHARACTER PropertyType (character) Returns the type of a property
Inherited from Consultingwerk.XmlSerializable
+ LONGCHAR Serialize () Returns an LONGCHAR representation of the object instance
Inherited from Consultingwerk.XmlSerializable
+ HANDLE Serialize (handle) Serializes the properties of the current object instance to an existing X-NODEREF object
Inherited from Consultingwerk.XmlSerializable
+ SerializeProperties (handle) Serializes the properties of this object instance as child nodes of the given node
Inherited from Consultingwerk.XmlSerializable
# SerializeProperty (handle, character, character) Serializes a single property value to the current parent XmlNode
Inherited from Consultingwerk.XmlSerializable
# SetCharacterProperty (character, character) Assigns a CHARACTER property in the property store
Inherited from Consultingwerk.XmlSerializable
# SetDateProperty (character, date) Assigns a DATE property in the property store
Inherited from Consultingwerk.XmlSerializable
# SetDateTime-TZProperty (character, datetime-tz) Assigns a DATETIME-TZ property in the property store
Inherited from Consultingwerk.XmlSerializable
# SetDateTimeProperty (character, datetime) Assigns a DATETIME property in the property store
Inherited from Consultingwerk.XmlSerializable
# SetDecimalProperty (character, decimal) Assigns a DECIMAL property in the property store
Inherited from Consultingwerk.XmlSerializable
# SetInt64Property (character, int64) Assigns a INTEGER property in the property store
Inherited from Consultingwerk.XmlSerializable
# SetIntegerProperty (character, integer) Assigns a INTEGER property in the property store
Inherited from Consultingwerk.XmlSerializable
# SetLogicalProperty (character, logical) Assigns a LOGICAL property in the property store
Inherited from Consultingwerk.XmlSerializable
# SetLongcharProperty (character, longchar) Assigns a LOGICAL property in the property store
Inherited from Consultingwerk.XmlSerializable
# SetObjectProperty (character, Object) Assigns a Progress.Lang.Object property in the property store
Inherited from Consultingwerk.XmlSerializable
# SetRawProperty (character, raw) Assigns a RAW property in the property store
Inherited from Consultingwerk.XmlSerializable
+ ToTempTable (table) Serializes the FetchDataRequest instance to a record in the eFetchDataRequest temp-table
+ LONGCHAR WriteXml () Returns an LONGCHAR representation of the object instance
Inherited from Consultingwerk.XmlSerializable

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, integer) Simplified constructor when doing calls from custom code
+ FetchDataRequest (ISerializable) Constructor for the FetchDataRequest class
+ FetchDataRequest (NamedQueryParameter) Constructor for the FetchDataRequest class

Top Property Summary
Options Name Purpose
+ CHARACTER Context Gets/sets the Context for this request. The Context contains the information controlling the positions for the next batch
+ CHARACTER CustomContext Gets/Sets the CustomContext used for the communication with the Business Entity.
+ Consultingwerk.ISerializable CustomParameter Gets and sets the reference to the custom parameter object
+ CHARACTER Joins A chr(1) separated list of join fields for the requested tables, in the form of ForeignFields. Included in this parameter, if applicable, is the element number of the Business Entity the foreign field is contained in, relative to the current request.
+ Consultingwerk.OERA.INamedQueryParameter NamedQuery Returns the NamedQueryParameter instance of the call
+ CHARACTER NextContext Specifies the next record that was NOT returned to the client.
+ INTEGER NumRecords Specifies the batch size.
+ CHARACTER Positions A chr(1) separated list of positions for the requested tables.
+ CHARACTER PrevContext Specifies the prev record that was NOT returned to the client.
+ CHARACTER Queries A chr(1) separated list of queries that corresponds to the requested tables. An empty entry means use default query.
+ Consultingwerk.IQueryExpression QueryExpression Gets/sets the QueryExpression for this request
+ CHARACTER Requests Specifies the actual request that corresponds to the table in a chr(1) delimited list.
+ LOGICAL SerializeEmptyLists Gets and sets if during serialization empty lists (properties of type Consultingwerk.Framework.Base.IEnumerable) that do not contain any elements, will be serialized
Inherited from Consultingwerk.XmlSerializable
+ LOGICAL SerializeNullValues Gets and sets if Null-Values should be serialized
Inherited from Consultingwerk.XmlSerializable
+ INTEGER Skip Gets and sets the number of records to be skipped from the beginning when reading data
+ INTEGER StopAfter Value for StopAfter to be passed to the Service Interface
+ CHARACTER Tables Tables for which to retrieve data or definitions, specified as a comma separated list. The names must match the physical name of the temp-table definitions of the prodataset that corresponds to the Business Entity.
+ LOGICAL UseSerializedTypeInformation Determines if the Serialization Routine will read and write the SerializedType attribute
Inherited from Consultingwerk.XmlSerializable


Method Detail
Top

PROTECTED AddSerializableProperties (character)
Inherited from Consultingwerk.XmlSerializable
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.XmlSerializable
Purpose: Initializes the object instance based on the passed in LONGCHAR
representation of the object instance
Notes:

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

PUBLIC DeserializeFromNode (handle)
Inherited from Consultingwerk.XmlSerializable
Purpose: Deserializes the object instance based on the passed in X-NODEREF
instance
Notes:

Parameters:
phRootNode HANDLE
The root node with the properties for this object
Top

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

Parameters:
phPropertyNode HANDLE
reference to the source XML Node
pcProperty CHARACTER
The name of the property
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 TABLE
INPUT TABLE with fields to use for this-objects properties
Returns Consultingwerk.OERA.FetchDataRequest
The deserialized FetchDataRequest instance
Top

PROTECTED CHARACTER GetCharacterProperty (character)
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns a value from a CHARACTER property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
Returns CHARACTER
The property value
Top

PROTECTED DATE GetDateProperty (character)
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns a value from a DATE property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
Returns DATE
The property value
Top

PROTECTED DATETIME-TZ GetDateTime-TZProperty (character)
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns a value from a DATETIME-TZ property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
Returns DATETIME-TZ
The property value
Top

PROTECTED DATETIME GetDateTimeProperty (character)
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns a value from a DATETIME property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
Returns DATETIME
The property value
Top

PROTECTED DECIMAL GetDecimalProperty (character)
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns a value from a DECIMAL property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
Returns DECIMAL
The property value
Top

PROTECTED INT64 GetInt64Property (character)
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns a value from a INTEGER property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
Returns INT64
The property value
Top

PROTECTED INTEGER GetIntegerProperty (character)
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns a value from a INTEGER property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
Returns INTEGER
The property value
Top

PROTECTED LOGICAL GetLogicalProperty (character)
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns a value from a INTEGER property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
Returns LOGICAL
The property value
Top

PROTECTED LONGCHAR GetLongCharProperty (character)
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns a value from a LONGCHAR property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
Returns LONGCHAR
The property value
Top

PROTECTED Progress.Lang.Object GetObjectProperty (character)
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns a value from a Progress.Lang.Object property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
Returns Progress.Lang.Object
The property value (object reference)
Top

PROTECTED RAW GetRawProperty (character)
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns a value from a RAW property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
Returns RAW
The property value
Top

PROTECTED CHARACTER PropertyType (character)
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns the type of a property
Notes: Throws an error, when the property is unknown

Parameters:
pcProperty CHARACTER
The name of the property
Returns CHARACTER
The type of the property
Top

PUBLIC LONGCHAR Serialize ()
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns an LONGCHAR representation of the object instance
Notes:

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PUBLIC HANDLE Serialize (handle)
Inherited from Consultingwerk.XmlSerializable
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 SerializeProperties (handle)
Inherited from Consultingwerk.XmlSerializable
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 SerializeProperty (handle, character, character)
Inherited from Consultingwerk.XmlSerializable
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
Top

PROTECTED SetCharacterProperty (character, character)
Inherited from Consultingwerk.XmlSerializable
Purpose: Assigns a CHARACTER property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
pcValue CHARACTER
The value of the objects property
Top

PROTECTED SetDateProperty (character, date)
Inherited from Consultingwerk.XmlSerializable
Purpose: Assigns a DATE property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
pdaValue DATE
The value of the objects property
Top

PROTECTED SetDateTime-TZProperty (character, datetime-tz)
Inherited from Consultingwerk.XmlSerializable
Purpose: Assigns a DATETIME-TZ property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
pdtValue DATETIME-TZ
The value of the objects property
Top

PROTECTED SetDateTimeProperty (character, datetime)
Inherited from Consultingwerk.XmlSerializable
Purpose: Assigns a DATETIME property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
pdtValue DATETIME
The value of the objects property
Top

PROTECTED SetDecimalProperty (character, decimal)
Inherited from Consultingwerk.XmlSerializable
Purpose: Assigns a DECIMAL property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
pdeValue DECIMAL
The value of the objects property
Top

PROTECTED SetInt64Property (character, int64)
Inherited from Consultingwerk.XmlSerializable
Purpose: Assigns a INTEGER property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
piValue INT64
The value of the objects property
Top

PROTECTED SetIntegerProperty (character, integer)
Inherited from Consultingwerk.XmlSerializable
Purpose: Assigns a INTEGER property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
piValue INTEGER
The value of the objects property
Top

PROTECTED SetLogicalProperty (character, logical)
Inherited from Consultingwerk.XmlSerializable
Purpose: Assigns a LOGICAL property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
plValue LOGICAL
The value of the objects property
Top

PROTECTED SetLongcharProperty (character, longchar)
Inherited from Consultingwerk.XmlSerializable
Purpose: Assigns a LOGICAL property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
plcValue LONGCHAR
The value of the objects property
Top

PROTECTED SetObjectProperty (character, Object)
Inherited from Consultingwerk.XmlSerializable
Purpose: Assigns a Progress.Lang.Object property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
poValue Progress.Lang.Object
The object reference as the value of the objects property
Top

PROTECTED SetRawProperty (character, raw)
Inherited from Consultingwerk.XmlSerializable
Purpose: Assigns a RAW property in the property store
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the objects property
prValue RAW
The value of the objects property
Top

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

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

PUBLIC LONGCHAR WriteXml ()
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns an LONGCHAR representation of the object instance
Notes: This method is a facade to the XmlSerializable:Serialize method

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data


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, 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 (NamedQueryParameter)
Purpose: Constructor for the FetchDataRequest class
Notes:

Parameters:
poNamedQuery NamedQueryParameter
The value for the NamedQuery property


Property Detail
Top

PUBLIC CHARACTER Context
Purpose: Gets/sets the Context for this request. The Context contains the
information controlling the positions for the next batch
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER CustomContext
Purpose: Gets/Sets the CustomContext used for the communication with the
Business Entity.
Notes: While the ContextString is part of the Business Entity context (and
thus mixing the Business Entity internal context with sort of custom
context the property CustomContext is 100% reserved for the use
in your own Business Entities / Data Access Objects

Returns CHARACTER
Top

PUBLIC Consultingwerk.ISerializable CustomParameter
Purpose: Gets and sets the reference to the custom parameter object
Notes: Allows assigning a custom serializable object instance as an
additional parameter to the RetrieveData/FetchData request
The object instance will be serialized both ways (from the client
to the backend and the backend to the client)

Returns Consultingwerk.ISerializable
Top

PUBLIC CHARACTER Joins
Purpose: A chr(1) separated list of join fields for the requested tables,
in the form of ForeignFields. Included in this parameter, if
applicable, is the element number of the Business Entity the
foreign field is contained in, relative to the current request.
Notes: - The join limits the query of this table to the records that are
children of the parent table as specified in a comma separated
paired list where this table's field(s) is/are the first entry
of each pair and the parent's field is/are the second entry of
each pair.
e.g. <thistable.field,othertable.field>
- Joins across Entities are specified by a third qualifier on the
parent field name that specifies the array number of the parent
Entity.
e.g. order.custnum,1.customer.custnum
In this above example the order is joined to the customer table
in the first Entity of this request.
- The ADM will set this from the prodataset relation, so the
parameter is typically not important for relationships within the
same prodataset.
- A blank entry means that the table is not to be joined in this
request.
This property is currently not supported by the SmartComponent
Library backend

Returns CHARACTER
Top

PUBLIC Consultingwerk.OERA.INamedQueryParameter NamedQuery
Purpose: Returns the NamedQueryParameter instance of the call
Notes: SCL-1018

Returns Consultingwerk.OERA.INamedQueryParameter
Top

PUBLIC CHARACTER NextContext
Purpose: Specifies the next record that was NOT returned to the client.
Notes: - The ADM only differentiates between no value and some value to
be able to know if there is more records to retrieve, but the
actual values are not used for on the client and can in
principle have any content. The use of ROWIDs as context fits
with PRODATASET attributes like START-ROWID and NEXT-ROWID, but
ROWIDS are not safe as context in progress databases where
records may get deleted. Consider using context-ids that can be
used to re-find context info stored on the server or just use the
actual logical query expression that defines the record that is
next by the use of true keys. (eg. order.ordernum = 55)
- Special values
'LAST' or blank means that the last record is included in the
request and that there is no more data on the server in a
forward direction.
- The implementer needs to fix the number of extents in this
parameter to that of the pcEntity parameter, noted above.

Returns CHARACTER
Top

PUBLIC INTEGER NumRecords
Purpose: Specifies the batch size.
Notes:

Returns INTEGER
Top

PUBLIC CHARACTER Positions
Purpose: A chr(1) separated list of positions for the requested tables.
Notes: Positions specifies how to find a single record in a table from
a child of this table where the child is used to filter or find
the parent record. This is specified as a comma separated paired
list where this table's field(s) is/are the first entry of each
pair.
e.g. <thistable.field,othertable.field>
- Positioning across Entities are specified by a third qualifier on
the parent field name that specifies the array number of the
other Entity.
e.g. salesrep.salesrep.1.order.salesrep
In this above example the salesrep is found from the order
records of the first Entity of the request.
This property is currently not supported by the SmartComponent
Library backend

Returns CHARACTER
Top

PUBLIC CHARACTER PrevContext
Purpose: Specifies the prev record that was NOT returned to the
client.
Notes: - The ADM only differentiates between no value and some value to
be able to know if there is more records to retrieve, but the
actual values are not used for on the client and can in
principle have any content. The use of ROWIDs as context fits
with PRODATASET attributes like START-ROWID and NEXT-ROWID, but
ROWIDS are not safe as context in progress databases where
records may get deleted. Consider using context-ids that can be
used to refind context info stored on the server or just use the
actual logical query expression that defines the record that is
prev.
- Special values
'FIRST' or blank means that the first record is included in the
request and that there is no more data on the server in a
backwards direction.
- The implementer needs to fix the number of extents in this
parameter to that of the pcEntity parameter, noted above.

Returns CHARACTER
Top

PUBLIC CHARACTER Queries
Purpose: A chr(1) separated list of queries that corresponds to
the requested tables. An empty entry means use default query.
Notes: Special values:
'DEFS' - no query, only defintions requested.

Returns CHARACTER
Top

PUBLIC Consultingwerk.IQueryExpression QueryExpression
Purpose: Gets/sets the QueryExpression for this request
Notes: This property is an alternative to the Queries property that contains
a Query String

Returns Consultingwerk.IQueryExpression
Top

PUBLIC CHARACTER Requests
Purpose: Specifies the actual request that corresponds to the table in
a chr(1) delimited list.
Notes: Valid values:
FIRST - Start retrieving from the first record.
NEXT - Start retrieving from the record that is the next record
from what is currently the last. The BatchContext
parameter has the information to where the next
position actually starts.
PREV - Start retrieving from the record that is the previous
record from what is currently the first. The BatchContext
parameter has the information to where the previous
position actually starts.
LAST - Start retrieve so that the last record is included in
the batch.
WHERE <query expression>
- Start retrieving on the first record that satisfies
the specified criteria.
ALL - Retrieve all records as defined by join.
Retrieve all records that are related to all parents in
this request. This corresponds to the default FILL
behavior of a prodataset parent-child relation.
This property is currently not supported by the SmartComponent
Library backend

Returns CHARACTER
Top

PUBLIC LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.XmlSerializable
Purpose: Gets and sets if during serialization empty lists (properties of type
Consultingwerk.Framework.Base.IEnumerable) that do not contain any
elements, will be serialized
Notes: Setting this to TRUE allows to restore the previous behaviour on
a case by case value

Returns LOGICAL
Top

PUBLIC LOGICAL SerializeNullValues
Inherited from Consultingwerk.XmlSerializable
Purpose: Gets and sets if Null-Values should be serialized
Notes:

Returns LOGICAL
Top

PUBLIC INTEGER Skip
Purpose: Gets and sets the number of records to be skipped from the beginning
when reading data
Notes: Required for the server side batching/paging with JSDO/Kendo UI

Returns INTEGER
Top

PUBLIC INTEGER StopAfter
Purpose: Value for StopAfter to be passed to the Service Interface
Notes: Allows limiting the execution time of queries executed on the backend
Not supported on OpenEdge 10.2B

Returns INTEGER
Top

PUBLIC CHARACTER Tables
Purpose: Tables for which to retrieve data or definitions, specified as a
comma separated list. The names must match the physical name of
the temp-table definitions of the prodataset that corresponds to
the Business Entity.
Notes: The Tables property may contain the asterix as a wild-card character
and will be expanded to valid buffer names

Returns CHARACTER
Top

PUBLIC LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.XmlSerializable
Purpose: Determines if the Serialization Routine will read and write the
SerializedType attribute
Notes:

Returns LOGICAL


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:30:05