Namespace: OpenEdge.DataAdmin
Interface
IDataAdminService
Parent classes:
Inherits: Progress.Lang.Object

/* Copyright (c) 2014-2016,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) and ExecuteUtility for IDataAdminUtility
instances.
Author(s):hdaniels
Created:Sat Jul 10 23:27:42 EDT 2010
Purpose: published when the service is deleted - considered internal




Method Summary
Options Name Purpose
LOGICAL CancelSchemaChanges () /** Cancel current schema changes The service only supports one active context retrieved with GetShemaChanges(). Use this before calling GetShemaChanges again if the returned schema was not passed to UpdateSchemaChanges() */
LOGICAL CreateArea (IArea) /** Create a new area @param IArea to be created */
LOGICAL CreateAreas (IAreaSet) /** Create new areas @param IAreaSet with a collection of areas to create */
LOGICAL CreateAuthenticationSystem (IAuthenticationSystem) /** Create a new authentication system @param system IAuthenticationSystem to be created */
LOGICAL CreateAuthenticationSystems (IAuthenticationSystemSet) /** Create new authentication systems @param systems IAuthenticationSystemSet with a collection of authentication systems to create */
LOGICAL CreateCdcTablePolicies (ICdcTablePolicySet) /** Create a new cdc table policy @param policies ICdcTablePolicySet with policies to be created */
LOGICAL CreateCdcTablePolicy (ICdcTablePolicy) /** Create a new cdc table policy @param policy ICdcTablePolicy to be created */
LOGICAL CreateCollection (IDataAdminCollection) /** create a collection */
LOGICAL CreateDatabaseOption (IDatabaseOption) /** Create a new database option @param IDatabaseOption The role to be created @return logical TRUE if the dboption was created */
LOGICAL CreateDatabaseOptions (IDatabaseOptionSet) /** Create new database options @param IDatabaseOptionSet A collection of roles to create @return logical TRUE if the dboptions were created */
LOGICAL CreateDomain (IDomain) /** Create a new domain @param domain IDomain to be created */
LOGICAL CreateDomains (IDomainSet) /** Create new domains @param domains IDomainSet with a collection of domains to create */
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) /** Create a new sequence @param sequence ISequence to be created */
LOGICAL CreateSequences (ISequenceSet) /** Create new sequences @param sequences ISequenceSet with a collection of sequences to create */
LOGICAL CreateTenant (ITenant) /** Create a new tenant @param ITenant to be created */
LOGICAL CreateTenantGroup (ITenantGroup) /** Create a new group @param group ITenantGroup to be created */
LOGICAL CreateTenantGroups (ITenantGroupSet) /** Create new groups @param groups ITenantGroupSet with a collection of groups to create */
LOGICAL CreateTenants (ITenantSet) /** Create new tenants @param tenants ITenantSet with a collection of tenants to create */
LOGICAL CreateUser (IUser) /** Create a new user @param user IUser to be created */
LOGICAL CreateUsers (IUserSet) /** Create new users @param users IUserSet with a collection of users to create */
LOGICAL DeleteAuthenticationSystem (character) /** Delete authentication system @param authenticationsystemName name of authentication system to delete. @throws NotFoundError if authentication system does not exist. */
LOGICAL DeleteCdcTablePolicy (character) /** Delete CdcTablePolicy @param cdc table policyName name of policy to delete. @throws NotFoundError if policy does not exist. */
LOGICAL DeleteDomain (character) /** Delete domain @param domainName name of domain to delete @throws NotFoundError if domain does not exist */
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) /** Delete sequence @param sequenceName name of sequence to delete. @throws NotFoundError if sequence does not exist. */
LOGICAL DeleteTenant (character) /** Delete tenant @param tenantName name of tenant to delete. @throws NotFoundError if tenant does not exist. */
LOGICAL DeleteTenantGroup (character) /** Delete group @param groupName name of group to delete. @throws NotFoundError if group does not exist. */
LOGICAL DeleteUser (character) /** Delete domain @param domainName name of domain to delete @throws NotFoundError if user does not exist */
ExecuteUtility (IDataAdminUtility) /** Execute the ulitility */
OpenEdge.DataAdmin.IAdministrator GetAdministrator () /* get administrator - has administrator user ids */
OpenEdge.DataAdmin.IArea GetArea (character) /** Get an area @param areaname name of area */
OpenEdge.DataAdmin.IArea GetArea (integer) /** Get an area @param areaName Number of area */
OpenEdge.DataAdmin.IArea GetArea (IRequestInfo) /** Get an area @param IRequestinfo that defines an expression that uniqely identifies an area */
OpenEdge.DataAdmin.IAreaSet GetAreas () /** Get a collection of all areas in the database */
OpenEdge.DataAdmin.IAreaSet GetAreas (character) /** Get a collection of areas in the database * @param filter a character query expression of area properties */
OpenEdge.DataAdmin.IAreaSet GetAreas (IRequestInfo) /** Get a collection of all areas in the database @param IRequestinfo with a QueryString that defines an expression of area properties */
OpenEdge.DataAdmin.IAuthenticationSystem GetAuthenticationSystem (character) /** Get a authentication system @param systemName name of authentication system */
OpenEdge.DataAdmin.IAuthenticationSystemSet GetAuthenticationSystems () /** Get a collection of all authentication systems in the database */
OpenEdge.DataAdmin.IAuthenticationSystemSet GetAuthenticationSystems (character) /** Get a collection of authentication systems in the database * @param filter a character query expression of authentication system properties */
OpenEdge.DataAdmin.IAuthenticationSystemSet GetAuthenticationSystems (IRequestInfo) /** Get a collection of authentication systems in the database * @param IRequestinfo with a QueryString that defines an expression of authentication system properties */
OpenEdge.DataAdmin.ICdcFieldPolicySet GetCdcFieldPolicies () /** Get a collection of all CdcField policies in the database */
OpenEdge.DataAdmin.ICdcFieldPolicySet GetCdcFieldPolicies (character) /** Get a collection of CdcField policies @param filter */
OpenEdge.DataAdmin.ICdcFieldPolicySet GetCdcFieldPolicies (IRequestInfo) /** Get a collection of CdcField policies @param request IRequestInfo*/
OpenEdge.DataAdmin.ICdcTablePolicySet GetCdcTablePolicies () /** Get a collection of all CdcTable policies in the database */
OpenEdge.DataAdmin.ICdcTablePolicySet GetCdcTablePolicies (character) /** Get a collection of CdcField policies @param filter */
OpenEdge.DataAdmin.ICdcTablePolicySet GetCdcTablePolicies (IRequestInfo) /** Get a collection of CdcTable policies @param request IRequestInfo*/
OpenEdge.DataAdmin.ICdcTablePolicy GetCdcTablePolicy (character) /** Get a CdcTablePolicy @param name char of CdcTablePolicy*/
OpenEdge.DataAdmin.ICdcTablePolicy GetCdcTablePolicy (IRequestInfo) /** Get a CdcTablePolicy @param request 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) /** Get data security @param domainName name of data security */
OpenEdge.DataAdmin.IDomain GetDomain (character) /** Get a domain @param domainName name of domain */
OpenEdge.DataAdmin.IDomain GetDomain (IRequestInfo) /** Get a domain @param IRequestinfo that defines an expression that uniqely identifies a domain with optional request info children with QueryStrings for child collections */
OpenEdge.DataAdmin.IDomainSet GetDomains () /** Get a collection of all domains in the database */
OpenEdge.DataAdmin.IDomainSet GetDomains (character) /** Get a collection of domains in the database * @param filter a character query expression of domain properties */
OpenEdge.DataAdmin.IDomainSet GetDomains (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 */
Progress.Lang.Error GetError () /** Get the last error from a failed operation when ThrowDataErrors is false. */
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 all partition policies in the database */
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) /** Get a PartitionPolicy @param name char of PartitionPolicy*/
OpenEdge.DataAdmin.IPartitionPolicy GetPartitionPolicy (integer) /** Get a PartitionPolicy @param object number int of PartitionPolicy*/
OpenEdge.DataAdmin.IPartitionPolicy GetPartitionPolicy (IRequestInfo) /** Get a PartitionPolicy @param request 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) /** Get a collection of permissions for the specified collections @param collections a comma separated list of collections known by the service */
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.ISchema GetSchema () /** Get the Schema - the service only supports "PUB" schema */
OpenEdge.DataAdmin.ISchema GetSchema (IRequestInfo) /** the service only supports "pub" schema so no key parameter */
OpenEdge.DataAdmin.ISchema GetSchemaChanges (character) /** Get a schema with changes from the specified schema file (.df) The Partitions property will have all new partitions that were created after the schema is passed to LoadSchemaChanges */
OpenEdge.DataAdmin.ISequence GetSequence (character) /** Get a sequence @param sequenceName name of sequence */
OpenEdge.DataAdmin.ISequence GetSequence (IRequestInfo) /** Get a sequence @param IRequestinfo that defines an expression that uniqely identifies a sequence with optional request info children with QueryStrings for child collections */
OpenEdge.DataAdmin.ISequenceSet GetSequences () /** Get a collection of sequences in the database */
OpenEdge.DataAdmin.ISequenceSet GetSequences (character) /** Get a collection of sequences in the database @param filter a character query expression of sequence properties */
OpenEdge.DataAdmin.ISequenceSet GetSequences (IRequestInfo) /** Get a collection of sequences in the database @param filter a character query expression of sequence properties with optional request info children with QueryStrings for child collections */
OpenEdge.DataAdmin.ITable GetTable (character) /** Get a table @param tableName name of table */
OpenEdge.DataAdmin.ITable GetTable (character, character) /** Get a table @param tableName name of table @param owner name of the table owner*/
OpenEdge.DataAdmin.ITable GetTable (integer) /** Get a table @param id (_field-number) */
OpenEdge.DataAdmin.ITable GetTable (IRequestInfo) /** Get a table @param IRequestinfo that defines an expression that uniqely identifies a tenant group with optional request info children with QueryStrings for child collections */
OpenEdge.DataAdmin.ITablePermission GetTablePermission (character) /** Get a table permission @param tableName name of table permission */
OpenEdge.DataAdmin.ITablePermissionSet GetTablePermissions () /** Get a collection of all table permissions in the database */
OpenEdge.DataAdmin.ITablePermissionSet GetTablePermissions (character) /** Get a collection of table permissions in the database * @param filter a character query expression of table permission properties */
OpenEdge.DataAdmin.ITableSet GetTables () /** Get a collection of all tables in the database */
OpenEdge.DataAdmin.ITableSet GetTables (character) /** Get a collection of tables in the database * @param filter a character query expression of table properties */
OpenEdge.DataAdmin.ITableSet GetTables (IRequestInfo) /** Get a collection of tables in the database * @param filter a character query expression of table properties with optional request info children with QueryStrings for child collections */
OpenEdge.DataAdmin.ITenant GetTenant (character) /** Get a tenant @param tenantName name of tenant */
OpenEdge.DataAdmin.ITenant GetTenant (integer) /** Get a tenant @param tenantId integer of of tenant */
OpenEdge.DataAdmin.ITenant GetTenant (IRequestInfo) /** Get a tenant @param IRequestinfo that defines an expression that uniqely identifies a tenant with optional request info children with QueryStrings for child collections */
OpenEdge.DataAdmin.ITenant GetTenantByExternalId (character) /** Get a tenant by external id @param external id that uniquely identifes a tenant Use GetTenants() with filter or Requestinfo with query expression on the external id if the value is not unique */
OpenEdge.DataAdmin.ITenantGroup GetTenantGroup (character) /** Get a tenant group @param groupName name of tenant group */
OpenEdge.DataAdmin.ITenantGroup GetTenantGroup (integer) /** Get a tenant group @param groupId Id of tenant group */
OpenEdge.DataAdmin.ITenantGroup GetTenantGroup (IRequestInfo) /** Get a tenant group @param IRequestinfo that defines an expression that uniqely identifies a tenant group with optional request info children with QueryStrings for child collections */
OpenEdge.DataAdmin.ITenantGroupSet GetTenantGroups () /** Get a collection of all tenant groups in the database */
OpenEdge.DataAdmin.ITenantGroupSet GetTenantGroups (character) /** Get a collection of tenant groups in the database * @param filter a character query expression of group properties */
OpenEdge.DataAdmin.ITenantGroupSet GetTenantGroups (IRequestInfo) /** Get a collection of tenant groups in the database * @param filter a character query expression of group properties with optional request info children with QueryStrings for child collections */
OpenEdge.DataAdmin.ITenantSet GetTenants () /** Get a collection of all tenants in the database */
OpenEdge.DataAdmin.ITenantSet GetTenants (character) /** Get a collection of tenants in the database @param filter a character query expression of tenant properties */
OpenEdge.DataAdmin.ITenantSet GetTenants (IRequestInfo) /** Get a collection of tenants in the database @param filter a character query expression of tenant properties with optional request info children with QueryStrings for child collections */
OpenEdge.DataAdmin.IUser GetUser (character) /** Get a user @param userid user id of user in the form <name>@<domain> */
OpenEdge.DataAdmin.IUserPermission GetUserPermission (character) /** Get a user permission @param userid user id of user in the form <name>@<domain> the user id does not need to exist */
OpenEdge.DataAdmin.IUserPermissionSet GetUserPermissions () /** Get a collection of all user permissions in the database */
OpenEdge.DataAdmin.IUserPermissionSet GetUserPermissions (character) /** Get a collection of user permissions in the database @param filter a character query expression of user permission properties */
OpenEdge.DataAdmin.IUserSet GetUsers () /** Get a collection of all users in the database */
OpenEdge.DataAdmin.IUserSet GetUsers (character) /** Get a collection of users in the database * @param filter a character query expression of user properties */
OpenEdge.DataAdmin.IUserSet GetUsers (IRequestInfo) /** Get a collection of users in the database * @param filter a character query expression of user properties. */
LOGICAL LoadSchemaChanges (character) /** Load schema changes in the datbase from the specified schema file (.df) */
OpenEdge.DataAdmin.IArea NewArea (character) /** Get a new area Expected to be passed to CreateArea() to be created in the database or added to a new or existing IAreaSet collection to be submitted to the database with the collection. @param areaname name of the new area */
OpenEdge.DataAdmin.IAreaSet NewAreas () /** Get an empty area collection Add new areas to the collection and pass it to CreateAreas() to create the areas in the database. */
OpenEdge.DataAdmin.IAuthenticationSystem NewAuthenticationSystem (character) /** Get a new authentication system Expected to be passed to CreateAuthenticationSystem() to be created in the database or added to a new or existing IAuthenticationSystemSet collection to be submitted to the database with the collection. @param systemName name of the new authentication system */
OpenEdge.DataAdmin.IAuthenticationSystemSet NewAuthenticationSystems () /** Get an empty authentication system collection Add new authentication systems to the collection and pass it to CreateAuthenticationSystems() to create the authentication systems in the database. */
OpenEdge.DataAdmin.ICdcFieldPolicy NewCdcFieldPolicy () /* using the service's UpdateTable() or UpdateTables() methods.*/
OpenEdge.DataAdmin.ICdcTablePolicySet NewCdcTablePolicies () /** Get an empty cdc table policy collection */
OpenEdge.DataAdmin.ICdcTablePolicy NewCdcTablePolicy (character) /** Get an empty cdc table policy */
OpenEdge.DataAdmin.IDataAdminCollection NewCollection (character) /** Get 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 roles 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) /** Get a new domain Expected to be passed to CreateDomain() to be created in the database or added to a new or existing IDomainSet collection, including the ITenant:Domains, to be submitted to the database with the collection. @param domainName name of the new domain */
OpenEdge.DataAdmin.IDomainSet NewDomains () /** Get an empty domain collection Add new domains to the collection and pass it to CreateDomains() to create the domains in the database. */
OpenEdge.DataAdmin.IExtent NewExtent () /** Get a new extent Expected to be added to an IArea:Extents collection to be submitted to the database using the service's CreateArea() or UpdateAreas() methods.*/
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 () /** Get a new index Expected to be added to an ITable:Indexes collection to be submitted to the database using the service's CreateTable() or UpdateTables() methods.*/
OpenEdge.DataAdmin.IPartitionPolicySet NewPartitionPolicies () /** Get an empty partition policy collection */
OpenEdge.DataAdmin.IPartitionPolicy NewPartitionPolicy (character) /** Get an empty partition policy */
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 CreateRole() 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) /** Get a new sequence Expected to be passed to CreateSequence to be created in the database or added to a new or existing ISequenceSet collection to be submitted to the database with the collection. @param userid user id of user in the form <name>@<domain> */
OpenEdge.DataAdmin.ISequenceSet NewSequences () /** Get an empty sequence collection Add new sequences to the collection and pass it to CreateSequences() to create the sequences in the database. */
OpenEdge.DataAdmin.ITenant NewTenant (character) /** Get a new tenant Expected to be passed to CreateTenant() to be created in the database or added to a new or existing ITenantSet collection to be submitted to the database with the collection. @param tenantName name of the new tenant */
OpenEdge.DataAdmin.ITenantGroup NewTenantGroup (character) /** Get a new tenant group Expected to be passed to CreateTenantGroup() to be created in the database or added to a new or existing ITenantGroupSet collection to be submitted to the database with the collection. @param groupName name of the new tenant group */
OpenEdge.DataAdmin.ITenantGroupMember NewTenantGroupMember () /** Get a new tenant group member Expected to be added to an ITenant or ITenantGroup TenantGroupMembers collection to be submitted to the database using the service's CreateTenants() or UpdateTenants() methods.*/
OpenEdge.DataAdmin.ITenantGroupSet NewTenantGroups () /** Get an empty tenant group collection Add new tenant groups to the collection and pass it to CreateTenantGroups() to create the tenants in the database. */
OpenEdge.DataAdmin.ITenantSet NewTenants () /** Get an empty tenant collection Add new tenants to the collection and pass it to CreateTenants() to create the tenants in the database. */
OpenEdge.DataAdmin.IUser NewUser (character) /** Get a new user Expected to be passed to CreateUser to be created in the database or added to a new or existing IUserSet collection, including ITenant:Users or IDomin:Users to be submitted to the database with the collection. @param userid user id of user in the form <name>@<domain> */
OpenEdge.DataAdmin.IUserSet NewUsers () /** Get an empty user collection Add new users to the collection and pass it to CreateUsers() to create the users in the database. */
Progress.Lang.Error RemoveError () /** Removes and returns the last error from a failed operation when ThrowDataErrors is false. */
ThrowError () /** Throw the last error from a failed operation when ThrowDataErrors is false. The error is also removed from the service. */
LOGICAL UpdateAdministrator (IAdministrator) /** Update the database with administrator changes @param admin IAdministrator */
LOGICAL UpdateArea (IArea) /** Update the database with new extents added to the area @param area IArea */
LOGICAL UpdateAreas (IAreaSet) /** Update the database with new extents added to the areas in the collection @param areas IAreaset collection */
LOGICAL UpdateAuthenticationSystem (IAuthenticationSystem) /** Update the database with authentication system changes @param authenticationSystem IAuthenticationSystem */
LOGICAL UpdateAuthenticationSystems (IAuthenticationSystemSet) /** Update the database with changes for many authentication systems @param authenticationSystems IAuthenticationSystemSet collection */
LOGICAL UpdateCdcTablePolicies (ICdcTablePolicySet) /** Update the database with cdc table policies with changes @param policies ICdcTablePolicySet with policies to be updated */
LOGICAL UpdateCdcTablePolicy (ICdcTablePolicy) /** Update the database with cdc table policy changes @param policy ICdcTablePolicy to be created */
LOGICAL UpdateCollection (IDataAdminCollection) /** Update a collection */
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) /** Update the database with security changes @param securityInstance IDataSecurity */
LOGICAL UpdateDomain (IDomain) /** Update the database with domain changes @param domain IDomain */
LOGICAL UpdateDomains (IDomainSet) /** Update the database with changes for many domains @param domains IDomainSet collection */
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 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) /** Update the database with partition changes on new partitions created when the schema definitions were added to the database with pdateSchemaChanges @param schema ISchema */
LOGICAL UpdateSchemaChanges (ISchema) /** Update the database with schema changes returned from GetSchemaChanges @param schema ISchema */
LOGICAL UpdateSequence (ISequence) /** Update the database with sequence changes @param sequence ISequence */
LOGICAL UpdateSequences (ISequenceSet) /** Update the database with changes for many sequences @param sequences ISequenceSet collection */
LOGICAL UpdateTable (ITable) /** Update the database with table changes @param table ITable */
LOGICAL UpdateTablePermission (ITablePermission) /** Update the database with table permission changes @param tablePermission ITablePermission */
LOGICAL UpdateTablePermissions (ITablePermissionSet) /** Update the database with changes for many table permissions @param tablePermissions ITablePermissionSet collection */
LOGICAL UpdateTables (ITableSet) /** Update the database with changes for many tables @param sequences ITableSet collection */
LOGICAL UpdateTenant (ITenant) /** Update the database with tenant changes @param tenant ITenant */
LOGICAL UpdateTenantGroup (ITenantGroup) /** Update the database with tenant group changes @param group ITenantGroup */
LOGICAL UpdateTenantGroups (ITenantGroupSet) /** Update the database with changes for many tenant groups @param tenantGroups ITenantGroupSet collection */
LOGICAL UpdateTenants (ITenantSet) /** Update the database with changes for many tenants @param tenants ITenantSet collection */
LOGICAL UpdateUser (IUser) /** Update the database with table permission changes @param tablePermission ITablePermission */
LOGICAL UpdateUsers (IUserSet) /** Update the database with changes for many table permissions @param tablePermissions ITablePermissionSet collection */

