Namespace: OpenEdge.DataAdmin
Class
PartitionPolicy
Parent classes:
Progress.Lang.Object
OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.AbstractPartitionParent
OpenEdge.DataAdmin.PartitionPolicy

Inherits: OpenEdge.DataAdmin.AbstractPartitionParent
Implements: OpenEdge.DataAdmin.IPartitionPolicy

/* Copyright (c) 2013 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.
File:PartitionPolicy
Author(s):hdaniels
Created:Thu Jul 18 01:46:39 EDT 2013




Method Summary
Options Name Purpose
OpenEdge.DataAdmin.Error.UnsupportedOperationError AddDetailError (character)
LOGICAL AddDetailsFromData () /* populate Details from data */
LOGICAL AddDetailsFromData (character) /* populate Details from data using token string to assign name @param TokenString format XX${<property>}X} where X is any fixed mask char (except "$~{" or "~}" ) example "$~{TableName~}-$~{PartitionPolicyName~}-$~{Values[3]}-$~{Values[2]}". valid properties are TableName PartitionPolicyName Values[i] (i = field number) */
LOGICAL AddDetailsFromData (character, character) /* populate Details from data using substitute string and comma separated list of properties to assign name @param TokenString tokens in &n format as ABL substitute statement (max 9) @param Propertiesg comma separated list of props valid properties are TableName PartitionPolicyName Values[i] (i = field number) */
AssertLoadFromData ()
Attach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL CanAttach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.Entity
ConvertTokensToSubstitute (character, character, character)
OpenEdge.DataAdmin.Binding.IDataAdminModel CreateLocalContext ()
Overrides OpenEdge.DataAdmin.Entity:CreateLocalContext ()
IRow CreateRowInfo ()
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL Equals (Object)
Inherited from OpenEdge.DataAdmin.Entity
Export ()
Inherited from OpenEdge.DataAdmin.Entity
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) /** override to check for indexes -which will be found, but cause error when building dataset with bad join */
Overrides OpenEdge.DataAdmin.Entity:ExportTree (character, character)
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
OpenEdge.DataAdmin.IDataAdminService GetLookupService ()
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER GetValidDefaultAllocationList ()
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:GetValidDefaultAllocationList ()
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 () /* if lazy datasource none of the arename fields will have data it is sufficent to check one of them - super does not have area - default may have... */
Overrides OpenEdge.DataAdmin.Entity:NeedsRefresh ()
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
PartitionPolicy (character)
PartitionPolicy (IDataAdminModel)
PartitionPolicy (IDataAdminModel, IRequestInfo)

Property Summary
Options Name Purpose
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 DefaultAllocation
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultAllocation
OpenEdge.DataAdmin.IArea DefaultDataArea
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultDataArea
OpenEdge.DataAdmin.IArea DefaultIndexArea
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultIndexArea
OpenEdge.DataAdmin.IArea DefaultLobArea
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultLobArea
CHARACTER Description
Inherited from OpenEdge.DataAdmin.AbstractPartitionParent
OpenEdge.DataAdmin.IPartitionPolicyDetailSet Details
Progress.Lang.error Error
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.IFieldList Fields
LOGICAL HasComposite
LOGICAL HasRange
OpenEdge.DataAdmin.IIndexSet Indexes
LOGICAL IsCompositeReadOnly
LOGICAL IsReadOnly
LOGICAL Modified
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER Name
Inherited from OpenEdge.DataAdmin.Entity
INTEGER NumFields
OpenEdge.DataAdmin.Binding.PartitionPolicyContext PartitionPolicyContext
OpenEdge.DataAdmin.IRequestInfo RequestInfo
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER SerializeName
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.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
LOGICAL Type
CHARACTER ValidDefaultAllocationList
Inherited from OpenEdge.DataAdmin.AbstractPartitionParent


Method Detail
Top

PRIVATE OpenEdge.DataAdmin.Error.UnsupportedOperationError AddDetailError (character)
Parameters:
preason CHARACTER
Returns OpenEdge.DataAdmin.Error.UnsupportedOperationError
Top

