Namespace: OpenEdge.DataAdmin
Class
RequestInfo
Parent classes:
Progress.Lang.Object
OpenEdge.DataAdmin.RequestInfo

Inherits: Progress.Lang.Object
Implements: OpenEdge.DataAdmin.IRequestInfo

/* 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 2011




Method Summary
Options Name Purpose
LOGICAL Add (IRequestInfo)
LOGICAL CreateChild (character, IRequestInfo)
OpenEdge.DataAdmin.IRequestInfo Get (character)
OpenEdge.DataAdmin.IRequestInfo GetChildren () /** returns an IRequestInfo array of all child requests */
CHARACTER GetKeyValues ()
CHARACTER MergeQueries (character, character) /* merge query expressions - only one can have a sort */
LOGICAL MergeQueryExpression (character)
LOGICAL Remove (IRequestInfo)

Constructor Summary
Options Name Purpose
RequestInfo () /** default constructor */
RequestInfo (character)
RequestInfo (character, character)
RequestInfo (character, character[])
RequestInfo (character, integer)

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 KeyCharValue
CHARACTER KeyFields
INTEGER KeyIntValue
CHARACTER Name /** Name - must match property in requested class */
INTEGER PageSize /** The number of records to return per page or batch */
CHARACTER QueryString /** QueryString */
CHARACTER SearchString /** protected set - not changeable - provide with constructor */


Method Detail
Top

LOGICAL Add (IRequestInfo)
Parameters:
child OpenEdge.DataAdmin.IRequestInfo
Returns LOGICAL
Top

LOGICAL CreateChild (character, IRequestInfo)
Parameters:
pcollname CHARACTER
child OpenEdge.DataAdmin.IRequestInfo
Returns LOGICAL
Top

OpenEdge.DataAdmin.IRequestInfo Get (character)
Parameters:
pcname CHARACTER
Returns OpenEdge.DataAdmin.IRequestInfo
Top

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

CHARACTER GetKeyValues ()
Returns CHARACTER
Top

CHARACTER MergeQueries (character, character)
/* merge query expressions - only one can have a sort
Parameters:
pcQuery1 CHARACTER
pcQuery2 CHARACTER
Returns CHARACTER
Top

LOGICAL MergeQueryExpression (character)
Parameters:
pcQuery CHARACTER
Returns LOGICAL
Top

LOGICAL Remove (IRequestInfo)
Parameters:
req OpenEdge.DataAdmin.IRequestInfo
Returns LOGICAL


Constructor Detail
Top

RequestInfo ()
Purpose: default constructor
Top

RequestInfo (character)
Parameters:
pName CHARACTER
Top

RequestInfo (character, character)
Parameters:
pKey CHARACTER
pValue CHARACTER
Top

RequestInfo (character, character[])
Parameters:
pKeys CHARACTER
pkey CHARACTER
Top

RequestInfo (character, integer)
Parameters:
pKey CHARACTER
pValue INTEGER


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 KeyCharValue
Returns CHARACTER
Top

CHARACTER KeyFields
Returns CHARACTER
Top

INTEGER KeyIntValue
Returns INTEGER
Top

CHARACTER Name
Purpose: Name - must match property in requested class
Returns CHARACTER
Top

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

CHARACTER QueryString
Purpose: QueryString
Returns CHARACTER
Top

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


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7