Event Summary
Options Name Purpose
ServiceDeleted () /** published when the service is deleted - considered internal */

Property Summary
Options Name Purpose
CHARACTER Name
OpenEdge.DataAdmin.Core.IPasswordPolicy PasswordPolicy
LOGICAL ThrowDataErrors
OpenEdge.DataAdmin.Core.FileLogger TransactionLogger
CHARACTER Url
OpenEdge.DataAdmin.Util.IUtilityFactory UtilityFactory


Method Detail
Top

PUBLIC LOGICAL CancelSchemaChanges ()

Purpose: Cancel current schema changes
The service only supports one active context retrieved with GetShemaChanges().
Use this before calling GetShemaChanges again if the returned schema was not passed to
UpdateSchemaChanges()
Returns LOGICAL
Top

PUBLIC LOGICAL CreateArea (IArea)

Purpose: Create a new area
Parameters:
area OpenEdge.DataAdmin.IArea
Returns LOGICAL
Top

PUBLIC LOGICAL CreateAreas (IAreaSet)

Purpose: Create new areas
Parameters:
areas OpenEdge.DataAdmin.IAreaSet
Returns LOGICAL
Top

PUBLIC LOGICAL CreateAuthenticationSystem (IAuthenticationSystem)

Purpose: Create a new authentication system
Parameters:
authenticationsystem OpenEdge.DataAdmin.IAuthenticationSystem
Returns LOGICAL
Top