PUBLIC LOGICAL AddDetailsFromData ()
/* populate Details from data
Returns LOGICAL
Top

PUBLIC LOGICAL AddDetailsFromData (character)
/* populate Details from data using token string to assign name
(except "$~{" or "~}" )
example "$~{TableName~}-$~{PartitionPolicyName~}-$~{Values[3]}-$~{Values[2]}".
valid properties are TableName PartitionPolicyName Values[i] (i = field number)
Parameters:
pcTokenString CHARACTER
Returns LOGICAL
Top

PUBLIC LOGICAL AddDetailsFromData (character, character)
/* populate Details from data using substitute string and comma separated list
of properties to assign name
valid properties are TableName PartitionPolicyName Values[i] (i = field number)
Parameters:
pcSubstituteBase CHARACTER
pcSubstituteArgs CHARACTER
Returns LOGICAL
Top

PRIVATE AssertLoadFromData ()
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

PRIVATE ConvertTokensToSubstitute (character, character, character)
Parameters:
pctemplate CHARACTER
pcresult CHARACTER
pcTokens CHARACTER
Top

PROTECTED OpenEdge.DataAdmin.Binding.IDataAdminModel CreateLocalContext ()
Overrides OpenEdge.DataAdmin.Entity:CreateLocalContext ()
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 ()
Inherited from OpenEdge.DataAdmin.Entity
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)
Overrides OpenEdge.DataAdmin.Entity:ExportTree (character, character)
Purpose: override to check for indexes -which will be found, but cause error when building dataset with bad join
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 OpenEdge.DataAdmin.Binding.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 OpenEdge.DataAdmin.IDataAdminService GetLookupService ()
Inherited from OpenEdge.DataAdmin.Entity
Returns OpenEdge.DataAdmin.IDataAdminService
Top

PROTECTED CHARACTER GetValidDefaultAllocationList ()
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:GetValidDefaultAllocationList ()
Returns CHARACTER
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 ()
Overrides OpenEdge.DataAdmin.Entity:NeedsRefresh ()
/* if lazy datasource none of the arename fields will have data
it is sufficent to check one of them - super does not have
area - default may have...
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 OpenEdge.DataAdmin.Binding.IContextTree
Top

PUBLIC WriteTree (IContextTree, character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
pcCollections CHARACTER


Constructor Detail
Top

PUBLIC PartitionPolicy (character)
Parameters:
pname CHARACTER
Top

PUBLIC PartitionPolicy (IDataAdminModel)
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PUBLIC PartitionPolicy (IDataAdminModel, IRequestInfo)
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
preq OpenEdge.DataAdmin.IRequestInfo


Property Detail
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 DefaultAllocation
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultAllocation
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.IArea DefaultDataArea
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultDataArea
Returns OpenEdge.DataAdmin.IArea
Top

PUBLIC OpenEdge.DataAdmin.IArea DefaultIndexArea
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultIndexArea
Returns OpenEdge.DataAdmin.IArea
Top

PUBLIC OpenEdge.DataAdmin.IArea DefaultLobArea
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultLobArea
Returns OpenEdge.DataAdmin.IArea
Top

PUBLIC CHARACTER Description
Inherited from OpenEdge.DataAdmin.AbstractPartitionParent
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicyDetailSet Details
Returns OpenEdge.DataAdmin.IPartitionPolicyDetailSet
Top

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

PUBLIC OpenEdge.DataAdmin.IFieldList Fields
Returns OpenEdge.DataAdmin.IFieldList
Top

PUBLIC LOGICAL HasComposite
Returns LOGICAL
Top

PUBLIC LOGICAL HasRange
Returns LOGICAL
Top

PUBLIC OpenEdge.DataAdmin.IIndexSet Indexes
Returns OpenEdge.DataAdmin.IIndexSet
Top

PUBLIC LOGICAL IsCompositeReadOnly
Returns LOGICAL
Top

PUBLIC LOGICAL IsReadOnly
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 INTEGER NumFields
Returns INTEGER
Top

PRIVATE OpenEdge.DataAdmin.Binding.PartitionPolicyContext PartitionPolicyContext
Returns OpenEdge.DataAdmin.Binding.PartitionPolicyContext
Top

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

PUBLIC CHARACTER SerializeName
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.IDataAdminService Service
Inherited from OpenEdge.DataAdmin.Entity
Returns OpenEdge.DataAdmin.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
Top

PUBLIC LOGICAL Type
Returns LOGICAL
Top

PROTECTED CHARACTER ValidDefaultAllocationList
Inherited from OpenEdge.DataAdmin.AbstractPartitionParent
Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0