Namespace: OpenEdge.DataAdmin.Message
Type: Class DataAdminMessage
Parent Classes:
Progress.Lang.Object
OpenEdge.DataAdmin.Message.DataAdminMessage

Inherits: Progress.Lang.Object
Implements: OpenEdge.DataAdmin.Message.IDataAdminMessage

/* 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:Thu Sep 30 2010
Notes:This class currently has methods required by
subinterfaces (since the TT is defined here)
/* normalize message if this is changed to
go over an appserver connection with more than one message
define temp-table ttMessage
field Entity as char
field SerializeName as char
field Contextid as char
index idxMsg as primary unique entity.



Method Summary
  Options Name Purpose
  AssertTable (character)
  HANDLE FindOrCreateTable (character) /** makes the protected temptable available for subclasses */
  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 */
  OpenEdge.DataAdmin.Message.ITableResponse GetTableResponse (character) /* currently FetchRequest also implements IFetchResponse so this is needed by both FetchResponse and FetchRequest */
  inputMessage (table)
  CHARACTER MessageString ()
  HANDLE SerializeMessage ()
  SetTableQuery (character, character) /** Set query for table */
  CHARACTER ToString ()

Constructor Summary
  Options Name Purpose
  DataAdminMessage (character, character, handle) /* constructor public DataAdminMessage (h as handle, pcurl as char ): this-object (h). Url = pcurl. end constructor. constructor public DataAdminMessage (ctnxt as char,h as handle, pcurl as char ): this-object (h,pcurl). ContextId = ctnxt. end constructor. */
  DataAdminMessage (character, handle)
  DataAdminMessage (character, handle, handle)
  DataAdminMessage (handle)

Property Summary
  Options Name Purpose
  CHARACTER ContextId
  HANDLE DataHandle
  CHARACTER EntityName
  CHARACTER SerializeName
  CHARACTER Url


Method Detail
Top

AssertTable (character)

Parameters:
pcTable CHARACTER
 
Top

HANDLE FindOrCreateTable (character)

Purpose: makes the protected temptable available for subclasses
Parameters:
pcTable CHARACTER
 
Returns HANDLE
 
Top

HANDLE GetRow (character)

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

OpenEdge.DataAdmin.Message.ITableResponse GetTableResponse (character)

/* currently FetchRequest also implements IFetchResponse so this is needed by
both FetchResponse and FetchRequest
Parameters:
pcName CHARACTER
 
Returns OpenEdge.DataAdmin.Message.ITableResponse
 
Top

inputMessage (table)

Parameters:
ttTableMessage TABLE
 
Top

CHARACTER MessageString ()

Returns CHARACTER
 
Top

HANDLE SerializeMessage ()

Returns HANDLE
 
Top

SetTableQuery (character, character)

Purpose: Set query for table
Parameters:
pcTable CHARACTER
 
pcQuery CHARACTER
 
Top

CHARACTER ToString ()

Returns CHARACTER
 


Constructor Detail
Top

DataAdminMessage (character, character, handle)

/*
constructor public DataAdminMessage (h as handle, pcurl as char ):
this-object (h).
Url = pcurl.
end constructor.
constructor public DataAdminMessage (ctnxt as char,h as handle, pcurl as char ):
this-object (h,pcurl).
ContextId = ctnxt.
end constructor.
Parameters:
name CHARACTER
 
ctnxt CHARACTER
 
h HANDLE
 
Top

DataAdminMessage (character, handle)

Parameters:
name CHARACTER
 
h HANDLE
 
Top

DataAdminMessage (character, handle, handle)

Parameters:
name CHARACTER
 
hds HANDLE
 
hMsg HANDLE
 
Top

DataAdminMessage (handle)

Parameters:
h HANDLE
 


Property Detail
Top

CHARACTER ContextId

Returns CHARACTER
 
Top

HANDLE DataHandle

Returns HANDLE
 
Top

CHARACTER EntityName

Returns CHARACTER
 
Top

CHARACTER SerializeName

Returns CHARACTER
 
Top

CHARACTER Url

Returns CHARACTER