Namespace: OpenEdge.DataAdmin
Interface
ISchemaPartitionMap
Parent classes:
Inherits: OpenEdge.DataAdmin.IDataAdminCollection

/* 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:SchemaElement partitions mapped to Tenants or Groups
Author(s):hdaniels
Created:Aug 2010




Method Summary
Options Name Purpose
LOGICAL AllocateGroups () /** Allocate all delayed partitions for all tenantgroup Does not allocate partitions belonging to a tenantgroup @return true if any partition was allocated */
LOGICAL AllocateGroups (character) /** Allocate tenantgroup partitions for the parent schema elelement @param AllocationState Specify state of partitions to allocate - All, Delayed or None @return true if any partition was allocated @throw IllegalArgumentError if not valid AllocationState */
LOGICAL AllocateTenants () /** Allocate all delayed partitions for all tenants Does not allocate partitions belonging to a tenantgroup @return true if any partition was allocated */
LOGICAL AllocateTenants (character) /** Allocate tenant partitions for the parent schema elelement Does not allocate partitions belonging to a tenantgroup @param AllocationState Specify state of partitions to allocate - All, Delayed or None @return true if any partition was allocated @throw IllegalArgumentError if not valid AllocationState */
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 */
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
LOGICAL CanAttach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
LOGICAL ContainsKey (ITenant)
LOGICAL ContainsKey (ITenantGroup)
LOGICAL ContainsValue (IPartition)
INTEGER Deserialize (handle) /* deserialize from stream abl standard import format @return num rows imported */
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
INTEGER Deserialize (handle, integer)
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Export ()
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Export (character)
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
ExportAsProcedure (character)
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
ExportAsProcedure (character, character)
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
ExportLastSaved (character) /** REST/JSON communication, use after import and call to service create or update */
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
ExportLastSavedTree (character) /** REST/JSON communication, use after importTree and call to service create or update */
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
ExportList ()
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
ExportList (character)
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
ExportTree (character)
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
ExportTree (character, character)
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
ExportTree (character, IPageRequest)
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
OpenEdge.DataAdmin.IPartition FindGroup (character)
OpenEdge.DataAdmin.IPartition FindTenant (character)
OpenEdge.DataAdmin.IPartition Get (IDataAdminElement)
OpenEdge.DataAdmin.IPartition Get (ITenant)
OpenEdge.DataAdmin.IPartition Get (ITenantGroup)
JSONObject GetJSONExport (IContextTree) /* optional call back from context tree. return json to export instead of dataset return unknown to use standard dataset. write-json */
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
Import (character) /* import table from file - json - d */
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
ImportDelete (character) /* import keys to delete from file - json only */
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
ImportNew (character) /* import new rows to table from file - json - d */
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
ImportNewTree (character) /* import new rows with children from file - json */
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
ImportTree (character) /* import table with children from file - json */
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
IIterator Iterator (character) /** returns a filtered and/or sorted iterator @param filter query expression on properties of the entities in the collection field expressions <b>must</b> be separated by space (also =) values <b>must</b> be quoted. also int, logical dec */
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Reset ()
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
INTEGER Serialize (handle) /* serialize to stream abl standard export format return num rows exported */
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
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 */
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
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 */
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable

Property Summary
Options Name Purpose
CHARACTER CodeExtension
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
CHARACTER ContextId
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
LOGICAL HasChanges
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
IRequestInfo RequestInfo
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
CHARACTER SerializeName
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
IDataAdminService Service
Inherited from OpenEdge.DataAdmin.IDataAdminCollection
CHARACTER SourceId
Inherited from OpenEdge.DataAdmin.IDataAdminCollection


Method Detail
Top

PUBLIC LOGICAL AllocateGroups ()

Purpose: Allocate all delayed partitions for all tenantgroup
Does not allocate partitions belonging to a tenantgroup
Returns LOGICAL
true if any partition was allocated
Top

PUBLIC LOGICAL AllocateGroups (character)

Purpose: Allocate tenantgroup partitions for the parent schema elelement
@throw IllegalArgumentError if not valid AllocationState
Parameters:
pcAllocationState CHARACTER
Returns LOGICAL
true if any partition was allocated
Top

PUBLIC LOGICAL AllocateTenants ()

Purpose: Allocate all delayed partitions for all tenants
Does not allocate partitions belonging to a tenantgroup
Returns LOGICAL
true if any partition was allocated
Top

PUBLIC LOGICAL AllocateTenants (character)

Purpose: Allocate tenant partitions for the parent schema elelement
Does not allocate partitions belonging to a tenantgroup
@throw IllegalArgumentError if not valid AllocationState
Parameters:
pcAllocationState CHARACTER
Returns LOGICAL
true if any partition was allocated
Top

PUBLIC Attach (IDataAdminContext)

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

PUBLIC LOGICAL CanAttach (IDataAdminContext)

Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
Parameters:
context IDataAdminContext
Returns LOGICAL
Top