PUBLIC LOGICAL CreateAuthenticationSystems (IAuthenticationSystemSet)

Purpose: Create new authentication systems
Parameters:
authenticationsystems OpenEdge.DataAdmin.IAuthenticationSystemSet
Returns LOGICAL
Top

PUBLIC LOGICAL CreateCdcTablePolicies (ICdcTablePolicySet)

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

PUBLIC LOGICAL CreateCdcTablePolicy (ICdcTablePolicy)

Purpose: Create a new cdc table policy
Parameters:
policy OpenEdge.DataAdmin.ICdcTablePolicy
ICdcTablePolicy to be created */
Returns LOGICAL
Top

PUBLIC LOGICAL CreateCollection (IDataAdminCollection)

Purpose: create a collection
Parameters:
pccol OpenEdge.DataAdmin.IDataAdminCollection
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)

Purpose: Create a new domain
Parameters:
domain OpenEdge.DataAdmin.IDomain
IDomain to be created */
Returns LOGICAL
Top

PUBLIC LOGICAL CreateDomains (IDomainSet)

Purpose: Create new domains
Parameters:
domains OpenEdge.DataAdmin.IDomainSet
IDomainSet with a collection of domains to create */
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)

Purpose: Create a new sequence
Parameters:
sequence OpenEdge.DataAdmin.ISequence
ISequence to be created */
Returns LOGICAL
Top

