Namespace: OpenEdge.DataAdmin
Interface
IRequestInfo
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.
Author(s):hdaniels
Created:Tue Jul 19 22:51:42 EDT 2011




Method Summary
Options Name Purpose
LOGICAL Add (IRequestInfo) /** add collection request @param child IRequestInfo with name set to match a collection */
OpenEdge.DataAdmin.IRequestInfo Get (character) /** get a child collection request by name @param child IRequestInfo with name set to match a collection */
OpenEdge.DataAdmin.IRequestInfo GetChildren () /** returns an array of all children */
CHARACTER GetKeyValues () /** get the key value for top level request */
LOGICAL MergeQueryExpression (character) /** add collection request @param expression to add to exisiting query string */
LOGICAL Remove (IRequestInfo) /** add collection request @param child IRequestInfo with name set to match a collection */

Property Summary
Options Name Purpose
LOGICAL IsNameChecked /** for internal use. Set to true when a named context (different name than context serializename) query has been checked and applied. The Request info is kept in both collection and entity instances and will be used multiple times to AddTreeTo or getChildWithRequestInfo */
CHARACTER KeyFields
CHARACTER Name /** protected set - not changeable - provide with constructor */
INTEGER PageSize /** The number of records to return per page or batch */
CHARACTER QueryString /** A query on properties of the collection entities */
CHARACTER SearchString


Method Detail
Top

LOGICAL Add (IRequestInfo)
Purpose: add collection request
Parameters:
child OpenEdge.DataAdmin.IRequestInfo
IRequestInfo with name set to match a collection */
Returns LOGICAL
Top

OpenEdge.DataAdmin.IRequestInfo Get (character)
Purpose: get a child collection request by name
Parameters:
name CHARACTER
Returns OpenEdge.DataAdmin.IRequestInfo
Top

OpenEdge.DataAdmin.IRequestInfo GetChildren ()
Purpose: returns an array of all children
Returns OpenEdge.DataAdmin.IRequestInfo
Top

CHARACTER GetKeyValues ()
Purpose: get the key value for top level request
Returns CHARACTER
Top

LOGICAL MergeQueryExpression (character)
Purpose: add collection request
Parameters:
pcQuery CHARACTER
Returns LOGICAL
Top

LOGICAL Remove (IRequestInfo)
Purpose: add collection request
Parameters:
child OpenEdge.DataAdmin.IRequestInfo
IRequestInfo with name set to match a collection */
Returns LOGICAL


Property Detail
Top

LOGICAL IsNameChecked
Purpose: for internal use. Set to true when a named context (different name than context serializename)
query has been checked and applied. The Request info is kept in both collection and entity instances
and will be used multiple times to AddTreeTo or getChildWithRequestInfo
Returns LOGICAL
Top

CHARACTER KeyFields
Returns CHARACTER
Top

CHARACTER Name
Purpose: protected set - not changeable - provide with constructor
Returns CHARACTER
Top

INTEGER PageSize
Purpose: The number of records to return per page or batch
Returns INTEGER
Top

CHARACTER QueryString
Purpose: A query on properties of the collection entities
Returns CHARACTER
Top

CHARACTER SearchString
Returns CHARACTER


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7