Namespace: OpenEdge.DataAdmin
Class
DataAdminService
Parent classes:
Inherits: Progress.Lang.Object
Implements: OpenEdge.DataAdmin.IDataAdminService

/* Copyright (c) 2011-2017,2019 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:
Purpose:Data Admin Service with crud methods for
collections (IDataAdminCollection) and
entities (IDataAdminElement)
Author(s):hdaniels
Created:Sat Jul 10 23:27:42 EDT 2010




Method Summary
Options Name Purpose
AssertCreate (IDataAdminCollection, IDataAdminContext)
AssertCreate (IDataAdminElement, IDataAdminContext)
AssertNotRequested (character, IRequestInfo)
AssertUpdate (IDataAdminCollection, IDataAdminContext)
AssertUpdate (IDataAdminElement, IDataAdminContext)
LOGICAL CancelSchemaChanges () /* the service only supports one active context retrieved with GetShemaChanges */
LOGICAL CreateArea (IArea)
LOGICAL CreateAreas (IAreaSet)
LOGICAL CreateAuthenticationSystem (IAuthenticationSystem)
LOGICAL CreateAuthenticationSystems (IAuthenticationSystemSet)
LOGICAL CreateCdcTablePolicies (ICdcTablePolicySet)
LOGICAL CreateCdcTablePolicy (ICdcTablePolicy)
LOGICAL CreateCollection (IDataAdminCollection) /** Create a collection */
LOGICAL CreateCollection (IDataAdminCollection, IDataAdminModel)
LOGICAL CreateDatabaseOption (IDatabaseOption) /** Create a new database option @param IDatabaseOption The option to be created @return logical TRUE if the dboption was created */
LOGICAL CreateDatabaseOptions (IDatabaseOptionSet) /** Create new database options @param IDatabaseOptionSet A collection of options to create @return logical TRUE if the dboptions were created */
LOGICAL CreateDomain (IDomain)
LOGICAL CreateDomains (IDomainSet)
LOGICAL CreateElement (IDataAdminElement, IDataAdminModel)
LOGICAL CreateGrantedRole (IGrantedRole) /** Create a new role grant @param IGrantRole The role to be created @return logical TRUE if the grant was created */
LOGICAL CreateGrantedRoles (IGrantedRoleSet) /** Create new role grants @param IGrantedRoleSet A collection of roles to create @return logical TRUE if the grant was created */
LOGICAL CreatePartitionPolicies (IPartitionPolicySet) /** Create a new partition policy @param policies IPartitionPolicySet with policies to be created */
LOGICAL CreatePartitionPolicy (IPartitionPolicy) /** Create a new partition policy @param policy IPartitionPolicy to be created */
LOGICAL CreateRole (IRole) /** Create a new role @param IRole The role to be created */
LOGICAL CreateRoles (IRoleSet) /** Create new roles @param IRoleSet A collection of roles to create */
LOGICAL CreateSequence (ISequence)
LOGICAL CreateSequences (ISequenceSet)
LOGICAL CreateTenant (ITenant)
LOGICAL CreateTenantGroup (ITenantGroup)
LOGICAL CreateTenantGroups (ITenantGroupSet)
LOGICAL CreateTenants (ITenantSet)
LOGICAL CreateUser (IUser)
LOGICAL CreateUsers (IUserSet)
LOGICAL DeleteAuthenticationSystem (character)
LOGICAL DeleteCdcTablePolicy (character)
LOGICAL DeleteDomain (character)
LOGICAL DeleteElement (character, IDataAdminElement, IDataAdminModel) /* base update method (not used by all) */
LOGICAL DeleteGrantedRole (character) /** Delete granted role @param character The ID of the granted role to delete @throws NotFoundError if role does not exist */
LOGICAL DeletePartitionPolicy (character) /** Delete PartitionPolicy @param policyName name of policy to delete. @throws NotFoundError if policy does not exist. */
LOGICAL DeleteSequence (character)
LOGICAL DeleteTenant (character)
LOGICAL DeleteTenantGroup (character)
LOGICAL DeleteUser (character)
ErrorHandler (Error)
ExecuteUtility (IDataAdminUtility)
OpenEdge.DataAdmin.IAdministrator GetAdministrator ()
OpenEdge.DataAdmin.IArea GetArea (character)
OpenEdge.DataAdmin.IArea GetArea (integer)
OpenEdge.DataAdmin.IArea GetArea (IRequestInfo)
OpenEdge.DataAdmin.IAreaSet GetAreas ()
OpenEdge.DataAdmin.IAreaSet GetAreas (character)
OpenEdge.DataAdmin.IAreaSet GetAreas (IRequestInfo)
OpenEdge.DataAdmin.IAuthenticationSystem GetAuthenticationSystem (character)
OpenEdge.DataAdmin.IAuthenticationSystemSet GetAuthenticationSystems ()
OpenEdge.DataAdmin.IAuthenticationSystemSet GetAuthenticationSystems (character)
OpenEdge.DataAdmin.IAuthenticationSystemSet GetAuthenticationSystems (IRequestInfo)
OpenEdge.DataAdmin.ICdcFieldPolicySet GetCdcFieldPolicies () /** Get a collection of all partition policies details in the database */
OpenEdge.DataAdmin.ICdcFieldPolicySet GetCdcFieldPolicies (character) /** Get a collection of partition policies details @param filter */
OpenEdge.DataAdmin.ICdcFieldPolicySet GetCdcFieldPolicies (IRequestInfo) /** Get a collection of partition policies details @param request IRequestInfo*/
OpenEdge.DataAdmin.ICdcTablePolicySet GetCdcTablePolicies () /** Get a collection of allpartition policies in the database @param name char of PartitionPolicy*/
OpenEdge.DataAdmin.ICdcTablePolicySet GetCdcTablePolicies (character) /** Get a collection of partition policies @param filter */
OpenEdge.DataAdmin.ICdcTablePolicySet GetCdcTablePolicies (IRequestInfo) /** Get a collection of partition policies @param request IRequestInfo*/
OpenEdge.DataAdmin.ICdcTablePolicy GetCdcTablePolicy (character)
OpenEdge.DataAdmin.ICdcTablePolicy GetCdcTablePolicy (IRequestInfo)
OpenEdge.DataAdmin.IDataAdminCollection GetCollection (character) /** Get a collection of the specified serializename, entity name or physical database filename */
OpenEdge.DataAdmin.IDataAdminCollection GetCollection (IRequestInfo) /** Get a collection specified by the request in the database */
OpenEdge.DataAdmin.IDatabaseOption GetDatabaseOption (character) /* Get a db option record by code @param character The db option code @return IDatabaseOption The database option */
OpenEdge.DataAdmin.IDatabaseOptionSet GetDatabaseOptions () /* Get a collection of db options @return IDatabaseOptionSet A colletion of the dboptions */
OpenEdge.DataAdmin.IDatabaseOptionSet GetDatabaseOptions (character) /** Get a collection of database options @param filter a character query expression of db options */
OpenEdge.DataAdmin.IDatabaseOptionSet GetDatabaseOptions (IRequestInfo) /** Get a collection of database options @param IRequestinfo with a QueryString that defines an expression of dboptionproperties with optional request info children with QueryStrings for child collections */
OpenEdge.DataAdmin.IDataSecurity GetDataSecurity (character)
OpenEdge.DataAdmin.IDomain GetDomain (character)
OpenEdge.DataAdmin.IDomain GetDomain (IRequestInfo)
OpenEdge.DataAdmin.IDomainSet GetDomains ()
OpenEdge.DataAdmin.IDomainSet GetDomains (character)
OpenEdge.DataAdmin.IDomainSet GetDomains (IRequestInfo)
Progress.Lang.Error GetError ()
OpenEdge.DataAdmin.IGrantedRole GetGrantedRole (character) /** Get a granted role @param character The id of the grant role to retrieve*/
OpenEdge.DataAdmin.IGrantedRoleSet GetGrantedRoles () /* Get a collection of all role grants in the database @return IGrantedRoleSet A set of grants */
OpenEdge.DataAdmin.IGrantedRoleSet GetGrantedRoles (character) /* Get a collection of role grants in the database @param character A character query filter expression of grant properties @return IGrantedRoleSet A set of grants */
OpenEdge.DataAdmin.IGrantedRoleSet GetGrantedRoles (IRequestInfo) /* Get a collection of granted roles @param IRequestinfo with a QueryString that defines an expression of domain properties with optional request info children with QueryStrings for child collections @return IGrantedRoleSet A set of grants */
OpenEdge.DataAdmin.IPartitionPolicySet GetPartitionPolicies () /** Get a collection of allpartition policies in the database @param name char of PartitionPolicy*/
OpenEdge.DataAdmin.IPartitionPolicySet GetPartitionPolicies (character) /** Get a collection of partition policies @param filter */
OpenEdge.DataAdmin.IPartitionPolicySet GetPartitionPolicies (IRequestInfo) /** Get a collection of partition policies @param request IRequestInfo*/
OpenEdge.DataAdmin.IPartitionPolicy GetPartitionPolicy (character)
OpenEdge.DataAdmin.IPartitionPolicy GetPartitionPolicy (integer)
OpenEdge.DataAdmin.IPartitionPolicy GetPartitionPolicy (IRequestInfo)
OpenEdge.DataAdmin.IPartitionPolicyDetailSet GetPartitionPolicyDetails () /** Get a collection of all partition policies details in the database */
OpenEdge.DataAdmin.IPartitionPolicyDetailSet GetPartitionPolicyDetails (character) /** Get a collection of partition policies details @param filter */
OpenEdge.DataAdmin.IPartitionPolicyDetailSet GetPartitionPolicyDetails (IRequestInfo) /** Get a collection of partition policies details @param request IRequestInfo*/
OpenEdge.DataAdmin.IUserTablePermissionSet GetPermissions (character)
CHARACTER GetPropertyValues (IDataAdminElement, character)
OpenEdge.DataAdmin.IRole GetRole (character) /** Get a role @param character The name of the role to retrieve*/
OpenEdge.DataAdmin.IRole GetRole (IRequestInfo) /** Get a role @param IRequestinfo that defines an expression that uniqely identifies a domain with optional request info children with QueryStrings for child collections */
OpenEdge.DataAdmin.IRoleSet GetRoles () /** Get a collection of all security roles domains in the database */
OpenEdge.DataAdmin.IRoleSet GetRoles (character) /** Get a collection of roles in the database * @param filter a character query expression of domain properties */
OpenEdge.DataAdmin.IRoleSet GetRoles (IRequestInfo) /** Get a collection of all domains in the database @param IRequestinfo with a QueryString that defines an expression of domain properties with optional request info children with QueryStrings for child collections */
OpenEdge.DataAdmin.Binding.IRow GetRowInfo (IDataAdminElement, IDataAdminModel)
OpenEdge.DataAdmin.ISchema GetSchema () /* the service only supports "pub" schema so no key parameter */
OpenEdge.DataAdmin.ISchema GetSchema (character) /* the service only supports "pub" schema so no key parameter */
OpenEdge.DataAdmin.ISchema GetSchema (IRequestInfo) /* the service only supports "pub" schema so no key parameter */
OpenEdge.DataAdmin.ISchema GetSchemaChanges (character) /* the service only supports "pub" schema so no key parameter */
OpenEdge.DataAdmin.ISecurityOptions GetSecurityOptions ()
OpenEdge.DataAdmin.ISequence GetSequence (character)
OpenEdge.DataAdmin.ISequence GetSequence (IRequestInfo)
OpenEdge.DataAdmin.ISequenceSet GetSequences ()
OpenEdge.DataAdmin.ISequenceSet GetSequences (character)
OpenEdge.DataAdmin.ISequenceSet GetSequences (IRequestInfo)
OpenEdge.DataAdmin.ITable GetTable (character)
OpenEdge.DataAdmin.ITable GetTable (character, character) /* This method is introduced to support retrieval of PUB and non-PUB tables as part of CDC feature */
OpenEdge.DataAdmin.ITable GetTable (integer) /* id mapped to field-number */
OpenEdge.DataAdmin.ITable GetTable (IRequestInfo)
OpenEdge.DataAdmin.ITablePermission GetTablePermission (character)
OpenEdge.DataAdmin.ITablePermissionSet GetTablePermissions ()
OpenEdge.DataAdmin.ITablePermissionSet GetTablePermissions (character)
OpenEdge.DataAdmin.ITableSet GetTables ()
OpenEdge.DataAdmin.ITableSet GetTables (character)
OpenEdge.DataAdmin.ITableSet GetTables (IRequestInfo)
OpenEdge.DataAdmin.ITenant GetTenant (character)
OpenEdge.DataAdmin.ITenant GetTenant (integer)
OpenEdge.DataAdmin.ITenant GetTenant (IRequestInfo)
OpenEdge.DataAdmin.ITenant GetTenantByExternalId (character)
OpenEdge.DataAdmin.ITenantGroup GetTenantGroup (character)
OpenEdge.DataAdmin.ITenantGroup GetTenantGroup (integer)
OpenEdge.DataAdmin.ITenantGroup GetTenantGroup (IRequestInfo)
OpenEdge.DataAdmin.ITenantGroupSet GetTenantGroups ()
OpenEdge.DataAdmin.ITenantGroupSet GetTenantGroups (character)
OpenEdge.DataAdmin.ITenantGroupSet GetTenantGroups (IRequestInfo)
OpenEdge.DataAdmin.ITenantSet GetTenants ()
OpenEdge.DataAdmin.ITenantSet GetTenants (character)
OpenEdge.DataAdmin.ITenantSet GetTenants (IRequestInfo)
OpenEdge.DataAdmin.IUser GetUser (character)
OpenEdge.DataAdmin.IUserPermission GetUserPermission (character)
OpenEdge.DataAdmin.IUserPermissionSet GetUserPermissions ()
OpenEdge.DataAdmin.IUserPermissionSet GetUserPermissions (character)
OpenEdge.DataAdmin.IUserSet GetUsers ()
OpenEdge.DataAdmin.IUserSet GetUsers (character)
OpenEdge.DataAdmin.IUserSet GetUsers (IRequestInfo)
LOGICAL LoadSchemaChanges (character)
OpenEdge.DataAdmin.IArea NewArea (character)
OpenEdge.DataAdmin.IAreaSet NewAreas ()
OpenEdge.DataAdmin.IAuthenticationSystem NewAuthenticationSystem (character)
OpenEdge.DataAdmin.IAuthenticationSystemSet NewAuthenticationSystems ()
OpenEdge.DataAdmin.ICdcFieldPolicy NewCdcFieldPolicy ()
OpenEdge.DataAdmin.ICdcTablePolicySet NewCdcTablePolicies ()
OpenEdge.DataAdmin.ICdcTablePolicy NewCdcTablePolicy (character)
OpenEdge.DataAdmin.IDataAdminCollection NewCollection (character) /** returns a new collection of the specified serializename, entity name or physical database filename */
OpenEdge.DataAdmin.IDatabaseOption NewDatabaseOption (character) /** Get a new, empty db option Expected to be passed to CreateDatabaseOption() to be created in the database or added to a new or existing IDatabaseOptionSet collection, to be submitted to the database with the collection. @param character The name of the new option @return IDatabaseOption The new dboption */
OpenEdge.DataAdmin.IDatabaseOptionSet NewDatabaseOptions () /** Get an empty dboption collection Add new options to the collection and pass it to CreateDatabaseOptions() to create the options in the database. @return IDatabaseOptionSet A new empty collection of dboptions */
OpenEdge.DataAdmin.IDomain NewDomain (character)
OpenEdge.DataAdmin.IDomainSet NewDomains ()
OpenEdge.DataAdmin.IDataAdminElement NewEntity (character, character) /* NOTE - must define context variable here or else the context gets garbage collected when NewEntity ends before the entity is returned - - this is likely no longer true */
OpenEdge.DataAdmin.IExtent NewExtent ()
OpenEdge.DataAdmin.IGrantedRole NewGrantedRole () /** Get a new granted role @param character The Role name @return IGrantedRole The new grant role */
OpenEdge.DataAdmin.IGrantedRoleSet NewGrantedRoles () /** Get a new granted role Expected to be added to an instance of IRole and submitted that way. @return IGrantedRoleSet The new grant set */
OpenEdge.DataAdmin.IIndex NewIndex ()
OpenEdge.DataAdmin.IPartitionPolicySet NewPartitionPolicies ()
OpenEdge.DataAdmin.IPartitionPolicy NewPartitionPolicy (character)
OpenEdge.DataAdmin.IPartitionPolicyDetail NewPartitionPolicyDetail (character) /* using the service's UpdateTable() or UpdateTables() methods.*/
OpenEdge.DataAdmin.IRole NewRole (character) /** Get a new role Expected to be passed to CreateDomain() to be created in the database or added to a new or existing IRoleSet collection, to be submitted to the database with the collection. @param character The name of the new role @return IRole The new role */
OpenEdge.DataAdmin.IRoleSet NewRoles () /** Get an empty role collection Add new roles to the collection and pass it to CreateRoles() to create the roles in the database. @return IRoleSet A new empty colleciton of roles */
OpenEdge.DataAdmin.ISequence NewSequence (character)
OpenEdge.DataAdmin.ISequenceSet NewSequences ()
OpenEdge.DataAdmin.ITenant NewTenant (character)
OpenEdge.DataAdmin.ITenantGroup NewTenantGroup (character)
OpenEdge.DataAdmin.ITenantGroupMember NewTenantGroupMember ()
OpenEdge.DataAdmin.ITenantGroupSet NewTenantGroups ()
OpenEdge.DataAdmin.ITenantSet NewTenants ()
OpenEdge.DataAdmin.IUser NewUser (character)
OpenEdge.DataAdmin.IUserSet NewUsers ()
Progress.Lang.Error RemoveError ()
OpenEdge.DataAdmin.Message.ISaveRequest SaveData (ISaveRequest)
ThrowError ()
LOGICAL UpdateAdministrator (IAdministrator)
LOGICAL UpdateArea (IArea)
LOGICAL UpdateAreas (IAreaSet)
LOGICAL UpdateAuthenticationSystem (IAuthenticationSystem)
LOGICAL UpdateAuthenticationSystems (IAuthenticationSystemSet)
LOGICAL UpdateCdcTablePolicies (ICdcTablePolicySet)
LOGICAL UpdateCdcTablePolicy (ICdcTablePolicy)
LOGICAL UpdateCollection (IDataAdminCollection) /** Update a collection */
LOGICAL UpdateCollection (IDataAdminCollection, IDataAdminContext) /* base update method */
LOGICAL UpdateContext (IDataAdminContext) /* base update method (not used by all) */
LOGICAL UpdateContext (IDataAdminContext, character) /* base update method */
LOGICAL UpdateDatabaseOption (IDatabaseOption) /** Update the database with a changed dboption @param IDatabaseOption The updated db option @return logical TRUE if the option was updated */
LOGICAL UpdateDatabaseOptions (IDatabaseOptionSet) /** Update the database with changes for many dboptions @param IDatabaseOptionSet A colleciton of db options @return logical TRUE if the options were updated */
LOGICAL UpdateDataSecurity (IDataSecurity)
LOGICAL UpdateDomain (IDomain)
LOGICAL UpdateDomains (IDomainSet)
LOGICAL UpdateElement (character, IDataAdminElement, IDataAdminContext) /* base update method (not used by all) */
LOGICAL UpdateElement (IDataAdminElement, IDataAdminModel) /* base update method (not used by all) */
LOGICAL UpdateGrantedRole (IGrantedRole) /** Update the database with a changed role grant @param IGrantRole The updated grant @return logical TRUE if the option was updated */
LOGICAL UpdateGrantedRoles (IGrantedRoleSet) /** Update the database with changes for many granted roles @param IGrantedRoleSet A collection of granted roles @return logical TRUE if the options were updated */
LOGICAL UpdatePartitionPolicies (IPartitionPolicySet) /** Update the database with partition policies with changes @param policies IPartitionPolicySet with policies to be updated */
LOGICAL UpdatePartitionPolicy (IPartitionPolicy) /** Update the database with partition policy changes @param policy IPartitionPolicy to be created */
LOGICAL UpdatePartitions () /*todo - pass iPartitioncollection */
LOGICAL UpdateRole (IRole) /** Update the database with a changed security role @param IRole The updated role @return logical TRUE if the option was updated */
LOGICAL UpdateRoles (IRoleSet) /** Update the database with changes for many roles @param IRoleSet A collection of roles @return logical TRUE if the options were updated */
LOGICAL UpdateSchema (ISchema)
LOGICAL UpdateSchemaChanges (ISchema)
LOGICAL UpdateSecurityOptions (ISecurityOptions)
LOGICAL UpdateSequence (ISequence)
LOGICAL UpdateSequences (ISequenceSet)
LOGICAL UpdateTable (ITable)
LOGICAL UpdateTablePermission (ITablePermission)
LOGICAL UpdateTablePermissions (ITablePermissionSet)
LOGICAL UpdateTables (ITableSet)
LOGICAL UpdateTenant (ITenant)
LOGICAL UpdateTenantGroup (ITenantGroup)
LOGICAL UpdateTenantGroups (ITenantGroupSet)
LOGICAL UpdateTenants (ITenantSet)
LOGICAL UpdateUser (IUser) /* method public logical AttachPartitions(partitions as IPartitionMap): do on error undo, throw: partitions:Attach(ContextFactory:PartitionContext). /* SaveData(PartitionContext).*/ catch e as Progress.Lang.Error: ErrorHandler(e). return false. end catch. end. return true. end method. */
LOGICAL UpdateUsers (IUserSet)
ValidUserId (character, character, character) /* todo - use UserContext somehow */