PUBLIC LOGICAL ContainsKey (ITenant)

Parameters:
ptenant OpenEdge.DataAdmin.ITenant
Returns LOGICAL
Top

PUBLIC LOGICAL ContainsKey (ITenantGroup)

Parameters:
pgroup OpenEdge.DataAdmin.ITenantGroup
Returns LOGICAL
Top

PUBLIC LOGICAL ContainsValue (IPartition)

Parameters:
partition OpenEdge.DataAdmin.IPartition
Returns LOGICAL
Top

PUBLIC INTEGER Deserialize (handle)

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
/* deserialize from stream abl standard import format
Parameters:
phStream HANDLE
Returns INTEGER
num rows imported
Top

PUBLIC INTEGER Deserialize (handle, integer)

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Parameters:
phStream HANDLE
piMax INTEGER
Returns INTEGER
Top

PUBLIC Export ()

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Top

PUBLIC Export (character)

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

PUBLIC ExportAsProcedure (character)

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

PUBLIC ExportAsProcedure (character, character)

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

PUBLIC ExportLastSaved (character)

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Purpose: REST/JSON communication, use after import and call to service create or update
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportLastSavedTree (character)

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Purpose: REST/JSON communication, use after importTree and call to service create or update
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportList ()

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Top

PUBLIC ExportList (character)

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

PUBLIC ExportTree (character)

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Parameters:
cFile CHARACTER
Top

PUBLIC ExportTree (character, character)

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Parameters:
cFile CHARACTER
pcCollections CHARACTER
Top

PUBLIC ExportTree (character, IPageRequest)

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Parameters:
cFile CHARACTER
pageReq IPageRequest
Top

PUBLIC OpenEdge.DataAdmin.IPartition FindGroup (character)

Parameters:
name CHARACTER
Returns OpenEdge.DataAdmin.IPartition
Top

PUBLIC OpenEdge.DataAdmin.IPartition FindTenant (character)

Parameters:
name CHARACTER
Returns OpenEdge.DataAdmin.IPartition
Top

PUBLIC OpenEdge.DataAdmin.IPartition Get (IDataAdminElement)

Parameters:
elm OpenEdge.DataAdmin.IDataAdminElement
Returns OpenEdge.DataAdmin.IPartition
Top

PUBLIC OpenEdge.DataAdmin.IPartition Get (ITenant)

Parameters:
tenant OpenEdge.DataAdmin.ITenant
Returns OpenEdge.DataAdmin.IPartition
Top

PUBLIC OpenEdge.DataAdmin.IPartition Get (ITenantGroup)

Parameters:
pgroup OpenEdge.DataAdmin.ITenantGroup
Returns OpenEdge.DataAdmin.IPartition
Top

PUBLIC JSONObject GetJSONExport (IContextTree)

Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
/* optional call back from context tree.
return json to export instead of dataset
return unknown to use standard dataset. write-json
Parameters:
tree IContextTree
Returns JSONObject
Top

PUBLIC Import (character)

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
/* import table from file - json - d
Parameters:
pcFile CHARACTER
Top

PUBLIC ImportDelete (character)

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
/* import keys to delete from file - json only
Parameters:
pcFile CHARACTER
Top

PUBLIC ImportNew (character)

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
/* import new rows to table from file - json - d
Parameters:
pcFile CHARACTER
Top

PUBLIC ImportNewTree (character)

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
/* import new rows with children from file - json
Parameters:
pcFile CHARACTER
Top

PUBLIC ImportTree (character)

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
/* import table with children from file - json
Parameters:
pcFile CHARACTER
Top

PUBLIC IIterator Iterator (character)

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Purpose: returns a filtered and/or sorted iterator
field expressions <b>must</b> be separated by space (also =)
values <b>must</b> be quoted. also int, logical dec
Parameters:
filter CHARACTER
Returns IIterator
Top

PUBLIC Reset ()

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Top

PUBLIC INTEGER Serialize (handle)

Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
/* serialize to stream abl standard export format
return num rows exported
Parameters:
phStream HANDLE
Returns INTEGER
Top

PUBLIC WriteTree (IContextTree)

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

PUBLIC WriteTree (IContextTree, character)

Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
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 IContextTree
the IContextTree to add the object to
pcCollections CHARACTER


Property Detail
Top

PUBLIC CHARACTER CodeExtension

Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
Returns CHARACTER
Top

PUBLIC CHARACTER ContextId

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Returns CHARACTER
Top

PUBLIC LOGICAL HasChanges

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Returns LOGICAL
Top

PUBLIC IRequestInfo RequestInfo

Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
Returns IRequestInfo
Top

PUBLIC CHARACTER SerializeName

Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
Returns CHARACTER
Top

PUBLIC IDataAdminService Service

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Returns IDataAdminService
Top

PUBLIC CHARACTER SourceId

Inherited from OpenEdge.DataAdmin.IDataAdminCollection
Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0