Namespace: OpenEdge.DataAdmin.Binding.Query
Class
DataAdminQuery
Parent classes:
Progress.Lang.Object
OpenEdge.DataAdmin.Binding.Query.DataAdminQuery

Inherits: Progress.Lang.Object

/* Copyright (c) 2011 by progress Software Corporation.
/*
/* all rights reserved. no part of this program or document
/* may be reproduced in any form or by any means without
/* permission in writing from progress Software Corporation.
Purpose: Base query
Notes: Does not set Tables
Known subclass trees
DataSource - does not call constructor
DBQuery -> DataSource -> many
Binding.Query
AbstraQueryContext -> FilteredContext -> many
-> CreateContext
-> more




Method Summary
Options Name Purpose
HANDLE CloneQuery (handle) /* We may clone this query in order to get row keys from a result without causing the 'real' query to reposition. This may be used when performing multi-select operations in the UI, where we don't want to move off the current record. Note that these actions may be expensive, because of the cost of creating, opening, etc the query. */
CHARACTER ColumnValue (character)
CreateQuery ()
CHARACTER CurrentQuery () Return the current query for query manipulation and prepare. returns the default if not yet prepared. ------------------------------------------------------------------------------*/
CHARACTER DefaultQuery () Return the BaseQuery or build a default query. ------------------------------------------------------------------------------*/
DeleteQuery () /* delete the handles */
HANDLE GetBufferHandles ()
CHARACTER GetCurrentRowKey ()
CHARACTER GetPosition () /* order neutral position that is safe if tables changes order passed back to setPosition note that one need all rowids when the unique table is not the first */
LOGICAL Prepare ()
RemoveQueryBuffers (handle)
LOGICAL ResetQuery ()
LOGICAL SetPosition (character)
LOGICAL SetPosition (character[]) /* set position as returned from GetPosition */
LOGICAL SetPosition (rowid[]) /* set position as returned from GetPosition */
HANDLE SingleExtent (handle)
CHARACTER TrimQuery (character) /* remove for or preselect from query - duplicated in DataAdminContext - belongs in utility */

Constructor Summary
Options Name Purpose
DataAdminQuery ()
DataAdminQuery (character) /* constructor public DataAdminQuery(hBuffer as handle): this-object(hBuffer:name,SingleExtent(hBuffer)). end constructor. */

Property Summary
Options Name Purpose
CHARACTER BaseQuery
CHARACTER BaseQueryTemplate
CHARACTER BaseTableExpression
HANDLE BufferHandles
CHARACTER KeyFields
CHARACTER PhysicalTables
HANDLE QueryHandle
CHARACTER QueryLock
CHARACTER QueryMode
CHARACTER Table
CHARACTER Tables
LOGICAL UseRowid


Method Detail
Top

PROTECTED HANDLE CloneQuery (handle)
/* We may clone this query in order to get row keys from a result without
causing the 'real' query to reposition. This may be used when performing
multi-select operations in the UI, where we don't want to move off the
current record. Note that these actions may be expensive, because of the
cost of creating, opening, etc the query.
Parameters:
phSource HANDLE
Returns HANDLE
Top

PUBLIC CHARACTER ColumnValue (character)
Parameters:
pcColumn CHARACTER
Returns CHARACTER
Top

PROTECTED CreateQuery ()
Top

PROTECTED CHARACTER CurrentQuery ()
Purpose: Return the current query for query manipulation and prepare.
returns the default if not yet prepared.
Returns CHARACTER
Top

PUBLIC CHARACTER DefaultQuery ()
Purpose: Return the BaseQuery or build a default query.
Returns CHARACTER
Top

PROTECTED DeleteQuery ()
/* delete the handles
Top

PROTECTED HANDLE GetBufferHandles ()
Returns HANDLE
Top

PUBLIC CHARACTER GetCurrentRowKey ()
Returns CHARACTER
Top

PUBLIC CHARACTER GetPosition ()
/* order neutral position that is safe if tables changes order
passed back to setPosition
note that one need all rowids when the unique table is not
the first
Returns CHARACTER
Top

PUBLIC LOGICAL Prepare ()
Returns LOGICAL
Top

PROTECTED RemoveQueryBuffers (handle)
Parameters:
phQuery HANDLE
Top

PROTECTED LOGICAL ResetQuery ()
Returns LOGICAL
Top

PUBLIC LOGICAL SetPosition (character)
Parameters:
pKeyWhere CHARACTER
Returns LOGICAL
Top

PUBLIC LOGICAL SetPosition (character[])
/* set position as returned from GetPosition
Parameters:
pcPosition CHARACTER
Returns LOGICAL
Top

PUBLIC LOGICAL SetPosition (rowid[])
/* set position as returned from GetPosition
Parameters:
prPosition ROWID
Returns LOGICAL
Top

PROTECTED HANDLE SingleExtent (handle)
Parameters:
ph HANDLE
Returns HANDLE
Top

PROTECTED CHARACTER TrimQuery (character)
/* remove for or preselect from query - duplicated in DataAdminContext - belongs in utility
Parameters:
pcQuery CHARACTER
Returns CHARACTER


Constructor Detail
Top

PUBLIC DataAdminQuery ()
Top

PUBLIC DataAdminQuery (character)
/*
constructor public DataAdminQuery(hBuffer as handle):
this-object(hBuffer:name,SingleExtent(hBuffer)). name,SingleExtent(hBuffer)).
end constructor.
Parameters:
pcTable CHARACTER


Property Detail
Top

PUBLIC CHARACTER BaseQuery
Returns CHARACTER
Top

PROTECTED CHARACTER BaseQueryTemplate
Returns CHARACTER
Top

PROTECTED CHARACTER BaseTableExpression
Returns CHARACTER
Top

PRIVATE HANDLE BufferHandles
Returns HANDLE
Top

PUBLIC CHARACTER KeyFields
Returns CHARACTER
Top

PUBLIC CHARACTER PhysicalTables
Returns CHARACTER
Top

PROTECTED HANDLE QueryHandle
Returns HANDLE
Top

PROTECTED CHARACTER QueryLock
Returns CHARACTER
Top

PROTECTED CHARACTER QueryMode
Returns CHARACTER
Top

PUBLIC CHARACTER Table
Returns CHARACTER
Top

PUBLIC CHARACTER Tables
Returns CHARACTER
Top

PUBLIC LOGICAL UseRowid
Returns LOGICAL


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0