Constructor Summary
Options Name Purpose
DataAdminService ()
DataAdminService (character)
DataAdminService (character, character)

Event Summary
Options Name Purpose
ServiceDeleted ()

Property Summary
Options Name Purpose
OpenEdge.DataAdmin.Binding.SchemaChanges CurrentSchemaChanges
OpenEdge.DataAdmin.Error.OperationError Error
CHARACTER Name
OpenEdge.DataAdmin.Core.IPasswordPolicy PasswordPolicy
LOGICAL ThrowDataErrors
OpenEdge.DataAdmin.Core.FileLogger TransactionLogger
CHARACTER URL
OpenEdge.DataAdmin.Util.IUtilityFactory UtilityFactory


Method Detail
Top

PROTECTED AssertCreate (IDataAdminCollection, IDataAdminContext)

Parameters:
coll OpenEdge.DataAdmin.IDataAdminCollection
serviceContext OpenEdge.DataAdmin.Binding.IDataAdminContext
Top

PROTECTED AssertCreate (IDataAdminElement, IDataAdminContext)

Parameters:
entity OpenEdge.DataAdmin.IDataAdminElement
context OpenEdge.DataAdmin.Binding.IDataAdminContext
Top

PRIVATE AssertNotRequested (character, IRequestInfo)

Parameters:
pcList CHARACTER
preq OpenEdge.DataAdmin.IRequestInfo
Top