PUBLIC LOGICAL CreateSequences (ISequenceSet)

Purpose: Create new sequences
Parameters:
sequences OpenEdge.DataAdmin.ISequenceSet
ISequenceSet with a collection of sequences to create */
Returns LOGICAL
Top

PUBLIC LOGICAL CreateTenant (ITenant)

Purpose: Create a new tenant
Parameters:
tenant OpenEdge.DataAdmin.ITenant
Returns LOGICAL
Top

PUBLIC LOGICAL CreateTenantGroup (ITenantGroup)

Purpose: Create a new group
Parameters:
newgroup OpenEdge.DataAdmin.ITenantGroup
Returns LOGICAL
Top

PUBLIC LOGICAL CreateTenantGroups (ITenantGroupSet)

Purpose: Create new groups
Parameters:
groups OpenEdge.DataAdmin.ITenantGroupSet
ITenantGroupSet with a collection of groups to create */
Returns LOGICAL
Top

PUBLIC LOGICAL CreateTenants (ITenantSet)

Purpose: Create new tenants
Parameters:
tenants OpenEdge.DataAdmin.ITenantSet
ITenantSet with a collection of tenants to create */
Returns LOGICAL
Top

PUBLIC LOGICAL CreateUser (IUser)

Purpose: Create a new user
Parameters:
usr OpenEdge.DataAdmin.IUser
Returns LOGICAL
Top

PUBLIC LOGICAL CreateUsers (IUserSet)

