Namespace: OpenEdge.DataAdmin
Type: Interface IDataAdminSerializable
Parent Classes:
Inherits: Progress.Lang.Object

/* 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:serializable interface
Defines a common property and methods for both
entities and collections
Author(s):hdaniels
Created:Tue Aug 17 09:05:17 EDT 2010
Notes:subcinterfaces are IDataAdminEntity and IDataAdminCollection
Purpose: External name of the entity (plural - first character lowercase)
used in JSON and also as parameter in methods that defines a filter or list of collections



Method Summary
  Options Name Purpose
  Attach (IDataAdminContext) /** Attaches the object to the context/model @param context IDataAdminContext that holds the data Call cntxt:Copy(oldcontext) if IsAttached is false and context is valid */
  LOGICAL CanAttach (IDataAdminContext)
  ExportAsProcedure (character)
  ExportAsProcedure (character, character)
  Progress.Json.ObjectModel.JsonObject GetJSONExport (IContextTree) /* optional call back from context tree. return json to export instead of dataset return unknown to use standard dataset. write-json */
  INTEGER Serialize (handle) /* serialize to stream abl standard export format return num rows exported */
  WriteTree (IContextTree) /** Writetree is a visitor/serialize method that adds this object and its collections to the passed ContextTree @param tree the IContextTree to add the object to */
  WriteTree (IContextTree, character) /** Writetree is a visitor/serialize method that adds this object and the specified collections to the passed ContextTree. The context tree @param tree the IContextTree to add the object to @collections collections comma spearated list of child collections to add to the tree */

Property Summary
  Options Name Purpose
  CHARACTER CodeExtension
  OpenEdge.DataAdmin.IRequestInfo RequestInfo
  CHARACTER SerializeName


Method Detail
Top

Attach (IDataAdminContext)

Purpose: Attaches the object to the context/model
Call cntxt:Copy(oldcontext) if IsAttached is false and context is valid
Parameters:
context OpenEdge.DataAdmin.Binding.IDataAdminContext
  IDataAdminContext that holds the data
Top

LOGICAL CanAttach (IDataAdminContext)

Parameters:
context OpenEdge.DataAdmin.Binding.IDataAdminContext
 
Returns LOGICAL
 
Top

ExportAsProcedure (character)

Parameters:
pcfile CHARACTER
 
Top

ExportAsProcedure (character, character)

Parameters:
pcfile CHARACTER
 
pcCollectionlist CHARACTER
 
Top

Progress.Json.ObjectModel.JsonObject GetJSONExport (IContextTree)

/* optional call back from context tree.
return json to export instead of dataset
return unknown to use standard dataset. write-json
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
 
Returns Progress.Json.ObjectModel.JsonObject
 
Top

INTEGER Serialize (handle)

/* serialize to stream abl standard export format
return num rows exported
Parameters:
phStream HANDLE
 
Returns INTEGER
 
Top

WriteTree (IContextTree)

Purpose: Writetree is a visitor/serialize method that adds this object and its collections to the passed ContextTree
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
  the IContextTree to add the object to */
Top

WriteTree (IContextTree, character)

Purpose: Writetree is a visitor/serialize method that adds this object and the specified collections to the
passed ContextTree. The context tree
@collections collections comma spearated list of child collections to add to the tree
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
  the IContextTree to add the object to
pcCollections CHARACTER
 


Property Detail
Top

CHARACTER CodeExtension

Returns CHARACTER
 
Top

OpenEdge.DataAdmin.IRequestInfo RequestInfo

Returns OpenEdge.DataAdmin.IRequestInfo
 
Top

CHARACTER SerializeName

Returns CHARACTER