Namespace: OpenEdge.DataAdmin.Binding
Interface
IRow
Parent classes:
Inherits: OpenEdge.DataAdmin.Core.IElement

/* 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:Wrapper for passing row info in messages/events
Author(s):hdaniels
Created:Sat Oct 08 14:17:49 EDT 2011
Notes:A standard implementations are expected to be lightweight without
any object references that may prevent garbage collection.
IRequestInfo is allowed (RequestInfo property inherited from IElement),
since it should have no references whatsoever.
- Implementers will need to take care of destroying the object if
refrences are needed.




Method Summary
Options Name Purpose
CHARACTER FieldValue (character) /** Optional character value of a field, also internal fields that are defined as serialize-hidden and not accessible as properties in the corresponding IDataAdminElement, for example relation fields. Note that optional means that the method typically will throw an error in most implementations as the method only need to support fields that are needed for object communication. The FieldNames property can be used to check if a call to the method would throw an error. - Expected to throw error for references that cannot be returned. The error is typically IllegalArgument, but it could also throw UnsupportedOperation if no columns are supported or for columns that exists, but are not currently supported. Note that it may also throw IllegalArgument for this case, so implementers are not required to have info about all theoretically possible values. */

Property Summary
Options Name Purpose
CHARACTER FieldNames /** comma separated list of fields whose value is available in GetColumnValue blank means none. It is undefined and up to the implementer of an instance to decide whether the KeyFields values are available here or not. */
LOGICAL IsSnapShot /** is - true means that values are not refrehsed - use for message only don't store */
CHARACTER KeyFields /** comma separated list of keyfields */
INTEGER KeyIntValue /** returns the integer value that correspond to a single entry KeyField for this row */
CHARACTER KeyValue /** returns the value that correspond to a single entry KeyField for this row */
CHARACTER KeyValues /** returns the values that correspond to KeyFields for this row */
OpenEdge.DataAdmin.Binding.IDataAdminModel Model /** Model - to manage relations between local Model and service Model in many-to-many queries */
CHARACTER SerializeName /** serializename is used in child and parent defintitions */


Method Detail
Top

CHARACTER FieldValue (character)
Purpose: Optional character value of a field, also internal fields that are defined as
serialize-hidden and not accessible as properties in the corresponding IDataAdminElement,
for example relation fields. Note that optional means that the method typically will
throw an error in most implementations as the method only need to support fields
that are needed for object communication. The FieldNames property can be used to check
if a call to the method would throw an error.
- Expected to throw error for references that cannot be returned.
The error is typically IllegalArgument, but it could also throw UnsupportedOperation
if no columns are supported or for columns that exists, but are not currently supported.
Note that it may also throw IllegalArgument for this case, so implementers are not required to have info about all
theoretically possible values.
Parameters:
pcColumn CHARACTER
Returns CHARACTER


Property Detail
Top

CHARACTER FieldNames
Purpose: comma separated list of fields whose value is available in GetColumnValue
blank means none. It is undefined and up to the implementer of an instance to decide
whether the KeyFields values are available here or not.
Returns CHARACTER
Top

LOGICAL IsSnapShot
Purpose: is - true means that values are not refrehsed
- use for message only don't store
Returns LOGICAL
Top

CHARACTER KeyFields
Purpose: comma separated list of keyfields
Returns CHARACTER
Top

INTEGER KeyIntValue
Purpose: returns the integer value that correspond to a single entry KeyField for this row
Returns INTEGER
Top

CHARACTER KeyValue
Purpose: returns the value that correspond to a single entry KeyField for this row
Returns CHARACTER
Top

CHARACTER KeyValues
Purpose: returns the values that correspond to KeyFields for this row
Returns CHARACTER
Top

OpenEdge.DataAdmin.Binding.IDataAdminModel Model
Purpose: Model - to manage relations between local Model and service Model in many-to-many queries
Returns OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

CHARACTER SerializeName
Purpose: serializename is used in child and parent defintitions
Returns CHARACTER


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7