OpenEdge API Code Documentation

Namespace:

OpenEdge.DataAdmin.Support

Class

PartitionPolicyIndexSet

Parent classes:

Progress.Lang.Object

OpenEdge.DataAdmin.DataAdminCollection

OpenEdge.DataAdmin.Support.TableIndexSet

OpenEdge.DataAdmin.Support.PartitionPolicyIndexSet

Inherits:

OpenEdge.DataAdmin.Support.TableIndexSet

	/* Copyright (c) 2014 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:	PartitionPolicyIndexSet
Purpose:	Extend TableIndexSet to support add and remove
Author(s):	hdaniels
Created:	Wed Feb 26 2014

Method Summary

Options Name Purpose

LOGICAL Add (IIndex)

LOGICAL Add (Object)

Overrides OpenEdge.DataAdmin.DataAdminCollection:Add (Object)

LOGICAL AddAll (ICollection)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

LOGICAL AddAll (IDataAdminCollection)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

AssertNotNull (character, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

AssertNotNull (integer, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

AssertNotNull (Object, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Attach (IDataAdminContext)

/** * * @param context */
Inherited from OpenEdge.DataAdmin.DataAdminCollection

LOGICAL CanAttach (IDataAdminContext)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

LOGICAL CanFind (character)

Inherited from OpenEdge.DataAdmin.Support.TableIndexSet

Clear ()

Inherited from OpenEdge.DataAdmin.DataAdminCollection

LOGICAL Contains (IIndex)

Inherited from OpenEdge.DataAdmin.Support.TableIndexSet

LOGICAL Contains (Object)

/* */
Overrides OpenEdge.DataAdmin.Support.TableIndexSet:Contains (Object)

OpenEdge.DataAdmin.Binding.IDataAdminContext CreateLocalContext ()

Overrides OpenEdge.DataAdmin.Support.TableIndexSet:CreateLocalContext ()

INTEGER Deserialize (handle)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

INTEGER Deserialize (handle, integer)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

