Namespace: Consultingwerk
Class 
QueryRowIdentifier Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.QueryRowIdentifier

Inherits: Progress.Lang.Object
Implements: Consultingwerk.IQueryRowIdentifier

File:QueryRowIdentifier
Purpose:Provides abstraction methods for query row id representation
Description:Consultingwerk default IQueryRowIdentifier implementation
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue Dec 03 15:35:20 CET 2013
Notes:Used in the Consultingwerk.OERA.DataAccess class to allow
customers extensions to the RowId context string used by the
Data Access

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ GetDataSourceNextRowids (handle) Assigns the internal storage with the restart row identifiers of the given data source object handle
+ GetQueryCurrentRowids (handle) Populates the ROWID[]with the rowids of the current Query result row
+ LOGICAL IsBaseRowidSpecified () Returns if the QueryRowIdentifier contains a valid row identifier
+ ParseString (character) Parses a CHR(5) delimited list of ROWIDs and returns an ROWID Array
+ LOGICAL QueryCurrentRowidsEquals (handle) Compares the array of the current query ROWIDs with the array of Restart ROWIDs
+ LOGICAL RepositionQuery (handle) Moves a query objects result list pointer to the row corresponding to the specified ROWID or ROWIDs. To reposition to a particular row when the query is a join, supply the ROWIDs of the buffers that correspond to the desired row.
+ SetBufferRestartRowids (handle) Sets the RESTART-ROWID for the data source buffer(s)
+ ROWID ToArray () Returns the ROWID[] representation of this instance
+ CHARACTER ToString () Returns the CHARACTER representation (serialization) of this instance


Method Detail
Top

PUBLIC GetDataSourceNextRowids (handle)
Purpose: Assigns the internal storage with the restart row identifiers of
the given data source object handle
Notes:

Parameters:
phDataSource HANDLE
The handle of the DATA-SOURCE
Top

PUBLIC GetQueryCurrentRowids (handle)
Purpose: Populates the ROWID[]with the rowids of the current Query result row
Notes:

Parameters:
phQuery HANDLE
The handle of the query
Top

PUBLIC LOGICAL IsBaseRowidSpecified ()
Purpose: Returns if the QueryRowIdentifier contains a valid row identifier
Notes: Verifies that a ROWID for the topmost buffer is available

Returns LOGICAL
Logical value indicating if the QueryRowIdentifier contains a valid row identifier
Top

PUBLIC ParseString (character)
Purpose: Parses a CHR(5) delimited list of ROWIDs and returns an ROWID Array
Notes:

Parameters:
pcRowids CHARACTER
The CHR(5) delimited list of ROWIDs
Top

PUBLIC LOGICAL QueryCurrentRowidsEquals (handle)
Purpose: Compares the array of the current query ROWIDs with the array of
Restart ROWIDs
Notes:

Parameters:
phQuery HANDLE
The Query handle
Returns LOGICAL
Logical value indicating if the two arrays are equal
Top

PUBLIC LOGICAL RepositionQuery (handle)
Purpose: Moves a query objects result list pointer to the row corresponding
to the specified ROWID or ROWIDs. To reposition to a particular row
when the query is a join, supply the ROWIDs of the buffers that
correspond to the desired row.
Notes:

Parameters:
phQuery HANDLE
The handle of the query
Returns LOGICAL
Logical value indicating if the method was successful
Top

PUBLIC SetBufferRestartRowids (handle)
Purpose: Sets the RESTART-ROWID for the data source buffer(s)
Notes:

Parameters:
phBufferHandle HANDLE
The buffer handle
Top

PUBLIC ROWID ToArray ()
Purpose: Returns the ROWID[] representation of this instance
Notes: Used for backwards compatibility only

Returns ROWID
The ROWID[] representation of this instance
Top

PUBLIC CHARACTER ToString ()
Purpose: Returns the CHARACTER representation (serialization) of this instance
Notes: The result of this method can be parsed by the method ParseString()

Returns CHARACTER
The CHARACTER representation of this instance


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