Namespace: OpenEdge.DataAdmin.ServerCommand
Type: Class TableDataCommand
Parent Classes:
Progress.Lang.Object
OpenEdge.DataAdmin.ServerCommand.TableDataCommand

Inherits: Progress.Lang.Object
Implements: OpenEdge.DataAdmin.ServerCommand.IServerCommand

/* Copyright (c) 2012-2017 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:TableDataCommand.cls
Author(s):rkumar
Created:2012
Purpose:
Notes:



Method Summary
  Options Name Purpose
  BindCdc (table)
  BindGroup (table)
  BindTable (table)
  BindTables (handle)
  BindTenant (table)
  BindUtility (table)
  Progress.Lang.Error CreatePermissionError (character)
  DoCommand () /** call the execution procedure in the persistent procedure */
  DoCommand (character, character, table-handle) /** call the execution procedure in the persistent procedure or just pass the tables to the monitor if PreRun */
  DoExecute (IUtilityRequest) /* empty the tt that keeps track of processed groups */
  DoTenant (character)
  Execute (IUtilityRequest)
  ForAllGroups () /* dump all groups - all for super - only the logged in tenant's groups for non-super */
  ForAllTenants () /* skip super tenants */
  ForEachGroup ()
  ForEachTenant ()
  OpenEdge.DataAdmin.Message.IUtilityResponse GetResponse ()
  HandleError (error)
  HookProcedure () /** Hook after start procedure and set of common properties It is a bit strict to enforce this, but all subclasses will need to set stuff */
  PrepareTableList () /** duplicates logic for ALL_SELECTION in dump_d.p and load_d.p creates or keeps TableData that represents all selected tables creates ttNonMTTable for all of these that are shared tables */
  LOGICAL SkipSecuredTable (character) /** Return true if the table is to be skipped due to security. Throws error if secured and SkipSecuredTables is false, unless ValidateOnly */
  SplitTableList (character) /** splits the tenants MT table selection in group and no group tables */
  HANDLE StartProcedure () /** Start the procedure persistent */
  ValidateOptions ()
  LOGICAL ValidGroupDirectory (character) /* validate group dir - as of current the parent ("groups") is validated each time this is called... */

Constructor Summary
  Options Name Purpose
  TableDataCommand (character)

Property Summary
  Options Name Purpose
  CHARACTER ALL_SELECTION
  LOGICAL AnyGroupExists
  CHARACTER CDCPOLICY_SELECTION
  OpenEdge.DataAdmin.DataSource.DatabaseInfo DatabaseInfo
  OpenEdge.DataAdmin.Core.FileUtil FileUtil
  CHARACTER GROUP_TABLES
  LOGICAL IsLoad
  CHARACTER LIST_SELECTION
  OpenEdge.DataAdmin.Binding.ITableDataMonitor Monitor
  LOGICAL PreRun
  HANDLE ProcedureHandle
  LOGICAL SharedOnly
  CHARACTER SHARED_SELECTION
  CHARACTER SHARED_TABLES
  LOGICAL TenantOnly
  CHARACTER TENANT_SELECTION
  CHARACTER TENANT_TABLES


Method Detail
Top

BindCdc (table)

Parameters:
ttCDCPolicyData TABLE
 
Top

BindGroup (table)

Parameters:
ttGroupData TABLE
 
Top

BindTable (table)

Parameters:
ttTableData TABLE
 
Top

BindTables (handle)

Parameters:
pDataHandle HANDLE
 
Top

BindTenant (table)

Parameters:
ttTenantData TABLE
 
Top

BindUtility (table)

Parameters:
ttUtilityOptions TABLE
 
Top

Progress.Lang.Error CreatePermissionError (character)

Parameters:
pcTable CHARACTER
 
Returns Progress.Lang.Error
 
Top

DoCommand ()

Purpose: call the execution procedure in the persistent procedure
Top

DoCommand (character, character, table-handle)