PROTECTED AssertUpdate (IDataAdminCollection, IDataAdminContext)

Parameters:
coll OpenEdge.DataAdmin.IDataAdminCollection
serviceContext OpenEdge.DataAdmin.Binding.IDataAdminContext
Top

PROTECTED AssertUpdate (IDataAdminElement, IDataAdminContext)

Parameters:
entity OpenEdge.DataAdmin.IDataAdminElement
context OpenEdge.DataAdmin.Binding.IDataAdminContext
Top

PUBLIC LOGICAL CancelSchemaChanges ()

/* the service only supports one active context retrieved with GetShemaChanges
Returns LOGICAL
Top

PUBLIC LOGICAL CreateArea (IArea)

Parameters:
area OpenEdge.DataAdmin.IArea
Returns LOGICAL
Top

PUBLIC LOGICAL CreateAreas (IAreaSet)

Parameters:
areas OpenEdge.DataAdmin.IAreaSet
Returns LOGICAL
Top

PUBLIC LOGICAL CreateAuthenticationSystem (IAuthenticationSystem)

Parameters:
authenticationsystem OpenEdge.DataAdmin.IAuthenticationSystem
Returns LOGICAL
Top

PUBLIC LOGICAL CreateAuthenticationSystems (IAuthenticationSystemSet)

Parameters:
authenticationsystems OpenEdge.DataAdmin.IAuthenticationSystemSet
Returns LOGICAL
Top

PUBLIC LOGICAL CreateCdcTablePolicies (ICdcTablePolicySet)

Parameters:
policies OpenEdge.DataAdmin.ICdcTablePolicySet
Returns LOGICAL
Top

PUBLIC LOGICAL CreateCdcTablePolicy (ICdcTablePolicy)

Parameters:
policy OpenEdge.DataAdmin.ICdcTablePolicy
Returns LOGICAL
Top

PUBLIC LOGICAL CreateCollection (IDataAdminCollection)

Purpose: Create a collection
Parameters:
pccol OpenEdge.DataAdmin.IDataAdminCollection
Returns LOGICAL
Top

PROTECTED LOGICAL CreateCollection (IDataAdminCollection, IDataAdminModel)

Parameters:
coll OpenEdge.DataAdmin.IDataAdminCollection
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
Returns LOGICAL
Top

PUBLIC LOGICAL CreateDatabaseOption (IDatabaseOption)

Purpose: Create a new database option
Parameters:
poDbOption OpenEdge.DataAdmin.IDatabaseOption
Returns LOGICAL
logical TRUE if the dboption was created
Top

PUBLIC LOGICAL CreateDatabaseOptions (IDatabaseOptionSet)

Purpose: Create new database options
Parameters:
poDbOption OpenEdge.DataAdmin.IDatabaseOptionSet
Returns LOGICAL
logical TRUE if the dboptions were created
Top

PUBLIC LOGICAL CreateDomain (IDomain)

Parameters:
domain OpenEdge.DataAdmin.IDomain
Returns LOGICAL
Top

PUBLIC LOGICAL CreateDomains (IDomainSet)

Parameters:
domains OpenEdge.DataAdmin.IDomainSet
Returns LOGICAL
Top

PROTECTED LOGICAL CreateElement (IDataAdminElement, IDataAdminModel)

Parameters:
elem OpenEdge.DataAdmin.IDataAdminElement
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
Returns LOGICAL
Top

PUBLIC LOGICAL CreateGrantedRole (IGrantedRole)

Purpose: Create a new role grant
Parameters:
poGrant OpenEdge.DataAdmin.IGrantedRole
Returns LOGICAL
logical TRUE if the grant was created
Top

PUBLIC LOGICAL CreateGrantedRoles (IGrantedRoleSet)

Purpose: Create new role grants
Parameters:
poGrants OpenEdge.DataAdmin.IGrantedRoleSet
Returns LOGICAL
logical TRUE if the grant was created
Top

PUBLIC LOGICAL CreatePartitionPolicies (IPartitionPolicySet)

Purpose: Create a new partition policy
Parameters:
policies OpenEdge.DataAdmin.IPartitionPolicySet
IPartitionPolicySet with policies to be created */
Returns LOGICAL
Top

