OpenEdge ABL API Reference

OpenEdge.DataAdmin.Message.FetchRequest

Save PDF

Table of Contents

OpenEdge.DataAdmin.Message.FetchRequest

Save PDF

Last Updated: January 15, 2026
2 minute read

OpenEdge
Documentation

Namespace:

OpenEdge.DataAdmin.Message

Type: 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
		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)
		LOGICAL HasTable (character)
		CHARACTER MessageString ()
		SetTableKeyValue (character, character, character)
		SetTableLazy (character, logical)
		SetTablePageRequest (character, integer)
		SetTablePageRequest (character, integer, integer)
		SetTableRequestType (character, character)
		SetTableTotal (character, integer)	/** Set total (response after fill) */

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
		LOGICAL IsPageRequest
		LOGICAL UseReplaceOnClient

Method Detail

Top

CHARACTER GetTableKeyField (character)

/* key field for single row request

Parameters:
pcTable	CHARACTER

Returns	CHARACTER

Top

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

LOGICAL GetTableLazy (character)

/* optional so don't assertTable - just return false if not found

Parameters:
pcTable	CHARACTER

Returns	LOGICAL

Top

CHARACTER GetTableQuery (character)

/* use where-string for non top tables

Parameters:
pcTable	CHARACTER

Returns	CHARACTER

Top

OpenEdge.DataAdmin.Message.ITableRequest GetTableRequest (character)

Parameters:
pcName	CHARACTER

Returns	OpenEdge.DataAdmin.Message.ITableRequest

Top

CHARACTER GetTableRequestType (character)

Parameters:
pcTable	CHARACTER

Returns	CHARACTER

Top

LOGICAL HasTable (character)

Parameters:
pcTable	CHARACTER

Returns	LOGICAL

Top

CHARACTER MessageString ()

Returns	CHARACTER

Top

SetTableKeyValue (character, character, character)

Parameters:
pcTable	CHARACTER

pcField	CHARACTER

pcValue	CHARACTER

Top

SetTableLazy (character, logical)

Parameters:
pcTable	CHARACTER

pLazy	LOGICAL

Top

SetTablePageRequest (character, integer)

Parameters:
pcTable	CHARACTER

pisize	INTEGER

Top

SetTablePageRequest (character, integer, integer)

Parameters:
pcTable	CHARACTER

pisize	INTEGER

pistart	INTEGER

Top

SetTableRequestType (character, character)

Parameters:
pcTable	CHARACTER

pcType	CHARACTER

Top

SetTableTotal (character, integer)

Purpose: Set total (response after fill)

Parameters:
pcTable	CHARACTER

piTotal	INTEGER

Constructor Detail

Top

FetchRequest (character, character, handle, log)

/* end constructor.

Parameters:
name	CHARACTER

ctnxtid	CHARACTER

h	HANDLE

lkeep	LOGICAL

Top

FetchRequest (character, handle, handle)

Purpose: serialize over TT handle

Parameters:
name	CHARACTER

hds	HANDLE

hMsgTbl	HANDLE

Top

FetchRequest (handle)

Parameters:
h	HANDLE

Property Detail

Top

LOGICAL IsPageRequest

Returns	LOGICAL

Top

LOGICAL UseReplaceOnClient

Returns	LOGICAL