Purpose: Create new users
Parameters:
users OpenEdge.DataAdmin.IUserSet
IUserSet with a collection of users to create */
Returns LOGICAL
Top

PUBLIC LOGICAL DeleteAuthenticationSystem (character)

Purpose: Delete authentication system
@throws NotFoundError if authentication system does not exist.
Parameters:
authenticationsystemName CHARACTER
name of authentication system to delete.
Returns LOGICAL
Top

PUBLIC LOGICAL DeleteCdcTablePolicy (character)

Purpose: Delete CdcTablePolicy
@throws NotFoundError if policy does not exist.
Parameters:
cdctablepolicyName CHARACTER
Returns LOGICAL
Top

PUBLIC LOGICAL DeleteDomain (character)

Purpose: Delete domain
@throws NotFoundError if domain does not exist
Parameters:
domainName CHARACTER
name of domain to delete
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:
tenantName CHARACTER
Returns LOGICAL
Top

PUBLIC LOGICAL DeleteSequence (character)

Purpose: Delete sequence
@throws NotFoundError if sequence does not exist.
Parameters:
seqname CHARACTER
Returns LOGICAL
Top

PUBLIC LOGICAL DeleteTenant (character)

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

PUBLIC LOGICAL DeleteTenantGroup (character)

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

PUBLIC LOGICAL DeleteUser (character)

Purpose: Delete domain
@throws NotFoundError if user does not exist
Parameters:
usrId CHARACTER
Returns LOGICAL
Top

PUBLIC ExecuteUtility (IDataAdminUtility)

Purpose: Execute the ulitility
Parameters:
putility OpenEdge.DataAdmin.Util.IDataAdminUtility
Top

PUBLIC OpenEdge.DataAdmin.IAdministrator GetAdministrator ()

/* get administrator - has administrator user ids
Returns OpenEdge.DataAdmin.IAdministrator
Top

PUBLIC OpenEdge.DataAdmin.IArea GetArea (character)

Purpose: Get an area
Parameters:
areaName CHARACTER
name of area */
Returns OpenEdge.DataAdmin.IArea
Top

PUBLIC OpenEdge.DataAdmin.IArea GetArea (integer)

Purpose: Get an area
Parameters:
areaNum INTEGER
Returns OpenEdge.DataAdmin.IArea
Top

PUBLIC OpenEdge.DataAdmin.IArea GetArea (IRequestInfo)

Purpose: Get an area
Parameters:
req OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IArea
Top

PUBLIC OpenEdge.DataAdmin.IAreaSet GetAreas ()

Purpose: Get a collection of all areas in the database
Returns OpenEdge.DataAdmin.IAreaSet
Top

PUBLIC OpenEdge.DataAdmin.IAreaSet GetAreas (character)

Purpose: Get a collection of areas in the database *
Parameters:
filter CHARACTER
a character query expression of area properties */
Returns OpenEdge.DataAdmin.IAreaSet
Top

PUBLIC OpenEdge.DataAdmin.IAreaSet GetAreas (IRequestInfo)

Purpose: Get a collection of all areas in the database
Parameters:
req OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IAreaSet
Top

PUBLIC OpenEdge.DataAdmin.IAuthenticationSystem GetAuthenticationSystem (character)

Purpose: Get a authentication system
Parameters:
name CHARACTER
Returns OpenEdge.DataAdmin.IAuthenticationSystem
Top

PUBLIC OpenEdge.DataAdmin.IAuthenticationSystemSet GetAuthenticationSystems ()

Purpose: Get a collection of all authentication systems in the database
Returns OpenEdge.DataAdmin.IAuthenticationSystemSet
Top

PUBLIC OpenEdge.DataAdmin.IAuthenticationSystemSet GetAuthenticationSystems (character)

Purpose: Get a collection of authentication systems in the database *
Parameters:
filter CHARACTER
a character query expression of authentication system properties */
Returns OpenEdge.DataAdmin.IAuthenticationSystemSet
Top

PUBLIC OpenEdge.DataAdmin.IAuthenticationSystemSet GetAuthenticationSystems (IRequestInfo)

Purpose: Get a collection of authentication systems in the database *
Parameters:
req OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IAuthenticationSystemSet
Top

PUBLIC OpenEdge.DataAdmin.ICdcFieldPolicySet GetCdcFieldPolicies ()

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

PUBLIC OpenEdge.DataAdmin.ICdcFieldPolicySet GetCdcFieldPolicies (character)

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

PUBLIC OpenEdge.DataAdmin.ICdcFieldPolicySet GetCdcFieldPolicies (IRequestInfo)

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

PUBLIC OpenEdge.DataAdmin.ICdcTablePolicySet GetCdcTablePolicies ()

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

PUBLIC OpenEdge.DataAdmin.ICdcTablePolicySet GetCdcTablePolicies (character)

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

PUBLIC OpenEdge.DataAdmin.ICdcTablePolicySet GetCdcTablePolicies (IRequestInfo)

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

PUBLIC OpenEdge.DataAdmin.ICdcTablePolicy GetCdcTablePolicy (character)

Purpose: Get a CdcTablePolicy
Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.ICdcTablePolicy
Top

PUBLIC OpenEdge.DataAdmin.ICdcTablePolicy GetCdcTablePolicy (IRequestInfo)

Purpose: Get a CdcTablePolicy
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:
pcname 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)

Purpose: Get data security
Parameters:
pcKey CHARACTER
Returns OpenEdge.DataAdmin.IDataSecurity
Top

PUBLIC OpenEdge.DataAdmin.IDomain GetDomain (character)

Purpose: Get a domain
Parameters:
domainName CHARACTER
name of domain */
Returns OpenEdge.DataAdmin.IDomain
Top

PUBLIC OpenEdge.DataAdmin.IDomain GetDomain (IRequestInfo)

Purpose: Get a domain
with optional request info children with QueryStrings for child collections
Parameters:
req OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IDomain
Top

PUBLIC OpenEdge.DataAdmin.IDomainSet GetDomains ()

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

PUBLIC OpenEdge.DataAdmin.IDomainSet GetDomains (character)

Purpose: Get a collection of domains in the database *
Parameters:
filter CHARACTER
a character query expression of domain properties */
Returns OpenEdge.DataAdmin.IDomainSet
Top

PUBLIC OpenEdge.DataAdmin.IDomainSet GetDomains (IRequestInfo)

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

PUBLIC Progress.Lang.Error GetError ()

Purpose: Get the last error from a failed operation when ThrowDataErrors is false.
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 all partition 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)

Purpose: Get a PartitionPolicy
Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.IPartitionPolicy
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicy GetPartitionPolicy (integer)