PUBLIC LOGICAL CreatePartitionPolicy (IPartitionPolicy)

Purpose: Create a new partition policy
Parameters:
policy OpenEdge.DataAdmin.IPartitionPolicy
IPartitionPolicy to be created */
Returns LOGICAL
Top

PUBLIC LOGICAL CreateRole (IRole)

Purpose: Create a new role
Parameters:
role OpenEdge.DataAdmin.IRole
Returns LOGICAL
Top

PUBLIC LOGICAL CreateRoles (IRoleSet)

Purpose: Create new roles
Parameters:
roles OpenEdge.DataAdmin.IRoleSet
Returns LOGICAL
Top

PUBLIC LOGICAL CreateSequence (ISequence)

Parameters:
sequence OpenEdge.DataAdmin.ISequence
Returns LOGICAL
Top

PUBLIC LOGICAL CreateSequences (ISequenceSet)

Parameters:
sequences OpenEdge.DataAdmin.ISequenceSet
Returns LOGICAL
Top

PUBLIC LOGICAL CreateTenant (ITenant)

Parameters:
tenant OpenEdge.DataAdmin.ITenant
Returns LOGICAL
Top

PUBLIC LOGICAL CreateTenantGroup (ITenantGroup)

Parameters:
newgroup OpenEdge.DataAdmin.ITenantGroup
Returns LOGICAL
Top

PUBLIC LOGICAL CreateTenantGroups (ITenantGroupSet)

Parameters:
groups OpenEdge.DataAdmin.ITenantGroupSet
Returns LOGICAL
Top

PUBLIC LOGICAL CreateTenants (ITenantSet)

Parameters:
tenants OpenEdge.DataAdmin.ITenantSet
Returns LOGICAL
Top

PUBLIC LOGICAL CreateUser (IUser)

Parameters:
usr OpenEdge.DataAdmin.IUser
Returns LOGICAL
Top

PUBLIC LOGICAL CreateUsers (IUserSet)

Parameters:
users OpenEdge.DataAdmin.IUserSet
Returns LOGICAL
Top

PUBLIC LOGICAL DeleteAuthenticationSystem (character)

Parameters:
authenticationsystemName CHARACTER
Returns LOGICAL
Top

PUBLIC LOGICAL DeleteCdcTablePolicy (character)

Parameters:
policyName CHARACTER
Returns LOGICAL
Top

PUBLIC LOGICAL DeleteDomain (character)

Parameters:
domainName CHARACTER
Returns LOGICAL
Top

PROTECTED LOGICAL DeleteElement (character, IDataAdminElement, IDataAdminModel)

