Namespace: OpenEdge.DataAdmin.Binding.Query
Type: Class DataAdminQuery
Parent Classes:
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 ()
  CHARACTER DefaultQuery ()
  DeleteQuery ()
  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

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

CHARACTER ColumnValue (character)

Parameters:
pcColumn CHARACTER
 
Returns CHARACTER
 
Top

CreateQuery ()

Top

CHARACTER CurrentQuery ()

Returns CHARACTER
 
Top

CHARACTER DefaultQuery ()

Returns CHARACTER
 
Top

DeleteQuery ()

Top

HANDLE GetBufferHandles ()

Returns HANDLE
 
Top

CHARACTER GetCurrentRowKey ()

Returns CHARACTER
 
Top

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

LOGICAL Prepare ()

Returns LOGICAL
 
Top

RemoveQueryBuffers (handle)

Parameters:
phQuery HANDLE
 
Top

LOGICAL ResetQuery ()

Returns LOGICAL
 
Top

LOGICAL SetPosition (character)

Parameters:
pKeyWhere CHARACTER
 
Returns LOGICAL
 
Top

LOGICAL SetPosition (character[])

/* set position as returned from GetPosition
Parameters:
pcPosition CHARACTER
 
Returns LOGICAL
 
Top

LOGICAL SetPosition (rowid[])

/* set position as returned from GetPosition
Parameters:
prPosition ROWID
 
Returns LOGICAL
 
Top

HANDLE SingleExtent (handle)

Parameters:
ph HANDLE
 
Returns HANDLE
 
Top

CHARACTER TrimQuery (character)

/* remove for or preselect from query - duplicated in DataAdminContext - belongs in utility
Parameters:
pcQuery CHARACTER
 
Returns CHARACTER
 


Constructor Detail
Top

DataAdminQuery ()

Top

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

CHARACTER BaseQuery

Returns CHARACTER
 
Top

CHARACTER BaseQueryTemplate

Returns CHARACTER
 
Top

CHARACTER BaseTableExpression

Returns CHARACTER
 
Top

HANDLE BufferHandles

Returns HANDLE
 
Top

CHARACTER KeyFields

Returns CHARACTER
 
Top

CHARACTER PhysicalTables

Returns CHARACTER
 
Top

HANDLE QueryHandle

Returns HANDLE
 
Top

CHARACTER QueryLock

Returns CHARACTER
 
Top

CHARACTER QueryMode

Returns CHARACTER
 
Top

CHARACTER Table

Returns CHARACTER
 
Top

CHARACTER Tables

Returns CHARACTER
 
Top

LOGICAL UseRowid

Returns LOGICAL