Purpose: Get a PartitionPolicy
Parameters:
pid INTEGER
Returns OpenEdge.DataAdmin.IPartitionPolicy
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicy GetPartitionPolicy (IRequestInfo)

Purpose: Get a PartitionPolicy
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)

Purpose: Get a collection of permissions for the specified collections
Parameters:
pccollections CHARACTER
Returns OpenEdge.DataAdmin.IUserTablePermissionSet
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:
poreq 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

PUBLIC OpenEdge.DataAdmin.ISchema GetSchema ()

Purpose: Get the Schema - the service only supports "PUB" schema
Returns OpenEdge.DataAdmin.ISchema
Top

PUBLIC OpenEdge.DataAdmin.ISchema GetSchema (IRequestInfo)

Purpose: 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)

Purpose: Get a schema with changes from the specified schema file (.df)
The Partitions property will have all new partitions that were created after
the schema is passed to LoadSchemaChanges
Parameters:
pcFile CHARACTER
Returns OpenEdge.DataAdmin.ISchema
Top

PUBLIC OpenEdge.DataAdmin.ISequence GetSequence (character)

Purpose: Get a sequence
Parameters:
SeqName CHARACTER
Returns OpenEdge.DataAdmin.ISequence
Top

PUBLIC OpenEdge.DataAdmin.ISequence GetSequence (IRequestInfo)

Purpose: Get a sequence
with optional request info children with QueryStrings for child collections
Parameters:
reqInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ISequence
Top

PUBLIC OpenEdge.DataAdmin.ISequenceSet GetSequences ()

Purpose: Get a collection of sequences in the database
Returns OpenEdge.DataAdmin.ISequenceSet
Top

PUBLIC OpenEdge.DataAdmin.ISequenceSet GetSequences (character)

Purpose: Get a collection of sequences in the database
Parameters:
filter CHARACTER
a character query expression of sequence properties */
Returns OpenEdge.DataAdmin.ISequenceSet
Top

PUBLIC OpenEdge.DataAdmin.ISequenceSet GetSequences (IRequestInfo)

Purpose: Get a collection of sequences in the database
with optional request info children with QueryStrings for child collections
Parameters:
reqInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ISequenceSet
Top

PUBLIC OpenEdge.DataAdmin.ITable GetTable (character)

Purpose: Get a table
Parameters:
tableName CHARACTER
name of table */
Returns OpenEdge.DataAdmin.ITable
Top

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

Purpose: Get a table
Parameters:
tableName CHARACTER
name of table
owner CHARACTER
name of the table owner*/
Returns OpenEdge.DataAdmin.ITable
Top

PUBLIC OpenEdge.DataAdmin.ITable GetTable (integer)

Purpose: Get a table
Parameters:
id INTEGER
(_field-number) */
Returns OpenEdge.DataAdmin.ITable
Top

PUBLIC OpenEdge.DataAdmin.ITable GetTable (IRequestInfo)

Purpose: Get a table
with optional request info children with QueryStrings for child collections
Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ITable
Top

PUBLIC OpenEdge.DataAdmin.ITablePermission GetTablePermission (character)

Purpose: Get a table permission
Parameters:
tablename CHARACTER
name of table permission */
Returns OpenEdge.DataAdmin.ITablePermission
Top

PUBLIC OpenEdge.DataAdmin.ITablePermissionSet GetTablePermissions ()

Purpose: Get a collection of all table permissions in the database
Returns OpenEdge.DataAdmin.ITablePermissionSet
Top

PUBLIC OpenEdge.DataAdmin.ITablePermissionSet GetTablePermissions (character)

Purpose: Get a collection of table permissions in the database *
Parameters:
filter CHARACTER
a character query expression of table permission properties */
Returns OpenEdge.DataAdmin.ITablePermissionSet
Top

PUBLIC OpenEdge.DataAdmin.ITableSet GetTables ()

Purpose: Get a collection of all tables in the database
Returns OpenEdge.DataAdmin.ITableSet
Top

PUBLIC OpenEdge.DataAdmin.ITableSet GetTables (character)

Purpose: Get a collection of tables in the database *
Parameters:
filter CHARACTER
a character query expression of table properties */
Returns OpenEdge.DataAdmin.ITableSet
Top

PUBLIC OpenEdge.DataAdmin.ITableSet GetTables (IRequestInfo)

Purpose: Get a collection of tables in the database *
with optional request info children with QueryStrings for child collections
Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ITableSet
Top

PUBLIC OpenEdge.DataAdmin.ITenant GetTenant (character)

Purpose: Get a tenant
Parameters:
tenantName CHARACTER
name of tenant */
Returns OpenEdge.DataAdmin.ITenant
Top

PUBLIC OpenEdge.DataAdmin.ITenant GetTenant (integer)

Purpose: Get a tenant
Parameters:
tenantId INTEGER
integer of of tenant */
Returns OpenEdge.DataAdmin.ITenant
Top

PUBLIC OpenEdge.DataAdmin.ITenant GetTenant (IRequestInfo)

Purpose: Get a tenant
with optional request info children with QueryStrings for child collections
Parameters:
req OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ITenant
Top

PUBLIC OpenEdge.DataAdmin.ITenant GetTenantByExternalId (character)

Purpose: Get a tenant by external id
Use GetTenants() with filter or Requestinfo with query expression on the
external id if the value is not unique
Parameters:
extId CHARACTER
Returns OpenEdge.DataAdmin.ITenant
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroup GetTenantGroup (character)

Purpose: Get a tenant group
Parameters:
groupName CHARACTER
name of tenant group */
Returns OpenEdge.DataAdmin.ITenantGroup
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroup GetTenantGroup (integer)

Purpose: Get a tenant group
Parameters:
groupId INTEGER
Id of tenant group */
Returns OpenEdge.DataAdmin.ITenantGroup
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroup GetTenantGroup (IRequestInfo)

Purpose: Get a tenant group
with optional request info children with QueryStrings for child collections
Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ITenantGroup
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroupSet GetTenantGroups ()

Purpose: Get a collection of all tenant groups in the database
Returns OpenEdge.DataAdmin.ITenantGroupSet
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroupSet GetTenantGroups (character)

Purpose: Get a collection of tenant groups in the database *
Parameters:
filter CHARACTER
a character query expression of group properties */
Returns OpenEdge.DataAdmin.ITenantGroupSet
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroupSet GetTenantGroups (IRequestInfo)

Purpose: Get a collection of tenant groups in the database *
with optional request info children with QueryStrings for child collections
Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ITenantGroupSet
Top