/* base update method (not used by all)
Parameters:
pkey CHARACTER
inst OpenEdge.DataAdmin.IDataAdminElement
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
Returns LOGICAL
Top

PUBLIC LOGICAL DeleteGrantedRole (character)

Purpose: Delete granted role
@throws NotFoundError if role does not exist
Parameters:
pcGrantId CHARACTER
Returns LOGICAL
Top

PUBLIC LOGICAL DeletePartitionPolicy (character)

Purpose: Delete PartitionPolicy
@throws NotFoundError if policy does not exist.
Parameters:
policyName CHARACTER
name of policy to delete.
Returns LOGICAL
Top

PUBLIC LOGICAL DeleteSequence (character)

Parameters:
seqname CHARACTER
Returns LOGICAL
Top

PUBLIC LOGICAL DeleteTenant (character)

Parameters:
tenantName CHARACTER
Returns LOGICAL
Top

PUBLIC LOGICAL DeleteTenantGroup (character)

Parameters:
groupName CHARACTER
Returns LOGICAL
Top

PUBLIC LOGICAL DeleteUser (character)

Parameters:
usrId CHARACTER
Returns LOGICAL
Top

PROTECTED ErrorHandler (Error)

Parameters:
e Progress.Lang.Error
Top

PUBLIC ExecuteUtility (IDataAdminUtility)

Parameters:
putility OpenEdge.DataAdmin.Util.IDataAdminUtility
Top

PUBLIC OpenEdge.DataAdmin.IAdministrator GetAdministrator ()

Returns OpenEdge.DataAdmin.IAdministrator
Top

PUBLIC OpenEdge.DataAdmin.IArea GetArea (character)

Parameters:
areaName CHARACTER
Returns OpenEdge.DataAdmin.IArea
Top

PUBLIC OpenEdge.DataAdmin.IArea GetArea (integer)

Parameters:
areaNum INTEGER
Returns OpenEdge.DataAdmin.IArea
Top

PUBLIC OpenEdge.DataAdmin.IArea GetArea (IRequestInfo)

Parameters:
pReq OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IArea
Top

PUBLIC OpenEdge.DataAdmin.IAreaSet GetAreas ()

Returns OpenEdge.DataAdmin.IAreaSet
Top

PUBLIC OpenEdge.DataAdmin.IAreaSet GetAreas (character)

Parameters:
filter CHARACTER
Returns OpenEdge.DataAdmin.IAreaSet
Top

PUBLIC OpenEdge.DataAdmin.IAreaSet GetAreas (IRequestInfo)

Parameters:
preq OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IAreaSet
Top

PUBLIC OpenEdge.DataAdmin.IAuthenticationSystem GetAuthenticationSystem (character)

Parameters:
name CHARACTER
Returns OpenEdge.DataAdmin.IAuthenticationSystem
Top

PUBLIC OpenEdge.DataAdmin.IAuthenticationSystemSet GetAuthenticationSystems ()

Returns OpenEdge.DataAdmin.IAuthenticationSystemSet
Top

PUBLIC OpenEdge.DataAdmin.IAuthenticationSystemSet GetAuthenticationSystems (character)

Parameters:
filter CHARACTER
Returns OpenEdge.DataAdmin.IAuthenticationSystemSet
Top

PUBLIC OpenEdge.DataAdmin.IAuthenticationSystemSet GetAuthenticationSystems (IRequestInfo)

Parameters:
req OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IAuthenticationSystemSet
Top

PUBLIC OpenEdge.DataAdmin.ICdcFieldPolicySet GetCdcFieldPolicies ()

Purpose: Get a collection of all partition policies details in the database
Returns OpenEdge.DataAdmin.ICdcFieldPolicySet
Top

PUBLIC OpenEdge.DataAdmin.ICdcFieldPolicySet GetCdcFieldPolicies (character)

Purpose: Get a collection of partition policies details
Parameters:
pFilter CHARACTER
Returns OpenEdge.DataAdmin.ICdcFieldPolicySet
Top

PUBLIC OpenEdge.DataAdmin.ICdcFieldPolicySet GetCdcFieldPolicies (IRequestInfo)

Purpose: Get a collection of partition policies details
Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ICdcFieldPolicySet
Top

PUBLIC OpenEdge.DataAdmin.ICdcTablePolicySet GetCdcTablePolicies ()

Purpose: Get a collection of allpartition policies in the database
Returns OpenEdge.DataAdmin.ICdcTablePolicySet
Top

PUBLIC OpenEdge.DataAdmin.ICdcTablePolicySet GetCdcTablePolicies (character)

Purpose: Get a collection of partition policies
Parameters:
pFilter CHARACTER
Returns OpenEdge.DataAdmin.ICdcTablePolicySet
Top

PUBLIC OpenEdge.DataAdmin.ICdcTablePolicySet GetCdcTablePolicies (IRequestInfo)

Purpose: Get a collection of partition policies
Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ICdcTablePolicySet
Top

PUBLIC OpenEdge.DataAdmin.ICdcTablePolicy GetCdcTablePolicy (character)

Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.ICdcTablePolicy
Top

PUBLIC OpenEdge.DataAdmin.ICdcTablePolicy GetCdcTablePolicy (IRequestInfo)

Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ICdcTablePolicy
Top

PUBLIC OpenEdge.DataAdmin.IDataAdminCollection GetCollection (character)

Purpose: Get a collection of the specified serializename, entity name or physical database filename
Parameters:
pcType CHARACTER
Returns OpenEdge.DataAdmin.IDataAdminCollection
Top

PUBLIC OpenEdge.DataAdmin.IDataAdminCollection GetCollection (IRequestInfo)

Purpose: Get a collection specified by the request in the database
Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IDataAdminCollection
Top

PUBLIC OpenEdge.DataAdmin.IDatabaseOption GetDatabaseOption (character)

/* Get a db option record by code
Parameters:
pcOptionCode CHARACTER
Returns OpenEdge.DataAdmin.IDatabaseOption
IDatabaseOption The database option
Top

PUBLIC OpenEdge.DataAdmin.IDatabaseOptionSet GetDatabaseOptions ()

/* Get a collection of db options
Returns OpenEdge.DataAdmin.IDatabaseOptionSet
IDatabaseOptionSet A colletion of the dboptions
Top

PUBLIC OpenEdge.DataAdmin.IDatabaseOptionSet GetDatabaseOptions (character)

Purpose: Get a collection of database options
Parameters:
pcFilter CHARACTER
Returns OpenEdge.DataAdmin.IDatabaseOptionSet
Top

PUBLIC OpenEdge.DataAdmin.IDatabaseOptionSet GetDatabaseOptions (IRequestInfo)

Purpose: Get a collection of database options
with optional request info children with QueryStrings for child collections
Parameters:
poRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IDatabaseOptionSet
Top

PUBLIC OpenEdge.DataAdmin.IDataSecurity GetDataSecurity (character)

Parameters:
pcKey CHARACTER
Returns OpenEdge.DataAdmin.IDataSecurity
Top

PUBLIC OpenEdge.DataAdmin.IDomain GetDomain (character)

Parameters:
domainName CHARACTER
Returns OpenEdge.DataAdmin.IDomain
Top

PUBLIC OpenEdge.DataAdmin.IDomain GetDomain (IRequestInfo)

Parameters:
req OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IDomain
Top

PUBLIC OpenEdge.DataAdmin.IDomainSet GetDomains ()

Returns OpenEdge.DataAdmin.IDomainSet
Top

PUBLIC OpenEdge.DataAdmin.IDomainSet GetDomains (character)

Parameters:
filter CHARACTER
Returns OpenEdge.DataAdmin.IDomainSet
Top

PUBLIC OpenEdge.DataAdmin.IDomainSet GetDomains (IRequestInfo)

Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IDomainSet
Top

PUBLIC Progress.Lang.Error GetError ()

Returns Progress.Lang.Error
Top

PUBLIC OpenEdge.DataAdmin.IGrantedRole GetGrantedRole (character)

Purpose: Get a granted role
Parameters:
pcGrantId CHARACTER
Returns OpenEdge.DataAdmin.IGrantedRole
Top

PUBLIC OpenEdge.DataAdmin.IGrantedRoleSet GetGrantedRoles ()

/* Get a collection of all role grants in the database
Returns OpenEdge.DataAdmin.IGrantedRoleSet
IGrantedRoleSet A set of grants
Top

PUBLIC OpenEdge.DataAdmin.IGrantedRoleSet GetGrantedRoles (character)

/* Get a collection of role grants in the database
Parameters:
pcFilter CHARACTER
Returns OpenEdge.DataAdmin.IGrantedRoleSet
IGrantedRoleSet A set of grants
Top

PUBLIC OpenEdge.DataAdmin.IGrantedRoleSet GetGrantedRoles (IRequestInfo)

/* Get a collection of granted roles
with optional request info children with QueryStrings for child collections
Parameters:
poRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IGrantedRoleSet
IGrantedRoleSet A set of grants
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicySet GetPartitionPolicies ()

Purpose: Get a collection of allpartition policies in the database
Returns OpenEdge.DataAdmin.IPartitionPolicySet
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicySet GetPartitionPolicies (character)

Purpose: Get a collection of partition policies
Parameters:
pFilter CHARACTER
Returns OpenEdge.DataAdmin.IPartitionPolicySet
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicySet GetPartitionPolicies (IRequestInfo)

Purpose: Get a collection of partition policies
Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IPartitionPolicySet
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicy GetPartitionPolicy (character)

Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.IPartitionPolicy
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicy GetPartitionPolicy (integer)

Parameters:
pid INTEGER
Returns OpenEdge.DataAdmin.IPartitionPolicy
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicy GetPartitionPolicy (IRequestInfo)

Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IPartitionPolicy
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicyDetailSet GetPartitionPolicyDetails ()

Purpose: Get a collection of all partition policies details in the database
Returns OpenEdge.DataAdmin.IPartitionPolicyDetailSet
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicyDetailSet GetPartitionPolicyDetails (character)

Purpose: Get a collection of partition policies details
Parameters:
pFilter CHARACTER
Returns OpenEdge.DataAdmin.IPartitionPolicyDetailSet
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicyDetailSet GetPartitionPolicyDetails (IRequestInfo)

Purpose: Get a collection of partition policies details
Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IPartitionPolicyDetailSet
Top

PUBLIC OpenEdge.DataAdmin.IUserTablePermissionSet GetPermissions (character)

Parameters:
pccollections CHARACTER
Returns OpenEdge.DataAdmin.IUserTablePermissionSet
Top

PROTECTED CHARACTER GetPropertyValues (IDataAdminElement, character)

Parameters:
inst OpenEdge.DataAdmin.IDataAdminElement
pcKeyFields CHARACTER
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.IRole GetRole (character)

Purpose: Get a role
Parameters:
pcRoleName CHARACTER
Returns OpenEdge.DataAdmin.IRole
Top

PUBLIC OpenEdge.DataAdmin.IRole GetRole (IRequestInfo)

Purpose: Get a role
with optional request info children with QueryStrings for child collections
Parameters:
poRequest OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IRole
Top

PUBLIC OpenEdge.DataAdmin.IRoleSet GetRoles ()

Purpose: Get a collection of all security roles domains in the database
Returns OpenEdge.DataAdmin.IRoleSet
Top

PUBLIC OpenEdge.DataAdmin.IRoleSet GetRoles (character)

Purpose: Get a collection of roles in the database *
Parameters:
pcFilter CHARACTER
Returns OpenEdge.DataAdmin.IRoleSet
Top

PUBLIC OpenEdge.DataAdmin.IRoleSet GetRoles (IRequestInfo)

Purpose: Get a collection of all domains in the database
with optional request info children with QueryStrings for child collections
Parameters:
poRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IRoleSet
Top

PROTECTED OpenEdge.DataAdmin.Binding.IRow GetRowInfo (IDataAdminElement, IDataAdminModel)

Parameters:
inst OpenEdge.DataAdmin.IDataAdminElement
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
Returns OpenEdge.DataAdmin.Binding.IRow
Top

PUBLIC OpenEdge.DataAdmin.ISchema GetSchema ()

/* the service only supports "pub" schema so no key parameter
Returns OpenEdge.DataAdmin.ISchema
Top

PUBLIC OpenEdge.DataAdmin.ISchema GetSchema (character)

/* the service only supports "pub" schema so no key parameter
Parameters:
collectionFilter CHARACTER
Returns OpenEdge.DataAdmin.ISchema
Top

PUBLIC OpenEdge.DataAdmin.ISchema GetSchema (IRequestInfo)

/* the service only supports "pub" schema so no key parameter
Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ISchema
Top

PUBLIC OpenEdge.DataAdmin.ISchema GetSchemaChanges (character)

/* the service only supports "pub" schema so no key parameter
Parameters:
pcFile CHARACTER
Returns OpenEdge.DataAdmin.ISchema
Top

PUBLIC OpenEdge.DataAdmin.ISecurityOptions GetSecurityOptions ()

Returns OpenEdge.DataAdmin.ISecurityOptions
Top

PUBLIC OpenEdge.DataAdmin.ISequence GetSequence (character)

Parameters:
SeqName CHARACTER
Returns OpenEdge.DataAdmin.ISequence
Top

PUBLIC OpenEdge.DataAdmin.ISequence GetSequence (IRequestInfo)

Parameters:
reqInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ISequence
Top

PUBLIC OpenEdge.DataAdmin.ISequenceSet GetSequences ()

Returns OpenEdge.DataAdmin.ISequenceSet
Top

PUBLIC OpenEdge.DataAdmin.ISequenceSet GetSequences (character)

Parameters:
filter CHARACTER
Returns OpenEdge.DataAdmin.ISequenceSet
Top

PUBLIC OpenEdge.DataAdmin.ISequenceSet GetSequences (IRequestInfo)

Parameters:
reqInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ISequenceSet
Top

PUBLIC OpenEdge.DataAdmin.ITable GetTable (character)

Parameters:
tableName CHARACTER
Returns OpenEdge.DataAdmin.ITable
Top

PUBLIC OpenEdge.DataAdmin.ITable GetTable (character, character)

/* This method is introduced to support retrieval of PUB and non-PUB tables as part of CDC feature
Parameters:
tableName CHARACTER
owner CHARACTER
Returns OpenEdge.DataAdmin.ITable
Top

PUBLIC OpenEdge.DataAdmin.ITable GetTable (integer)

/* id mapped to field-number
Parameters:
id INTEGER
Returns OpenEdge.DataAdmin.ITable
Top

PUBLIC OpenEdge.DataAdmin.ITable GetTable (IRequestInfo)

Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ITable
Top

PUBLIC OpenEdge.DataAdmin.ITablePermission GetTablePermission (character)

Parameters:
pcName CHARACTER
Returns OpenEdge.DataAdmin.ITablePermission
Top

PUBLIC OpenEdge.DataAdmin.ITablePermissionSet GetTablePermissions ()

Returns OpenEdge.DataAdmin.ITablePermissionSet
Top

PUBLIC OpenEdge.DataAdmin.ITablePermissionSet GetTablePermissions (character)

Parameters:
filter CHARACTER
Returns OpenEdge.DataAdmin.ITablePermissionSet
Top

PUBLIC OpenEdge.DataAdmin.ITableSet GetTables ()

Returns OpenEdge.DataAdmin.ITableSet
Top

PUBLIC OpenEdge.DataAdmin.ITableSet GetTables (character)

Parameters:
filter CHARACTER
Returns OpenEdge.DataAdmin.ITableSet
Top

PUBLIC OpenEdge.DataAdmin.ITableSet GetTables (IRequestInfo)

Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ITableSet
Top

PUBLIC OpenEdge.DataAdmin.ITenant GetTenant (character)

Parameters:
tenantName CHARACTER
Returns OpenEdge.DataAdmin.ITenant
Top

PUBLIC OpenEdge.DataAdmin.ITenant GetTenant (integer)

Parameters:
tenantId INTEGER
Returns OpenEdge.DataAdmin.ITenant
Top

PUBLIC OpenEdge.DataAdmin.ITenant GetTenant (IRequestInfo)

Parameters:
req OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ITenant
Top

PUBLIC OpenEdge.DataAdmin.ITenant GetTenantByExternalId (character)

Parameters:
extId CHARACTER
Returns OpenEdge.DataAdmin.ITenant
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroup GetTenantGroup (character)

Parameters:
groupName CHARACTER
Returns OpenEdge.DataAdmin.ITenantGroup
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroup GetTenantGroup (integer)

Parameters:
groupId INTEGER
Returns OpenEdge.DataAdmin.ITenantGroup
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroup GetTenantGroup (IRequestInfo)

Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ITenantGroup
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroupSet GetTenantGroups ()

Returns OpenEdge.DataAdmin.ITenantGroupSet
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroupSet GetTenantGroups (character)

Parameters:
filter CHARACTER
Returns OpenEdge.DataAdmin.ITenantGroupSet
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroupSet GetTenantGroups (IRequestInfo)

Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ITenantGroupSet
Top

PUBLIC OpenEdge.DataAdmin.ITenantSet GetTenants ()

Returns OpenEdge.DataAdmin.ITenantSet
Top

PUBLIC OpenEdge.DataAdmin.ITenantSet GetTenants (character)

Parameters:
filter CHARACTER
Returns OpenEdge.DataAdmin.ITenantSet
Top

PUBLIC OpenEdge.DataAdmin.ITenantSet GetTenants (IRequestInfo)

Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ITenantSet
Top

PUBLIC OpenEdge.DataAdmin.IUser GetUser (character)

Parameters:
usrID CHARACTER
Returns OpenEdge.DataAdmin.IUser
Top

PUBLIC OpenEdge.DataAdmin.IUserPermission GetUserPermission (character)

Parameters:
usrID CHARACTER
Returns OpenEdge.DataAdmin.IUserPermission
Top

PUBLIC OpenEdge.DataAdmin.IUserPermissionSet GetUserPermissions ()

Returns OpenEdge.DataAdmin.IUserPermissionSet
Top

PUBLIC OpenEdge.DataAdmin.IUserPermissionSet GetUserPermissions (character)

Parameters:
filter CHARACTER
Returns OpenEdge.DataAdmin.IUserPermissionSet
Top

PUBLIC OpenEdge.DataAdmin.IUserSet GetUsers ()

Returns OpenEdge.DataAdmin.IUserSet
Top

PUBLIC OpenEdge.DataAdmin.IUserSet GetUsers (character)

Parameters:
pcfilter CHARACTER
Returns OpenEdge.DataAdmin.IUserSet
Top

PUBLIC OpenEdge.DataAdmin.IUserSet GetUsers (IRequestInfo)

Parameters:
pReq OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IUserSet
Top

PUBLIC LOGICAL LoadSchemaChanges (character)

Parameters:
pcFile CHARACTER
Returns LOGICAL
Top

PUBLIC OpenEdge.DataAdmin.IArea NewArea (character)

Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.IArea
Top

PUBLIC OpenEdge.DataAdmin.IAreaSet NewAreas ()

Returns OpenEdge.DataAdmin.IAreaSet
Top

PUBLIC OpenEdge.DataAdmin.IAuthenticationSystem NewAuthenticationSystem (character)

Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.IAuthenticationSystem
Top

PUBLIC OpenEdge.DataAdmin.IAuthenticationSystemSet NewAuthenticationSystems ()

Returns OpenEdge.DataAdmin.IAuthenticationSystemSet
Top

PUBLIC OpenEdge.DataAdmin.ICdcFieldPolicy NewCdcFieldPolicy ()

Returns OpenEdge.DataAdmin.ICdcFieldPolicy
Top

PUBLIC OpenEdge.DataAdmin.ICdcTablePolicySet NewCdcTablePolicies ()

Returns OpenEdge.DataAdmin.ICdcTablePolicySet
Top

PUBLIC OpenEdge.DataAdmin.ICdcTablePolicy NewCdcTablePolicy (character)

Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.ICdcTablePolicy
Top

PUBLIC OpenEdge.DataAdmin.IDataAdminCollection NewCollection (character)

Purpose: returns a new collection of the specified serializename, entity name or physical database filename
Parameters:
pcType CHARACTER
Returns OpenEdge.DataAdmin.IDataAdminCollection
Top

PUBLIC OpenEdge.DataAdmin.IDatabaseOption NewDatabaseOption (character)

Purpose: Get a new, empty db option
Expected to be passed to CreateDatabaseOption() to be created in the database or added to a new or
existing IDatabaseOptionSet collection, to be submitted to the database with the collection.
Parameters:
pcOptionCode CHARACTER
Returns OpenEdge.DataAdmin.IDatabaseOption
IDatabaseOption The new dboption
Top

PUBLIC OpenEdge.DataAdmin.IDatabaseOptionSet NewDatabaseOptions ()

Purpose: Get an empty dboption collection
Add new options to the collection and pass it to CreateDatabaseOptions() to create the
options in the database.
Returns OpenEdge.DataAdmin.IDatabaseOptionSet
IDatabaseOptionSet A new empty collection of dboptions
Top

PUBLIC OpenEdge.DataAdmin.IDomain NewDomain (character)

Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.IDomain
Top

PUBLIC OpenEdge.DataAdmin.IDomainSet NewDomains ()

Returns OpenEdge.DataAdmin.IDomainSet
Top

PROTECTED OpenEdge.DataAdmin.IDataAdminElement NewEntity (character, character)

/* NOTE - must define context variable here or else the
context gets garbage collected when NewEntity ends
before the entity is returned -
- this is likely no longer true
Parameters:
pcType CHARACTER
pname CHARACTER
Returns OpenEdge.DataAdmin.IDataAdminElement
Top

PUBLIC OpenEdge.DataAdmin.IExtent NewExtent ()

Returns OpenEdge.DataAdmin.IExtent
Top

PUBLIC OpenEdge.DataAdmin.IGrantedRole NewGrantedRole ()

Purpose: Get a new granted role
Returns OpenEdge.DataAdmin.IGrantedRole
IGrantedRole The new grant role
Top

PUBLIC OpenEdge.DataAdmin.IGrantedRoleSet NewGrantedRoles ()

Purpose: Get a new granted role
Expected to be added to an instance of IRole and submitted that way.
Returns OpenEdge.DataAdmin.IGrantedRoleSet
IGrantedRoleSet The new grant set
Top

PUBLIC OpenEdge.DataAdmin.IIndex NewIndex ()

Returns OpenEdge.DataAdmin.IIndex
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicySet NewPartitionPolicies ()

Returns OpenEdge.DataAdmin.IPartitionPolicySet
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicy NewPartitionPolicy (character)

Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.IPartitionPolicy
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicyDetail NewPartitionPolicyDetail (character)

/* using the service's UpdateTable() or UpdateTables() methods.
Parameters:
pName CHARACTER
Returns OpenEdge.DataAdmin.IPartitionPolicyDetail
Top

PUBLIC OpenEdge.DataAdmin.IRole NewRole (character)

Purpose: Get a new role
Expected to be passed to CreateDomain() to be created in the database or added to a new or
existing IRoleSet collection, to be submitted to the database with the collection.
Parameters:
pcRoleName CHARACTER
Returns OpenEdge.DataAdmin.IRole
IRole The new role
Top

PUBLIC OpenEdge.DataAdmin.IRoleSet NewRoles ()

Purpose: Get an empty role collection
Add new roles to the collection and pass it to CreateRoles() to create the roles in the database.
Returns OpenEdge.DataAdmin.IRoleSet
IRoleSet A new empty colleciton of roles
Top

PUBLIC OpenEdge.DataAdmin.ISequence NewSequence (character)

Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.ISequence
Top

PUBLIC OpenEdge.DataAdmin.ISequenceSet NewSequences ()

Returns OpenEdge.DataAdmin.ISequenceSet
Top

PUBLIC OpenEdge.DataAdmin.ITenant NewTenant (character)

Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.ITenant
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroup NewTenantGroup (character)

Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.ITenantGroup
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroupMember NewTenantGroupMember ()

Returns OpenEdge.DataAdmin.ITenantGroupMember
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroupSet NewTenantGroups ()

Returns OpenEdge.DataAdmin.ITenantGroupSet
Top

PUBLIC OpenEdge.DataAdmin.ITenantSet NewTenants ()

Returns OpenEdge.DataAdmin.ITenantSet
Top

PUBLIC OpenEdge.DataAdmin.IUser NewUser (character)

Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.IUser
Top

PUBLIC OpenEdge.DataAdmin.IUserSet NewUsers ()

Returns OpenEdge.DataAdmin.IUserSet
Top

PUBLIC Progress.Lang.Error RemoveError ()

Returns Progress.Lang.Error
Top

PROTECTED OpenEdge.DataAdmin.Message.ISaveRequest SaveData (ISaveRequest)

Parameters:
msg OpenEdge.DataAdmin.Message.ISaveRequest
Returns OpenEdge.DataAdmin.Message.ISaveRequest
Top

PUBLIC ThrowError ()

Top

PUBLIC LOGICAL UpdateAdministrator (IAdministrator)

Parameters:
admin OpenEdge.DataAdmin.IAdministrator
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateArea (IArea)

Parameters:
area OpenEdge.DataAdmin.IArea
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateAreas (IAreaSet)

Parameters:
areas OpenEdge.DataAdmin.IAreaSet
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateAuthenticationSystem (IAuthenticationSystem)

Parameters:
authenticationsystem OpenEdge.DataAdmin.IAuthenticationSystem
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateAuthenticationSystems (IAuthenticationSystemSet)

Parameters:
authenticationsystems OpenEdge.DataAdmin.IAuthenticationSystemSet
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateCdcTablePolicies (ICdcTablePolicySet)

Parameters:
policy OpenEdge.DataAdmin.ICdcTablePolicySet
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateCdcTablePolicy (ICdcTablePolicy)

Parameters:
policy OpenEdge.DataAdmin.ICdcTablePolicy
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateCollection (IDataAdminCollection)

Purpose: Update a collection
Parameters:
pccol OpenEdge.DataAdmin.IDataAdminCollection
Returns LOGICAL
Top

PROTECTED LOGICAL UpdateCollection (IDataAdminCollection, IDataAdminContext)

/* base update method
Parameters:
inst OpenEdge.DataAdmin.IDataAdminCollection
cntxt OpenEdge.DataAdmin.Binding.IDataAdminContext
Returns LOGICAL
Top

PROTECTED LOGICAL UpdateContext (IDataAdminContext)

/* base update method (not used by all)
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminContext
Returns LOGICAL
Top

PROTECTED LOGICAL UpdateContext (IDataAdminContext, character)

/* base update method
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminContext
pSourceId CHARACTER
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateDatabaseOption (IDatabaseOption)

Purpose: Update the database with a changed dboption
Parameters:
poDbOption OpenEdge.DataAdmin.IDatabaseOption
Returns LOGICAL
logical TRUE if the option was updated
Top

PUBLIC LOGICAL UpdateDatabaseOptions (IDatabaseOptionSet)

Purpose: Update the database with changes for many dboptions
Parameters:
poDbOptions OpenEdge.DataAdmin.IDatabaseOptionSet
Returns LOGICAL
logical TRUE if the options were updated
Top

PUBLIC LOGICAL UpdateDataSecurity (IDataSecurity)

Parameters:
pinst OpenEdge.DataAdmin.IDataSecurity
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateDomain (IDomain)

Parameters:
domain OpenEdge.DataAdmin.IDomain
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateDomains (IDomainSet)

Parameters:
domains OpenEdge.DataAdmin.IDomainSet
Returns LOGICAL
Top

PROTECTED LOGICAL UpdateElement (character, IDataAdminElement, IDataAdminContext)

/* base update method (not used by all)
Parameters:
pkey CHARACTER
inst OpenEdge.DataAdmin.IDataAdminElement
cntxt OpenEdge.DataAdmin.Binding.IDataAdminContext
Returns LOGICAL
Top

PROTECTED LOGICAL UpdateElement (IDataAdminElement, IDataAdminModel)

/* base update method (not used by all)
Parameters:
inst OpenEdge.DataAdmin.IDataAdminElement
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateGrantedRole (IGrantedRole)

Purpose: Update the database with a changed role grant
Parameters:
poGrant OpenEdge.DataAdmin.IGrantedRole
Returns LOGICAL
logical TRUE if the option was updated
Top

PUBLIC LOGICAL UpdateGrantedRoles (IGrantedRoleSet)

Purpose: Update the database with changes for many granted roles
Parameters:
poGrants OpenEdge.DataAdmin.IGrantedRoleSet
Returns LOGICAL
logical TRUE if the options were updated
Top

PUBLIC LOGICAL UpdatePartitionPolicies (IPartitionPolicySet)

Purpose: Update the database with partition policies with changes
Parameters:
policy OpenEdge.DataAdmin.IPartitionPolicySet
Returns LOGICAL
Top

PUBLIC LOGICAL UpdatePartitionPolicy (IPartitionPolicy)

Purpose: Update the database with partition policy changes
Parameters:
policy OpenEdge.DataAdmin.IPartitionPolicy
IPartitionPolicy to be created */
Returns LOGICAL
Top

