Namespace: OpenEdge.DataAdmin.Message
Class
FetchRequest
Parent classes:
Progress.Lang.Object
OpenEdge.DataAdmin.Message.DataAdminMessage
OpenEdge.DataAdmin.Message.FetchRequest

Inherits: OpenEdge.DataAdmin.Message.DataAdminMessage
Implements: OpenEdge.DataAdmin.Message.IFetchRequest, OpenEdge.DataAdmin.Message.IFetchResponse

/* 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:Message for fetch of data
currently also used for reponse
Author(s):hdaniels
Created:Thu Sep 30 2010




Method Summary
Options Name Purpose
AssertTable (character)
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
HANDLE FindOrCreateTable (character) /** makes the protected temptable available for subclasses */
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
HANDLE GetRow (character) /** used to get existing table request data to pass to GetTableResponse or GetTableRequest caller must use the handle - the buffer is private */
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
CHARACTER GetTableKeyField (character) /* key field for single row request */
CHARACTER GetTableKeyValue (character) /* key value for single row request values are quoted in query so datatype is not important if we know the type we may just convert to the right type in static code */
LOGICAL GetTableLazy (character) /* optional so don't assertTable - just return false if not found */
CHARACTER GetTableQuery (character) /* use where-string for non top tables */
OpenEdge.DataAdmin.Message.ITableRequest GetTableRequest (character)
CHARACTER GetTableRequestType (character)
OpenEdge.DataAdmin.Message.ITableResponse GetTableResponse (character) /* currently FetchRequest also implements IFetchResponse so this is needed by both FetchResponse and FetchRequest */
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
LOGICAL HasTable (character)
CHARACTER MessageString ()
Overrides OpenEdge.DataAdmin.Message.DataAdminMessage:MessageString ()
HANDLE SerializeMessage ()
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
SetTableKeyValue (character, character, character)
SetTableLazy (character, logical)
SetTablePageRequest (character, integer)
SetTablePageRequest (character, integer, integer)
SetTableQuery (character, character) /** Set query for table */
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
SetTableRequestType (character, character)
SetTableTotal (character, integer) /** Set total (response after fill) */
CHARACTER ToString ()
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage

Constructor Summary
Options Name Purpose
FetchRequest (character, character, handle, log) /* end constructor. */
FetchRequest (character, handle, handle) /** serialize over TT handle */
FetchRequest (handle)

Property Summary
Options Name Purpose
CHARACTER ContextId
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
HANDLE DataHandle
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
CHARACTER EntityName
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
LOGICAL IsPageRequest
CHARACTER SerializeName
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
CHARACTER Url
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
LOGICAL UseReplaceOnClient


Method Detail
Top

PROTECTED AssertTable (character)
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
Parameters:
pcTable CHARACTER
Top

PROTECTED HANDLE FindOrCreateTable (character)
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
Purpose: makes the protected temptable available for subclasses
Parameters:
pcTable CHARACTER
Returns HANDLE
Top

PROTECTED HANDLE GetRow (character)
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
Purpose: used to get existing table request data to pass to GetTableResponse or GetTableRequest
caller must use the handle - the buffer is private
Parameters:
pcTable CHARACTER
Returns HANDLE
Top

PUBLIC CHARACTER GetTableKeyField (character)
/* key field for single row request
Parameters:
pcTable CHARACTER
Returns CHARACTER
Top

PUBLIC CHARACTER GetTableKeyValue (character)
/* key value for single row request
values are quoted in query so datatype is not important
if we know the type we may just convert to the right type
in static code
Parameters:
pcTable CHARACTER
Returns CHARACTER
Top

PUBLIC LOGICAL GetTableLazy (character)
/* optional so don't assertTable - just return false if not found
Parameters:
pcTable CHARACTER
Returns LOGICAL
Top

PUBLIC CHARACTER GetTableQuery (character)
/* use where-string for non top tables
Parameters:
pcTable CHARACTER
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.Message.ITableRequest GetTableRequest (character)
Parameters:
pcName CHARACTER
Returns OpenEdge.DataAdmin.Message.ITableRequest
Top

PUBLIC CHARACTER GetTableRequestType (character)
Parameters:
pcTable CHARACTER
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.Message.ITableResponse GetTableResponse (character)
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
/* currently FetchRequest also implements IFetchResponse so this is needed by
both FetchResponse and FetchRequest
Parameters:
pcName CHARACTER
Returns OpenEdge.DataAdmin.Message.ITableResponse
Top

PUBLIC LOGICAL HasTable (character)
Parameters:
pcTable CHARACTER
Returns LOGICAL
Top

PROTECTED CHARACTER MessageString ()
Overrides OpenEdge.DataAdmin.Message.DataAdminMessage:MessageString ()
Returns CHARACTER
Top

PUBLIC HANDLE SerializeMessage ()
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
Returns HANDLE
Top

PUBLIC SetTableKeyValue (character, character, character)
Parameters:
pcTable CHARACTER
pcField CHARACTER
pcValue CHARACTER
Top

PUBLIC SetTableLazy (character, logical)
Parameters:
pcTable CHARACTER
pLazy LOGICAL
Top

PUBLIC SetTablePageRequest (character, integer)
Parameters:
pcTable CHARACTER
pisize INTEGER
Top

PUBLIC SetTablePageRequest (character, integer, integer)
Parameters:
pcTable CHARACTER
pisize INTEGER
pistart INTEGER
Top

PUBLIC SetTableQuery (character, character)
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
Purpose: Set query for table
Parameters:
pcTable CHARACTER
pcQuery CHARACTER
Top

PUBLIC SetTableRequestType (character, character)
Parameters:
pcTable CHARACTER
pcType CHARACTER
Top

PUBLIC SetTableTotal (character, integer)
Purpose: Set total (response after fill)
Parameters:
pcTable CHARACTER
piTotal INTEGER
Top

PUBLIC CHARACTER ToString ()
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
Returns CHARACTER


Constructor Detail
Top

PUBLIC FetchRequest (character, character, handle, log)
/* end constructor.
Parameters:
name CHARACTER
ctnxtid CHARACTER
h HANDLE
lkeep LOGICAL
Top

PUBLIC FetchRequest (character, handle, handle)
Purpose: serialize over TT handle
Parameters:
name CHARACTER
hds HANDLE
hMsgTbl HANDLE
Top

PUBLIC FetchRequest (handle)
Parameters:
h HANDLE


Property Detail
Top

PUBLIC CHARACTER ContextId
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
Returns CHARACTER
Top

PUBLIC HANDLE DataHandle
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
Returns HANDLE
Top

PUBLIC CHARACTER EntityName
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
Returns CHARACTER
Top

PUBLIC LOGICAL IsPageRequest
Returns LOGICAL
Top

PUBLIC CHARACTER SerializeName
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
Returns CHARACTER
Top

PUBLIC CHARACTER Url
Inherited from OpenEdge.DataAdmin.Message.DataAdminMessage
Returns CHARACTER
Top

PUBLIC LOGICAL UseReplaceOnClient
Returns LOGICAL


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0