PUBLIC OpenEdge.DataAdmin.ITenantSet GetTenants ()

Purpose: Get a collection of all tenants in the database
Returns OpenEdge.DataAdmin.ITenantSet
Top

PUBLIC OpenEdge.DataAdmin.ITenantSet GetTenants (character)

Purpose: Get a collection of tenants in the database
Parameters:
filter CHARACTER
a character query expression of tenant properties */
Returns OpenEdge.DataAdmin.ITenantSet
Top

PUBLIC OpenEdge.DataAdmin.ITenantSet GetTenants (IRequestInfo)

Purpose: Get a collection of tenants in the database
with optional request info children with QueryStrings for child collections
Parameters:
pRequestInfo OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.ITenantSet
Top

PUBLIC OpenEdge.DataAdmin.IUser GetUser (character)

Purpose: Get a user
Parameters:
usrID CHARACTER
Returns OpenEdge.DataAdmin.IUser
Top

PUBLIC OpenEdge.DataAdmin.IUserPermission GetUserPermission (character)

Purpose: Get a user permission
the user id does not need to exist
Parameters:
usrID CHARACTER
Returns OpenEdge.DataAdmin.IUserPermission
Top

PUBLIC OpenEdge.DataAdmin.IUserPermissionSet GetUserPermissions ()

Purpose: Get a collection of all user permissions in the database
Returns OpenEdge.DataAdmin.IUserPermissionSet
Top

PUBLIC OpenEdge.DataAdmin.IUserPermissionSet GetUserPermissions (character)

Purpose: Get a collection of user permissions in the database
Parameters:
filter CHARACTER
a character query expression of user permission properties */
Returns OpenEdge.DataAdmin.IUserPermissionSet
Top

PUBLIC OpenEdge.DataAdmin.IUserSet GetUsers ()

Purpose: Get a collection of all users in the database
Returns OpenEdge.DataAdmin.IUserSet
Top

PUBLIC OpenEdge.DataAdmin.IUserSet GetUsers (character)

Purpose: Get a collection of users in the database *
Parameters:
pcfilter CHARACTER
Returns OpenEdge.DataAdmin.IUserSet
Top

PUBLIC OpenEdge.DataAdmin.IUserSet GetUsers (IRequestInfo)

Purpose: Get a collection of users in the database *
Parameters:
pReq OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IUserSet
Top

PUBLIC LOGICAL LoadSchemaChanges (character)

Purpose: Load schema changes in the datbase from the specified schema file (.df)
Parameters:
pcFile CHARACTER
Returns LOGICAL
Top

PUBLIC OpenEdge.DataAdmin.IArea NewArea (character)

Purpose: Get a new area
Expected to be passed to CreateArea() to be created in the database or added to a new or
existing IAreaSet collection to be submitted to the database with the collection.
Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.IArea
Top

PUBLIC OpenEdge.DataAdmin.IAreaSet NewAreas ()

Purpose: Get an empty area collection
Add new areas to the collection and pass it to CreateAreas() to create the areas in the database.
Returns OpenEdge.DataAdmin.IAreaSet
Top

PUBLIC OpenEdge.DataAdmin.IAuthenticationSystem NewAuthenticationSystem (character)

Purpose: Get a new authentication system
Expected to be passed to CreateAuthenticationSystem() to be created in the database
or added to a new or existing IAuthenticationSystemSet collection to be submitted to the
database with the collection.
Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.IAuthenticationSystem
Top

PUBLIC OpenEdge.DataAdmin.IAuthenticationSystemSet NewAuthenticationSystems ()

Purpose: Get an empty authentication system collection
Add new authentication systems to the collection and pass it to CreateAuthenticationSystems()
to create the authentication systems in the database.
Returns OpenEdge.DataAdmin.IAuthenticationSystemSet
Top

PUBLIC OpenEdge.DataAdmin.ICdcFieldPolicy NewCdcFieldPolicy ()

/* using the service's UpdateTable() or UpdateTables() methods.
Returns OpenEdge.DataAdmin.ICdcFieldPolicy
Top

PUBLIC OpenEdge.DataAdmin.ICdcTablePolicySet NewCdcTablePolicies ()

Purpose: Get an empty cdc table policy collection
Returns OpenEdge.DataAdmin.ICdcTablePolicySet
Top

PUBLIC OpenEdge.DataAdmin.ICdcTablePolicy NewCdcTablePolicy (character)

Purpose: Get an empty cdc table policy
Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.ICdcTablePolicy
Top

PUBLIC OpenEdge.DataAdmin.IDataAdminCollection NewCollection (character)

Purpose: Get a new collection of the specified serializename, entity name or physical database filename
Parameters:
pcname 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 roles 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)

Purpose: Get a new domain
Expected to be passed to CreateDomain() to be created in the database or added to a new or
existing IDomainSet collection, including the ITenant:Domains, to be submitted to the
database with the collection.
Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.IDomain
Top

PUBLIC OpenEdge.DataAdmin.IDomainSet NewDomains ()

Purpose: Get an empty domain collection
Add new domains to the collection and pass it to CreateDomains() to create the domains in the database.
Returns OpenEdge.DataAdmin.IDomainSet
Top

PUBLIC OpenEdge.DataAdmin.IExtent NewExtent ()

Purpose: Get a new extent
Expected to be added to an IArea:Extents collection to be submitted to the database
using the service's CreateArea() or UpdateAreas() methods.
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 ()

Purpose: Get a new index
Expected to be added to an ITable:Indexes collection to be submitted to the database
using the service's CreateTable() or UpdateTables() methods.
Returns OpenEdge.DataAdmin.IIndex
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicySet NewPartitionPolicies ()

Purpose: Get an empty partition policy collection
Returns OpenEdge.DataAdmin.IPartitionPolicySet
Top

PUBLIC OpenEdge.DataAdmin.IPartitionPolicy NewPartitionPolicy (character)

Purpose: Get an empty partition policy
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 CreateRole() 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)

Purpose: Get a new sequence
Expected to be passed to CreateSequence to be created in the database or added to a new
or existing ISequenceSet collection to be submitted to the database with the collection.
Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.ISequence
Top

PUBLIC OpenEdge.DataAdmin.ISequenceSet NewSequences ()

Purpose: Get an empty sequence collection
Add new sequences to the collection and pass it to CreateSequences() to create the sequences
in the database.
Returns OpenEdge.DataAdmin.ISequenceSet
Top

PUBLIC OpenEdge.DataAdmin.ITenant NewTenant (character)

Purpose: Get a new tenant
Expected to be passed to CreateTenant() to be created in the database or added to a new
or existing ITenantSet collection to be submitted to the database with the collection.
Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.ITenant
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroup NewTenantGroup (character)

Purpose: Get a new tenant group
Expected to be passed to CreateTenantGroup() to be created in the database or added to a new
or existing ITenantGroupSet collection to be submitted to the database with the collection.
Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.ITenantGroup
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroupMember NewTenantGroupMember ()

Purpose: Get a new tenant group member
Expected to be added to an ITenant or ITenantGroup TenantGroupMembers collection to be
submitted to the database using the service's CreateTenants() or UpdateTenants() methods.
Returns OpenEdge.DataAdmin.ITenantGroupMember
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroupSet NewTenantGroups ()

Purpose: Get an empty tenant group collection
Add new tenant groups to the collection and pass it to CreateTenantGroups() to create the tenants
in the database.
Returns OpenEdge.DataAdmin.ITenantGroupSet
Top

PUBLIC OpenEdge.DataAdmin.ITenantSet NewTenants ()

Purpose: Get an empty tenant collection
Add new tenants to the collection and pass it to CreateTenants() to create the tenants
in the database.
Returns OpenEdge.DataAdmin.ITenantSet
Top

PUBLIC OpenEdge.DataAdmin.IUser NewUser (character)

Purpose: Get a new user
Expected to be passed to CreateUser to be created in the database or added to a new
or existing IUserSet collection, including ITenant:Users or IDomin:Users to be submitted
to the database with the collection.
Parameters:
pname CHARACTER
Returns OpenEdge.DataAdmin.IUser
Top

PUBLIC OpenEdge.DataAdmin.IUserSet NewUsers ()

Purpose: Get an empty user collection
Add new users to the collection and pass it to CreateUsers() to create the users
in the database.
Returns OpenEdge.DataAdmin.IUserSet
Top

PUBLIC Progress.Lang.Error RemoveError ()

Purpose: Removes and returns the last error from a failed operation when ThrowDataErrors is false.
Returns Progress.Lang.Error
Top

PUBLIC ThrowError ()

Purpose: Throw the last error from a failed operation when ThrowDataErrors is false.
The error is also removed from the service.
Top

PUBLIC LOGICAL UpdateAdministrator (IAdministrator)

Purpose: Update the database with administrator changes
Parameters:
admin OpenEdge.DataAdmin.IAdministrator
IAdministrator */
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateArea (IArea)