INTEGER Deserialize (handle, integer, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Export ()

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Export (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

ExportAsProcedure (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

ExportAsProcedure (character, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

ExportLastSaved (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

ExportLastSavedTree (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

ExportList ()

Inherited from OpenEdge.DataAdmin.DataAdminCollection

ExportList (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

ExportList (character, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

ExportTree (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

ExportTree (character, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

ExportTree (character, IPageRequest)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

OpenEdge.DataAdmin.IIndex Find (character)

Inherited from OpenEdge.DataAdmin.Support.TableIndexSet

IDataAdminExporter GetCodeExporter ()

Inherited from OpenEdge.DataAdmin.DataAdminCollection

IDataAdminExporter GetExporter (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

CHARACTER GetFileExtension (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

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.DataAdminCollection

Import (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

ImportDelete (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

ImportNew (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

ImportNewTree (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

ImportTree (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

IIterator Iterator ()

Inherited from OpenEdge.DataAdmin.DataAdminCollection

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 =) - can also specify a single column for sort - or a sort expression 'clustersize by recordsperblock' */
Inherited from OpenEdge.DataAdmin.DataAdminCollection

NewContext (IDataAdminContext)

/* the context we attached to changed */
Inherited from OpenEdge.DataAdmin.DataAdminCollection

PrepareExport ()

Overrides OpenEdge.DataAdmin.Support.TableIndexSet:PrepareExport ()

PrepareExportList ()

Overrides OpenEdge.DataAdmin.Support.TableIndexSet:PrepareExportList ()

PrepareExportTree ()

Overrides OpenEdge.DataAdmin.Support.TableIndexSet:PrepareExportTree ()

LOGICAL Remove (IIndex)

LOGICAL Remove (Object)

Overrides OpenEdge.DataAdmin.DataAdminCollection:Remove (Object)

Reset ()

Inherited from OpenEdge.DataAdmin.DataAdminCollection

INTEGER Serialize (handle)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

ThrowNull (character, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

WriteTree (IContextTree)

Overrides OpenEdge.DataAdmin.Support.TableIndexSet:WriteTree (IContextTree)

WriteTree (IContextTree, character)

/* write specified collections */
Inherited from OpenEdge.DataAdmin.DataAdminCollection

Constructor Summary

Options Name Purpose

PartitionPolicyIndexSet (PartitionPolicyIndexQuery)

Property Summary

Options Name Purpose

CHARACTER CodeExtension

Inherited from OpenEdge.DataAdmin.DataAdminCollection

OpenEdge.DataAdmin.Binding.IDataAdminContext Context

Inherited from OpenEdge.DataAdmin.DataAdminCollection

CHARACTER ContextId

Inherited from OpenEdge.DataAdmin.DataAdminCollection

INTEGER Count

Inherited from OpenEdge.DataAdmin.DataAdminCollection

HANDLE DatasetHandle

Inherited from OpenEdge.DataAdmin.DataAdminCollection

HANDLE DefaultBuffer

Inherited from OpenEdge.DataAdmin.DataAdminCollection

LOGICAL HasChanges

Inherited from OpenEdge.DataAdmin.DataAdminCollection

LOGICAL IsEmpty

Inherited from OpenEdge.DataAdmin.DataAdminCollection

IRequestInfo RequestInfo

Inherited from OpenEdge.DataAdmin.DataAdminCollection

CHARACTER SerializeName

Inherited from OpenEdge.DataAdmin.DataAdminCollection

IDataAdminService Service

Inherited from OpenEdge.DataAdmin.DataAdminCollection

CHARACTER SourceId

Inherited from OpenEdge.DataAdmin.DataAdminCollection

HANDLE TableHandle

Inherited from OpenEdge.DataAdmin.DataAdminCollection

CHARACTER TableName

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Method Detail

Top

PUBLIC LOGICAL Add (IIndex)

Parameters:
pidx	OpenEdge.DataAdmin.IIndex

Returns	LOGICAL

Top

PUBLIC LOGICAL Add (Object)

Overrides OpenEdge.DataAdmin.DataAdminCollection:Add (Object)

Parameters:
o	Progress.Lang.Object

Returns	LOGICAL

Top

PUBLIC LOGICAL AddAll (ICollection)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcol	ICollection

Returns	LOGICAL

Top

PROTECTED LOGICAL AddAll (IDataAdminCollection)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcol	IDataAdminCollection

Returns	LOGICAL

Top

PROTECTED AssertNotNull (character, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
c	CHARACTER

arg	CHARACTER

Top

PROTECTED AssertNotNull (integer, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
i	INTEGER

arg	CHARACTER

Top

PROTECTED AssertNotNull (Object, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
o	Progress.Lang.Object

arg	CHARACTER

Top

PUBLIC Attach (IDataAdminContext)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Purpose:

Parameters:
cntxt	OpenEdge.DataAdmin.Binding.IDataAdminContext

Top

PUBLIC LOGICAL CanAttach (IDataAdminContext)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
cntxt	OpenEdge.DataAdmin.Binding.IDataAdminContext

Returns	LOGICAL

Top

PUBLIC LOGICAL CanFind (character)

Inherited from OpenEdge.DataAdmin.Support.TableIndexSet

Parameters:
pcIndex	CHARACTER

Returns	LOGICAL

Top

PUBLIC Clear ()

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Top

PUBLIC LOGICAL Contains (IIndex)

Inherited from OpenEdge.DataAdmin.Support.TableIndexSet

Parameters:
idx	OpenEdge.DataAdmin.IIndex

Returns	LOGICAL

Top

PUBLIC LOGICAL Contains (Object)

Overrides OpenEdge.DataAdmin.Support.TableIndexSet:Contains (Object)

Parameters:
obj	Progress.Lang.Object

Returns	LOGICAL

Top

PROTECTED OpenEdge.DataAdmin.Binding.IDataAdminContext CreateLocalContext ()

Overrides OpenEdge.DataAdmin.Support.TableIndexSet:CreateLocalContext ()

Returns	OpenEdge.DataAdmin.Binding.IDataAdminContext

Top

PUBLIC INTEGER Deserialize (handle)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
phHandle	HANDLE

Returns	INTEGER

Top

PUBLIC INTEGER Deserialize (handle, integer)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
phHandle	HANDLE

piMaxRows	INTEGER

Returns	INTEGER

Top

PROTECTED INTEGER Deserialize (handle, integer, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
phHandle	HANDLE

piMaxRows	INTEGER

pcmode	CHARACTER

Returns	INTEGER

Top

PUBLIC Export ()

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Top

PUBLIC Export (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcFile	CHARACTER

Top

PUBLIC ExportAsProcedure (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcfile	CHARACTER

Top

PUBLIC ExportAsProcedure (character, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcfile	CHARACTER

pcCollectionlist	CHARACTER

Top

PUBLIC ExportLastSaved (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcFile	CHARACTER

Top

PUBLIC ExportLastSavedTree (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcFile	CHARACTER

Top

PUBLIC ExportList ()

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Top

PUBLIC ExportList (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcFile	CHARACTER

Top

PUBLIC ExportList (character, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcFile	CHARACTER

pcQuery	CHARACTER

Top

PUBLIC ExportTree (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcfile	CHARACTER

Top

PUBLIC ExportTree (character, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcfile	CHARACTER

pcCollectionlist	CHARACTER

Top

PUBLIC ExportTree (character, IPageRequest)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcfile	CHARACTER

pageReq	IPageRequest

Top

PUBLIC OpenEdge.DataAdmin.IIndex Find (character)

Inherited from OpenEdge.DataAdmin.Support.TableIndexSet

Parameters:
pcIndex	CHARACTER

Returns	OpenEdge.DataAdmin.IIndex

Top

PROTECTED IDataAdminExporter GetCodeExporter ()

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	IDataAdminExporter

Top

PROTECTED IDataAdminExporter GetExporter (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcFile	CHARACTER

Returns	IDataAdminExporter

Top

PROTECTED CHARACTER GetFileExtension (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcFile	CHARACTER

Returns	CHARACTER

Top

PUBLIC JSONObject GetJSONExport (IContextTree)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

	/* 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

PUBLIC Import (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcFile	CHARACTER

Top

PUBLIC ImportDelete (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcFile	CHARACTER

Top

PUBLIC ImportNew (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcFile	CHARACTER

Top

PUBLIC ImportNewTree (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcFile	CHARACTER

Top

PUBLIC ImportTree (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
pcFile	CHARACTER

Top

PUBLIC IIterator Iterator ()

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	IIterator

Top

PUBLIC IIterator Iterator (character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Purpose:	returns a filtered and/or sorted iterator
	field expressions <b>must</b> be separated by space (also =)
	- can also specify a single column for sort
	- or a sort expression 'clustersize by recordsperblock'

Parameters:
filter	CHARACTER

Returns	IIterator

Top

PROTECTED NewContext (IDataAdminContext)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

/* the context we attached to changed

Parameters:
cntxt	OpenEdge.DataAdmin.Binding.IDataAdminContext

Top

PROTECTED PrepareExport ()

Overrides OpenEdge.DataAdmin.Support.TableIndexSet:PrepareExport ()

Top

PROTECTED PrepareExportList ()

Overrides OpenEdge.DataAdmin.Support.TableIndexSet:PrepareExportList ()

Top

PROTECTED PrepareExportTree ()

Overrides OpenEdge.DataAdmin.Support.TableIndexSet:PrepareExportTree ()

Top

PUBLIC LOGICAL Remove (IIndex)

Parameters:
pidx	OpenEdge.DataAdmin.IIndex

Returns	LOGICAL

Top

PUBLIC LOGICAL Remove (Object)

Overrides OpenEdge.DataAdmin.DataAdminCollection:Remove (Object)

Parameters:
o	Progress.Lang.Object

Returns	LOGICAL

Top

PUBLIC Reset ()

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Top

PUBLIC INTEGER Serialize (handle)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
phHandle	HANDLE

Returns	INTEGER

Top

PROTECTED ThrowNull (character, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Parameters:
caller	CHARACTER

arg	CHARACTER

Top

PUBLIC WriteTree (IContextTree)

Overrides OpenEdge.DataAdmin.Support.TableIndexSet:WriteTree (IContextTree)

Parameters:
tree	IContextTree

Top

PUBLIC WriteTree (IContextTree, character)

Inherited from OpenEdge.DataAdmin.DataAdminCollection

/* write specified collections

Parameters:
tree	IContextTree

pcCollections	CHARACTER

Constructor Detail

Top

PUBLIC PartitionPolicyIndexSet (PartitionPolicyIndexQuery)

Parameters:
cntxt	OpenEdge.DataAdmin.Binding.Query.PartitionPolicyIndexQuery

Property Detail

Top

PUBLIC CHARACTER CodeExtension

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	CHARACTER

Top

PROTECTED OpenEdge.DataAdmin.Binding.IDataAdminContext Context

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	OpenEdge.DataAdmin.Binding.IDataAdminContext

Top

PUBLIC CHARACTER ContextId

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	CHARACTER

Top

PUBLIC INTEGER Count

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	INTEGER

Top

PROTECTED HANDLE DatasetHandle

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	HANDLE

Top

PROTECTED HANDLE DefaultBuffer

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	HANDLE

Top

PUBLIC LOGICAL HasChanges

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	LOGICAL

Top

PUBLIC LOGICAL IsEmpty

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	LOGICAL

Top

PUBLIC IRequestInfo RequestInfo

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	IRequestInfo

Top

PUBLIC CHARACTER SerializeName

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	CHARACTER

Top

PUBLIC IDataAdminService Service

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	IDataAdminService

Top

PUBLIC CHARACTER SourceId

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	CHARACTER

Top

PROTECTED HANDLE TableHandle

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	HANDLE

Top

PROTECTED CHARACTER TableName

Inherited from OpenEdge.DataAdmin.DataAdminCollection

Returns	CHARACTER

Progress® OpenEdge® Release 12.2.0