Namespace: OpenEdge.DataAdmin
Class
FieldImpl
Parent classes:
Inherits: OpenEdge.DataAdmin.AbstractSchemaElement
Implements: OpenEdge.DataAdmin.IField

/* Copyright (c) 2010-2016 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:Wed Jun 23 22:05:15 EDT 2010




Method Summary
Options Name Purpose
Attach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL CanAttach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.Binding.IDataAdminModel CreateLocalContext () /* No local context needed - currently not used to create */
Overrides OpenEdge.DataAdmin.Entity:CreateLocalContext ()
IRow CreateRowInfo ()
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL Equals (Object)
Inherited from OpenEdge.DataAdmin.Entity
Export ()
Overrides OpenEdge.DataAdmin.Entity:Export ()
Export (character)
Inherited from OpenEdge.DataAdmin.Entity
ExportAsProcedure (character)
Inherited from OpenEdge.DataAdmin.Entity
ExportAsProcedure (character, character)
Inherited from OpenEdge.DataAdmin.Entity
ExportData (character)
Inherited from OpenEdge.DataAdmin.Entity
ExportTree (character) /** override to handle collections for this */
Inherited from OpenEdge.DataAdmin.Entity
ExportTree (character, character)
Inherited from OpenEdge.DataAdmin.Entity
IDataAdminCollection GetChildCollection (character) /** use IRow to pass state and info @todo deprecate the overloads below this */
Inherited from OpenEdge.DataAdmin.Entity
IDataAdminExporter GetCodeExporter ()
Inherited from OpenEdge.DataAdmin.Entity
IDataAdminExporter GetExporter (character)
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER GetFileExtension (character)
Inherited from OpenEdge.DataAdmin.Entity
JSONObject GetJSONExport (IContextTree) /* optional call back from context tree. called when parse is complete override to return json to export instead of dataset returns unknown to use standard dataset. write-json */
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER GetKeyValue () /** @todo - deprecate - use GetKeyValues workaround due to inconsistent key definition (and property reflection) override in classes that does not use name */
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER GetKeyValues ()
Inherited from OpenEdge.DataAdmin.Entity
IDataAdminService GetLookupService ()
Inherited from OpenEdge.DataAdmin.Entity
Import (character) /* @TODO - call context:ImportRow with GetKeyValue() and remove all override */
Inherited from OpenEdge.DataAdmin.Entity
ImportTree (character)
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL NeedsRefresh () /* override to return true if first request was lazy and some fields have not been retrieved */
Inherited from OpenEdge.DataAdmin.Entity
NewContext (IDataAdminModel) /* the context we attached to changed */
Inherited from OpenEdge.DataAdmin.Entity
Refresh () /* Refresh if necessary */
Inherited from OpenEdge.DataAdmin.Entity
RowDeleted () /* the context we attached to deleted something changed */
Inherited from OpenEdge.DataAdmin.Entity
INTEGER Serialize (handle)
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL SetProperty (character, character)
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER ToString ()
Inherited from OpenEdge.DataAdmin.Entity
WriteTree (IContextTree)
Inherited from OpenEdge.DataAdmin.Entity
WriteTree (IContextTree, character)
Inherited from OpenEdge.DataAdmin.Entity

Constructor Summary
Options Name Purpose
FieldImpl (IDataAdminModel)
FieldImpl (IDataAdminModel, IRequestInfo)