Purpose: call the execution procedure in the persistent procedure
or just pass the tables to the monitor if PreRun
Parameters:
pcType CHARACTER
 
pcTenant CHARACTER
 
phTbl TABLE-HANDLE
 
Top

DoExecute (IUtilityRequest)

/* empty the tt that keeps track of processed groups
Parameters:
prequest OpenEdge.DataAdmin.Message.IUtilityRequest
 
Top

DoTenant (character)

Parameters:
pcTenant CHARACTER
 
Top

Execute (IUtilityRequest)

Parameters:
prequest OpenEdge.DataAdmin.Message.IUtilityRequest
 
Top

ForAllGroups ()

/* dump all groups - all for super - only the logged in tenant's groups for non-super
Top

ForAllTenants ()

/* skip super tenants
Top

ForEachGroup ()
Top

ForEachTenant ()
Top

OpenEdge.DataAdmin.Message.IUtilityResponse GetResponse ()

Returns OpenEdge.DataAdmin.Message.IUtilityResponse
 
Top

HandleError (error)

Parameters:
e Progress.Lang.error
 
Top

HookProcedure ()

Purpose: Hook after start procedure and set of common properties
It is a bit strict to enforce this, but all subclasses will
need to set stuff
Top

PrepareTableList ()

Purpose: duplicates logic for ALL_SELECTION in dump_d.p and load_d.p
creates or keeps TableData that represents all selected tables
creates ttNonMTTable for all of these that are shared tables
Top

LOGICAL SkipSecuredTable (character)

Purpose: Return true if the table is to be skipped due to security.
Throws error if secured and SkipSecuredTables is false, unless ValidateOnly
Parameters:
pcfilename CHARACTER
 
Returns LOGICAL
 
Top

SplitTableList (character)

Purpose: splits the tenants MT table selection in group and no group tables
Parameters:
pcTenant CHARACTER
 
Top

HANDLE StartProcedure ()

Purpose: Start the procedure persistent
Returns HANDLE
 
Top

ValidateOptions ()
Top

LOGICAL ValidGroupDirectory (character)

/* validate group dir - as of current the parent ("groups") is validated each time this is called...
Parameters:
pGroupName CHARACTER
 
Returns LOGICAL
 


Constructor Detail
Top

TableDataCommand (character)

Parameters:
databasename CHARACTER
 


Property Detail
Top

CHARACTER ALL_SELECTION

Returns CHARACTER
 
Top

LOGICAL AnyGroupExists

Returns LOGICAL
 
Top

CHARACTER CDCPOLICY_SELECTION

Returns CHARACTER
 
Top

OpenEdge.DataAdmin.DataSource.DatabaseInfo DatabaseInfo

Returns OpenEdge.DataAdmin.DataSource.DatabaseInfo
 
Top

OpenEdge.DataAdmin.Core.FileUtil FileUtil

Returns OpenEdge.DataAdmin.Core.FileUtil
 
Top

CHARACTER GROUP_TABLES

Returns CHARACTER
 
Top

LOGICAL IsLoad

Returns LOGICAL
 
Top

CHARACTER LIST_SELECTION

Returns CHARACTER
 
Top

OpenEdge.DataAdmin.Binding.ITableDataMonitor Monitor

Returns OpenEdge.DataAdmin.Binding.ITableDataMonitor
 
Top

LOGICAL PreRun

Returns LOGICAL
 
Top

HANDLE ProcedureHandle

Returns HANDLE
 
Top

LOGICAL SharedOnly

Returns LOGICAL
 
Top

CHARACTER SHARED_SELECTION

Returns CHARACTER
 
Top

CHARACTER SHARED_TABLES

Returns CHARACTER
 
Top

LOGICAL TenantOnly

Returns LOGICAL
 
Top

CHARACTER TENANT_SELECTION

Returns CHARACTER
 
Top

CHARACTER TENANT_TABLES

Returns CHARACTER