Namespace: OpenEdge.DataAdmin.Rest
Interface
IRestRequest
Parent classes:
Inherits: OpenEdge.DataAdmin.Rest.IRestRequestFileInfo

/* Copyright (c) 2012 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.
File:IRestRequest
Purpose:Connection and file info and rest info for rest request
Author(s):hdaniels
Created:Thu Mar 15 13:27:26 EDT 2012




Method Summary
Options Name Purpose
OpenEdge.DataAdmin.Rest.IPageRequest GetPageRequest () /** returns an optional pagerequest (Based on url query properties) */
CHARACTER GetQueryValue (character) /** returns the value of a Url Query property */
Validate () /** validate data/properties */

Property Summary
Options Name Purpose
CHARACTER CollectionName /** rest collections - NumLevels extents */
CHARACTER ConnectionName /** connection name - logical name db */
CHARACTER ConnectionUrl /** connection url - the part before the rest request */
CHARACTER KeyValue /** rest key values - NumLevels extents */
INTEGER NumLevels /** num rest levels */
CHARACTER Query /** query of url */
CHARACTER RequestUrl
INTEGER StartEntry /** the slash entry position of the the first collection in the URL */


Method Detail
Top

OpenEdge.DataAdmin.Rest.IPageRequest GetPageRequest ()
Purpose: returns an optional pagerequest (Based on url query properties)
Returns OpenEdge.DataAdmin.Rest.IPageRequest
Top

CHARACTER GetQueryValue (character)
Purpose: returns the value of a Url Query property
Parameters:
pcQuery CHARACTER
Returns CHARACTER
Top

Validate ()
Purpose: validate data/properties


Property Detail
Top

CHARACTER CollectionName
Purpose: rest collections - NumLevels extents
Returns CHARACTER
Top

CHARACTER ConnectionName
Purpose: connection name - logical name db
Returns CHARACTER
Top

CHARACTER ConnectionUrl
Purpose: connection url - the part before the rest request
Returns CHARACTER
Top

CHARACTER KeyValue
Purpose: rest key values - NumLevels extents
Returns CHARACTER
Top

INTEGER NumLevels
Purpose: num rest levels
Returns INTEGER
Top

CHARACTER Query
Purpose: query of url
Returns CHARACTER
Top

CHARACTER RequestUrl
Returns CHARACTER
Top

INTEGER StartEntry
Purpose: the slash entry position of the the first collection in the URL
Returns INTEGER


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7