Property Summary
Options Name Purpose
IArea Area
Inherited from OpenEdge.DataAdmin.AbstractSchemaElement
LOGICAL Attached
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER CodeExtension
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.Binding.IDataAdminModel Context
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER ContextId
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL Created
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER DataType
CHARACTER Description
Inherited from OpenEdge.DataAdmin.AbstractSchemaElement
Progress.Lang.error Error
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL IsLob
LOGICAL Modified
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER Name
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER NonPUBSchemaName
Inherited from OpenEdge.DataAdmin.AbstractSchemaElement
CHARACTER ObjectType
Overrides OpenEdge.DataAdmin.AbstractSchemaElement:ObjectType
ISchemaPartitionMap Partitions
Inherited from OpenEdge.DataAdmin.AbstractSchemaElement
OpenEdge.DataAdmin.IRequestInfo RequestInfo
Inherited from OpenEdge.DataAdmin.Entity
ISchema Schema
Inherited from OpenEdge.DataAdmin.AbstractSchemaElement
CHARACTER SerializeName
Inherited from OpenEdge.DataAdmin.Entity
IDataAdminService Service
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER ShortContextName
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER ShortTypeName
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.ITable Table


Method Detail
Top

PUBLIC Attach (IDataAdminContext)

Inherited from OpenEdge.DataAdmin.Entity
Parameters:
cntxt IDataAdminContext
Top

PUBLIC LOGICAL CanAttach (IDataAdminContext)

Inherited from OpenEdge.DataAdmin.Entity
Parameters:
cntxt IDataAdminContext
Returns LOGICAL
Top

PROTECTED OpenEdge.DataAdmin.Binding.IDataAdminModel CreateLocalContext ()

