Try OpenEdge Now
skip to main content
Programming Interfaces
Database Administration Entity Collection Interface Reference : ISchemaPartitionMap interface : ISchemaPartitionMap methods
 

ISchemaPartitionMap methods

Inherits methods from IDataAdminCollection and defines the methods listed in the following table.
Table 135. Multi-tenant Maintenance ISchemaPartitionMap interface methods
Method syntax
Description
LOGICAL ContainsKey ( pTenant AS ITenant )
Returns TRUE if a partition object is mapped to the tenant specified by pTenant.
LOGICAL ContainsValue (
  partition AS IPartition )
Returns TRUE if the partition object referenced by partition is in the map.
LOGICAL ContainsKey ( pGroup AS ITenantGroup )
Returns TRUE if a partition object is mapped to the tenant group specified by pGroup.
IPartition Get ( pElm AS IDataAdminElement)
Returns the partition object that is mapped to the IDataAdminElement specified by pElm, which must be an ITenant or ITenantGroup. Returns the Unknown value (?) if the object is not found.
IPartition Get ( pGroup AS ITenantGroup )
Returns the partition object that is mapped to the ITenantGroup specified by pGroup. Returns the Unknown value (?) if the object is not found.
IPartition Get ( pTenant AS ITenant )
Returns the partition object that is mapped to the ITenant specified by pTenant. Returns the Unknown value (?) if the object is not found.
IPartition FindGroup ( pcName AS CHARACTER )
Returns the partition object from the map for the tenant group object that has its Name property set to pcName. Returns the Unknown value (?) if the object is not found.
IPartition FindTenant ( pcName AS CHARACTER )
Returns the partition object from the map for the tenant object that has its Name property set to pcName. Returns the Unknown value (?) if the object is not found.
LOGICAL AllocateTenants ( )
Allocates all delayed partitions for all tenants.Does not allocate partitions belonging to a tenant group.Returns TRUE if any partition was allocated.
LOGICAL AllocateTenants (
  pcAllocationState AS CHARACTER )
Allocates tenant partitions for the parent schema element (ITable, IIndex, or IField).
Does not allocate partitions belonging to a tenant group.
The pcAllocationState parameter identifies the state of partitions to allocate: "All", "Delayed", or "None". Raises an error if the specified allocation state is not valid.Returns TRUE if any partition was allocated.
LOGICAL AllocateGroups ( )
Allocates all delayed partitions for all tenant groups.
Does not allocate partitions belonging to a tenant.
Returns TRUE if any partition was allocated.
LOGICAL AllocateGroups (
  pcAllocationState AS CHARACTER )
Allocates tenant group partitions for the parent schema element (ITable, IIndex, or IField).
Does not allocate partitions belonging to a tenant.
The pcAllocationState parameter identifies the state of partitions to allocate: "All", "Delayed", or "None". Raises an error if the specified allocation state is not valid.Returns TRUE if any partition was allocated.
See also:
*IDataAdminCollection interface
*IField interface
*IIndex interface
*IPartition interface
*IPartitionCollection interface
*IPartitionMap interface
*ITable interface
*ITenant interface
*ITenantGroup interface