Purpose: Update the database with new extents added to the area
Parameters:
area OpenEdge.DataAdmin.IArea
IArea */
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateAreas (IAreaSet)

Purpose: Update the database with new extents added to the areas in the collection
Parameters:
areas OpenEdge.DataAdmin.IAreaSet
IAreaset collection */
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateAuthenticationSystem (IAuthenticationSystem)

Purpose: Update the database with authentication system changes
Parameters:
authenticationsystem OpenEdge.DataAdmin.IAuthenticationSystem
IAuthenticationSystem */
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateAuthenticationSystems (IAuthenticationSystemSet)

Purpose: Update the database with changes for many authentication systems
Parameters:
authenticationsystems OpenEdge.DataAdmin.IAuthenticationSystemSet
IAuthenticationSystemSet collection */
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateCdcTablePolicies (ICdcTablePolicySet)

Purpose: Update the database with cdc table policies with changes
Parameters:
policy OpenEdge.DataAdmin.ICdcTablePolicySet
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateCdcTablePolicy (ICdcTablePolicy)

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

PUBLIC LOGICAL UpdateCollection (IDataAdminCollection)

Purpose: Update a collection
Parameters:
pccol OpenEdge.DataAdmin.IDataAdminCollection
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)

Purpose: Update the database with security changes
Parameters:
pinst OpenEdge.DataAdmin.IDataSecurity
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateDomain (IDomain)

Purpose: Update the database with domain changes
Parameters:
domain OpenEdge.DataAdmin.IDomain
IDomain */
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateDomains (IDomainSet)

Purpose: Update the database with changes for many domains
Parameters:
domains OpenEdge.DataAdmin.IDomainSet
IDomainSet collection */
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

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)

Purpose: Update the database with partition changes on new partitions created when the
schema definitions were added to the database with pdateSchemaChanges
Parameters:
pschema OpenEdge.DataAdmin.ISchema
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateSchemaChanges (ISchema)

Purpose: Update the database with schema changes returned from GetSchemaChanges
Parameters:
pschema OpenEdge.DataAdmin.ISchema
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateSequence (ISequence)

Purpose: Update the database with sequence changes
Parameters:
seq OpenEdge.DataAdmin.ISequence
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateSequences (ISequenceSet)

Purpose: Update the database with changes for many sequences
Parameters:
sequences OpenEdge.DataAdmin.ISequenceSet
ISequenceSet collection */
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTable (ITable)

Purpose: Update the database with table changes
Parameters:
tableimpl OpenEdge.DataAdmin.ITable
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTablePermission (ITablePermission)

Purpose: Update the database with table permission changes
Parameters:
tableperm OpenEdge.DataAdmin.ITablePermission
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTablePermissions (ITablePermissionSet)

Purpose: Update the database with changes for many table permissions
Parameters:
tableperms OpenEdge.DataAdmin.ITablePermissionSet
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTables (ITableSet)

Purpose: Update the database with changes for many tables
Parameters:
tables OpenEdge.DataAdmin.ITableSet
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTenant (ITenant)

Purpose: Update the database with tenant changes
Parameters:
ptnt OpenEdge.DataAdmin.ITenant
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTenantGroup (ITenantGroup)

Purpose: Update the database with tenant group changes
Parameters:
tenantGroup OpenEdge.DataAdmin.ITenantGroup
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTenantGroups (ITenantGroupSet)

Purpose: Update the database with changes for many tenant groups
Parameters:
tenantGroups OpenEdge.DataAdmin.ITenantGroupSet
ITenantGroupSet collection */
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateTenants (ITenantSet)

Purpose: Update the database with changes for many tenants
Parameters:
tenants OpenEdge.DataAdmin.ITenantSet
ITenantSet collection */
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateUser (IUser)

Purpose: Update the database with table permission changes
Parameters:
usr OpenEdge.DataAdmin.IUser
Returns LOGICAL
Top

PUBLIC LOGICAL UpdateUsers (IUserSet)

Purpose: Update the database with changes for many table permissions
Parameters:
users OpenEdge.DataAdmin.IUserSet
Returns LOGICAL


Event Detail
Top

PUBLIC ServiceDeleted ()

Purpose: published when the service is deleted - considered internal


Property Detail
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