Overrides OpenEdge.DataAdmin.Entity:CreateLocalContext ()
/* No local context needed - currently not used to create
Returns OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PROTECTED IRow CreateRowInfo ()

Inherited from OpenEdge.DataAdmin.Entity
Returns IRow
Top

PUBLIC LOGICAL Equals (Object)

Inherited from OpenEdge.DataAdmin.Entity
Parameters:
obj Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC Export ()

Overrides OpenEdge.DataAdmin.Entity:Export ()
Top

PUBLIC Export (character)

Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportAsProcedure (character)

Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcfile CHARACTER
Top

PUBLIC ExportAsProcedure (character, character)

Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcfile CHARACTER
pcCollectionlist CHARACTER
Top

PROTECTED ExportData (character)

Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportTree (character)

Inherited from OpenEdge.DataAdmin.Entity
Purpose: override to handle collections for this
Parameters:
pcfile CHARACTER
Top

PUBLIC ExportTree (character, character)

Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcfile CHARACTER
pcCollectionlist CHARACTER
Top

PROTECTED IDataAdminCollection GetChildCollection (character)

Inherited from OpenEdge.DataAdmin.Entity
Purpose: use IRow to pass state and info
@todo deprecate the overloads below this
Parameters:
pcchild CHARACTER
Returns IDataAdminCollection
Top

PROTECTED IDataAdminExporter GetCodeExporter ()

Inherited from OpenEdge.DataAdmin.Entity
Returns IDataAdminExporter
Top

PROTECTED IDataAdminExporter GetExporter (character)

Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcFile CHARACTER
Returns IDataAdminExporter
Top

PROTECTED CHARACTER GetFileExtension (character)

Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcFile CHARACTER
Returns CHARACTER
Top

PUBLIC JSONObject GetJSONExport (IContextTree)

Inherited from OpenEdge.DataAdmin.Entity
/* optional call back from context tree.
called when parse is complete
override to return json to export instead of dataset
returns unknown to use standard dataset. write-json
Parameters:
tree IContextTree
Returns JSONObject
Top

PROTECTED CHARACTER GetKeyValue ()

Inherited from OpenEdge.DataAdmin.Entity
Purpose: @todo - deprecate - use GetKeyValues
workaround due to inconsistent key definition (and property reflection)
override in classes that does not use name
Returns CHARACTER
Top

PROTECTED CHARACTER GetKeyValues ()

Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PROTECTED IDataAdminService GetLookupService ()

Inherited from OpenEdge.DataAdmin.Entity
Returns IDataAdminService
Top

PUBLIC Import (character)

Inherited from OpenEdge.DataAdmin.Entity
/* @TODO - call context:ImportRow with GetKeyValue() and remove all override
Parameters:
cFile CHARACTER
Top

PUBLIC ImportTree (character)

Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcFile CHARACTER
Top

PROTECTED LOGICAL NeedsRefresh ()

Inherited from OpenEdge.DataAdmin.Entity
/* override to return true if first request was lazy and some fields have
not been retrieved
Returns LOGICAL
Top

PROTECTED NewContext (IDataAdminModel)

Inherited from OpenEdge.DataAdmin.Entity
/* the context we attached to changed
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PROTECTED Refresh ()

Inherited from OpenEdge.DataAdmin.Entity
/* Refresh if necessary
Top

PROTECTED RowDeleted ()

Inherited from OpenEdge.DataAdmin.Entity
/* the context we attached to deleted something changed
Top

PUBLIC INTEGER Serialize (handle)

Inherited from OpenEdge.DataAdmin.Entity
Parameters:
phHandle HANDLE
Returns INTEGER
Top

PROTECTED LOGICAL SetProperty (character, character)

Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcPropName CHARACTER
pcValue CHARACTER
Returns LOGICAL
Top

PUBLIC CHARACTER ToString ()

Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC WriteTree (IContextTree)

Inherited from OpenEdge.DataAdmin.Entity
Parameters:
tree IContextTree
Top

PUBLIC WriteTree (IContextTree, character)

Inherited from OpenEdge.DataAdmin.Entity
Parameters:
tree IContextTree
pcCollections CHARACTER


Constructor Detail
Top

PUBLIC FieldImpl (IDataAdminModel)

Purpose:
Notes:
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PUBLIC FieldImpl (IDataAdminModel, IRequestInfo)

Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
preq OpenEdge.DataAdmin.IRequestInfo


Property Detail
Top

PUBLIC IArea Area

Inherited from OpenEdge.DataAdmin.AbstractSchemaElement
Returns IArea
Top

PUBLIC LOGICAL Attached

Inherited from OpenEdge.DataAdmin.Entity
Returns LOGICAL
Top

PUBLIC CHARACTER CodeExtension

Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PROTECTED OpenEdge.DataAdmin.Binding.IDataAdminModel Context

Inherited from OpenEdge.DataAdmin.Entity
Returns OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PUBLIC CHARACTER ContextId

Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC LOGICAL Created

Inherited from OpenEdge.DataAdmin.Entity
Returns LOGICAL
Top

PUBLIC CHARACTER DataType

Returns CHARACTER
Top

PUBLIC CHARACTER Description

Inherited from OpenEdge.DataAdmin.AbstractSchemaElement
Returns CHARACTER
Top

PUBLIC Progress.Lang.error Error

Inherited from OpenEdge.DataAdmin.Entity
Returns Progress.Lang.error
Top

PUBLIC LOGICAL IsLob

Returns LOGICAL
Top

PUBLIC LOGICAL Modified

Inherited from OpenEdge.DataAdmin.Entity
Returns LOGICAL
Top

PUBLIC CHARACTER Name

Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC CHARACTER NonPUBSchemaName

Inherited from OpenEdge.DataAdmin.AbstractSchemaElement
Returns CHARACTER
Top

PUBLIC CHARACTER ObjectType

Overrides OpenEdge.DataAdmin.AbstractSchemaElement:ObjectType
Returns CHARACTER
Top

PUBLIC ISchemaPartitionMap Partitions

Inherited from OpenEdge.DataAdmin.AbstractSchemaElement
Returns ISchemaPartitionMap
Top

PUBLIC OpenEdge.DataAdmin.IRequestInfo RequestInfo

Inherited from OpenEdge.DataAdmin.Entity
Returns OpenEdge.DataAdmin.IRequestInfo
Top

PUBLIC ISchema Schema

Inherited from OpenEdge.DataAdmin.AbstractSchemaElement
Returns ISchema
Top

PUBLIC CHARACTER SerializeName

Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC IDataAdminService Service

Inherited from OpenEdge.DataAdmin.Entity
Returns IDataAdminService
Top

PROTECTED CHARACTER ShortContextName

Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PROTECTED CHARACTER ShortTypeName

Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.ITable Table

Returns OpenEdge.DataAdmin.ITable


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0