PRIVATE LOGICAL UpdatePartitions ()

/*todo - pass iPartitioncollection
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateRole (IRole)

Purpose: Update the database with a changed security role
Parameters:
poRole OpenEdge.DataAdmin.IRole
Returns LOGICAL
logical TRUE if the option was updated
Top

PUBLIC LOGICAL UpdateRoles (IRoleSet)

Purpose: Update the database with changes for many roles
Parameters:
poRoles OpenEdge.DataAdmin.IRoleSet
Returns LOGICAL
logical TRUE if the options were updated
Top

PUBLIC LOGICAL UpdateSchema (ISchema)

Parameters:
pschema OpenEdge.DataAdmin.ISchema
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateSchemaChanges (ISchema)

Parameters:
pschema OpenEdge.DataAdmin.ISchema
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateSecurityOptions (ISecurityOptions)

Parameters:
secopt OpenEdge.DataAdmin.ISecurityOptions
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateSequence (ISequence)

Parameters:
seq OpenEdge.DataAdmin.ISequence
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateSequences (ISequenceSet)

Parameters:
sequences OpenEdge.DataAdmin.ISequenceSet
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTable (ITable)

Parameters:
tableimpl OpenEdge.DataAdmin.ITable
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTablePermission (ITablePermission)

Parameters:
tableperm OpenEdge.DataAdmin.ITablePermission
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTablePermissions (ITablePermissionSet)

Parameters:
tableperms OpenEdge.DataAdmin.ITablePermissionSet
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTables (ITableSet)

Parameters:
Tables OpenEdge.DataAdmin.ITableSet
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTenant (ITenant)

Parameters:
ptnt OpenEdge.DataAdmin.ITenant
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTenantGroup (ITenantGroup)

Parameters:
tenantGroup OpenEdge.DataAdmin.ITenantGroup
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTenantGroups (ITenantGroupSet)

Parameters:
tenantGroups OpenEdge.DataAdmin.ITenantGroupSet
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTenants (ITenantSet)

Parameters:
tenants OpenEdge.DataAdmin.ITenantSet
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateUser (IUser)

/* method public logical AttachPartitions(partitions as IPartitionMap):
do on error undo, throw:
partitions:Attach(ContextFactory:PartitionContext). Attach(ContextFactory:PartitionContext).
/* SaveData(PartitionContext).
catch e as Progress.Lang.Error:
ErrorHandler(e).
return false.
end catch.
end.
return true.
end method.
Parameters:
usr OpenEdge.DataAdmin.IUser
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateUsers (IUserSet)

Parameters:
users OpenEdge.DataAdmin.IUserSet
Returns LOGICAL
Top

PRIVATE ValidUserId (character, character, character)

/* todo - use UserContext somehow
Parameters:
id CHARACTER
pdomain CHARACTER
puser CHARACTER


Constructor Detail
Top

PUBLIC DataAdminService ()

Top

PUBLIC DataAdminService (character)

Parameters:
name CHARACTER
Top

PUBLIC DataAdminService (character, character)

Parameters:
path CHARACTER
name CHARACTER


Event Detail
Top

PUBLIC ServiceDeleted ()



Property Detail
Top

PRIVATE OpenEdge.DataAdmin.Binding.SchemaChanges CurrentSchemaChanges

Returns OpenEdge.DataAdmin.Binding.SchemaChanges
Top

PRIVATE OpenEdge.DataAdmin.Error.OperationError Error

Returns OpenEdge.DataAdmin.Error.OperationError
Top

PUBLIC CHARACTER Name

Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.Core.IPasswordPolicy PasswordPolicy

Returns OpenEdge.DataAdmin.Core.IPasswordPolicy
Top

PUBLIC LOGICAL ThrowDataErrors

Returns LOGICAL
Top

PUBLIC OpenEdge.DataAdmin.Core.FileLogger TransactionLogger

Returns OpenEdge.DataAdmin.Core.FileLogger
Top

PUBLIC CHARACTER URL

Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.Util.IUtilityFactory UtilityFactory

Returns OpenEdge.DataAdmin.Util.IUtilityFactory


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0