Namespace: OpenEdge.DataAdmin
Class
Tenant
Parent classes:
Progress.Lang.Object
OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.AbstractPartitionParent
OpenEdge.DataAdmin.AbstractPartitionOwner
OpenEdge.DataAdmin.Tenant

Inherits: OpenEdge.DataAdmin.AbstractPartitionOwner
Implements: OpenEdge.DataAdmin.ITenant

/* Copyright (c) 2010,2012 by Progress Software Corporation.
/*
/* All rights reserved. No part of this program or document
/* may be reproduced in any form or by any means without
/* permission in writing from Progress Software Corporation.
File:Tenant
Author(s):hdaniels
Created:Sat Jun 12 21:20:19 EDT 2010
/* implements ITenant, IDataAdminElement, IDataAdminSerializable




Method Summary
Options Name Purpose
LOGICAL Allocate ()
Overrides OpenEdge.DataAdmin.AbstractPartitionOwner:Allocate ()
AssertPartitions () /* all valid */
Overrides OpenEdge.DataAdmin.AbstractPartitionOwner:AssertPartitions ()
Attach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL CanAttach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.Binding.IDataAdminModel CreateLocalContext ()
Overrides OpenEdge.DataAdmin.Entity:CreateLocalContext ()
IRow CreateRowInfo ()
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL Equals (Object)
Inherited from OpenEdge.DataAdmin.Entity
Export ()
Overrides OpenEdge.DataAdmin.Entity:Export ()
Export (character)
Inherited from OpenEdge.DataAdmin.Entity
ExportAsProcedure (character)
Inherited from OpenEdge.DataAdmin.Entity
ExportAsProcedure (character, character)
Overrides OpenEdge.DataAdmin.Entity:ExportAsProcedure (character, character)
ExportData (character)
Inherited from OpenEdge.DataAdmin.Entity
ExportTree (character) /** override to handle collections for this */
Inherited from OpenEdge.DataAdmin.Entity
ExportTree (character, character) /** override to get codewriter if .p and to handle collections for this */
Overrides OpenEdge.DataAdmin.Entity:ExportTree (character, character)
OpenEdge.DataAdmin.IDataAdminCollection GetChildCollection (character) /** use IRow to pass state and info @todo deprecate the overloads below this */
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.IDataAdminExporter GetCodeExporter ()
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER GetCreateError ()
OpenEdge.DataAdmin.IDataAdminExporter GetExporter (character)
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER GetFileExtension (character)
Inherited from OpenEdge.DataAdmin.Entity
JSONObject GetJSONExport (IContextTree) /* optional call back from context tree. called when parse is complete override to return json to export instead of dataset returns unknown to use standard dataset. write-json */
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER GetKeyValue () /** @todo - deprecate - use GetKeyValues workaround due to inconsistent key definition (and property reflection) override in classes that does not use name */
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER GetKeyValues ()
Inherited from OpenEdge.DataAdmin.Entity
IDataAdminService GetLookupService ()
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER GetValidDefaultAllocationList ()
Inherited from OpenEdge.DataAdmin.AbstractPartitionParent
Import (character) /* @TODO - call context:ImportRow with GetKeyValue() and remove all override */
Inherited from OpenEdge.DataAdmin.Entity
ImportTree (character)
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL NeedsRefresh () /* if lazy datasource none of the arename fields will have data it is sufficient to check one of them - super does not have area - default may have... */
Overrides OpenEdge.DataAdmin.Entity:NeedsRefresh ()
NewContext (IDataAdminModel) /* the context we attached to changed */
Inherited from OpenEdge.DataAdmin.Entity
Refresh () /* Refresh if necessary */
Inherited from OpenEdge.DataAdmin.Entity
RemoveData ()
RowDeleted () /* the context we attached to deleted something changed */
Inherited from OpenEdge.DataAdmin.Entity
INTEGER Serialize (handle)
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL SetProperty (character, character)
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER ToString ()
Inherited from OpenEdge.DataAdmin.Entity
WriteTree (IContextTree)
Overrides OpenEdge.DataAdmin.Entity:WriteTree (IContextTree)
WriteTree (IContextTree, character) /* write specified collections (default all) See override in ExportTree(file,collection) that deals with tenantGroups versus TenantGroupMembers for .p */
Overrides OpenEdge.DataAdmin.Entity:WriteTree (IContextTree, character)

Constructor Summary
Options Name Purpose
Tenant (character)
Tenant (IDataAdminModel)
Tenant (IDataAdminModel, IRequestInfo)

Property Summary
Options Name Purpose
LOGICAL Attached
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER CodeExtension
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.Binding.IDataAdminModel Context
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER ContextId
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL Created
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER DefaultAllocation
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultAllocation
OpenEdge.DataAdmin.IArea DefaultDataArea
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultDataArea
OpenEdge.DataAdmin.IArea DefaultIndexArea
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultIndexArea
OpenEdge.DataAdmin.IArea DefaultLobArea
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultLobArea
CHARACTER Description
Inherited from OpenEdge.DataAdmin.AbstractPartitionParent
OpenEdge.DataAdmin.IDomainSet Domains
Progress.Lang.Error Error
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER ExternalID
INTEGER Id
Inherited from OpenEdge.DataAdmin.AbstractPartitionOwner
LOGICAL IsAllocated
Inherited from OpenEdge.DataAdmin.AbstractPartitionOwner
LOGICAL IsDataEnabled
Overrides OpenEdge.DataAdmin.AbstractPartitionOwner:IsDataEnabled
LOGICAL Modified
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER Name
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.IPartitionMap Partitions
Inherited from OpenEdge.DataAdmin.AbstractPartitionOwner
OpenEdge.DataAdmin.IRequestInfo RequestInfo
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.ISequenceValueMap SequenceValues
CHARACTER SerializeName
Inherited from OpenEdge.DataAdmin.Entity
IDataAdminService Service
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER ShortContextName
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER ShortTypeName
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.ITenantGroupMemberSet TenantGroupMembers
OpenEdge.DataAdmin.ITenantGroupSet TenantGroups
CHARACTER Type
OpenEdge.DataAdmin.IUserSet Users
CHARACTER ValidDefaultAllocationList
Inherited from OpenEdge.DataAdmin.AbstractPartitionParent
CHARACTER ValidTypeList


Method Detail
Top

PUBLIC LOGICAL Allocate ()
Overrides OpenEdge.DataAdmin.AbstractPartitionOwner:Allocate ()
Returns LOGICAL
Top

PROTECTED AssertPartitions ()
Overrides OpenEdge.DataAdmin.AbstractPartitionOwner:AssertPartitions ()
/* all valid
Top

PUBLIC Attach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
cntxt IDataAdminContext
Top

PUBLIC LOGICAL CanAttach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
cntxt IDataAdminContext
Returns LOGICAL
Top

PROTECTED OpenEdge.DataAdmin.Binding.IDataAdminModel CreateLocalContext ()
Overrides OpenEdge.DataAdmin.Entity:CreateLocalContext ()
Returns OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PROTECTED IRow CreateRowInfo ()
Inherited from OpenEdge.DataAdmin.Entity
Returns IRow
Top

PUBLIC LOGICAL Equals (Object)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
obj Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC Export ()
Overrides OpenEdge.DataAdmin.Entity:Export ()
Top

PUBLIC Export (character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportAsProcedure (character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcfile CHARACTER
Top

PUBLIC ExportAsProcedure (character, character)
Overrides OpenEdge.DataAdmin.Entity:ExportAsProcedure (character, character)
Parameters:
pcfile CHARACTER
pcCollectionlist CHARACTER
Top

PROTECTED ExportData (character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportTree (character)
Inherited from OpenEdge.DataAdmin.Entity
Purpose: override to handle collections for this
Parameters:
pcfile CHARACTER
Top

PUBLIC ExportTree (character, character)
Overrides OpenEdge.DataAdmin.Entity:ExportTree (character, character)
Purpose: override to get codewriter if .p and to handle collections for this
Parameters:
pcfile CHARACTER
pcCollectionlist CHARACTER
Top

PROTECTED OpenEdge.DataAdmin.IDataAdminCollection GetChildCollection (character)
Inherited from OpenEdge.DataAdmin.Entity
Purpose: use IRow to pass state and info
@todo deprecate the overloads below this
Parameters:
pcchild CHARACTER
Returns OpenEdge.DataAdmin.IDataAdminCollection
Top

PROTECTED OpenEdge.DataAdmin.IDataAdminExporter GetCodeExporter ()
Inherited from OpenEdge.DataAdmin.Entity
Returns OpenEdge.DataAdmin.IDataAdminExporter
Top

PROTECTED CHARACTER GetCreateError ()
Returns CHARACTER
Top

PROTECTED OpenEdge.DataAdmin.IDataAdminExporter GetExporter (character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcFile CHARACTER
Returns OpenEdge.DataAdmin.IDataAdminExporter
Top

PROTECTED CHARACTER GetFileExtension (character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcFile CHARACTER
Returns CHARACTER
Top

PUBLIC JSONObject GetJSONExport (IContextTree)
Inherited from OpenEdge.DataAdmin.Entity
/* optional call back from context tree.
called when parse is complete
override to return json to export instead of dataset
returns unknown to use standard dataset. write-json
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
Returns JSONObject
Top

PROTECTED CHARACTER GetKeyValue ()
Inherited from OpenEdge.DataAdmin.Entity
Purpose: @todo - deprecate - use GetKeyValues
workaround due to inconsistent key definition (and property reflection)
override in classes that does not use name
Returns CHARACTER
Top

PROTECTED CHARACTER GetKeyValues ()
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PROTECTED IDataAdminService GetLookupService ()
Inherited from OpenEdge.DataAdmin.Entity
Returns IDataAdminService
Top

PROTECTED CHARACTER GetValidDefaultAllocationList ()
Inherited from OpenEdge.DataAdmin.AbstractPartitionParent
Returns CHARACTER
Top

PUBLIC Import (character)
Inherited from OpenEdge.DataAdmin.Entity
/* @TODO - call context:ImportRow with GetKeyValue() and remove all override
Parameters:
cFile CHARACTER
Top

PUBLIC ImportTree (character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcFile CHARACTER
Top

PROTECTED LOGICAL NeedsRefresh ()
Overrides OpenEdge.DataAdmin.Entity:NeedsRefresh ()
/* if lazy datasource none of the arename fields will have data
it is sufficient to check one of them - super does not have
area - default may have...
Returns LOGICAL
Top

PROTECTED NewContext (IDataAdminModel)
Inherited from OpenEdge.DataAdmin.Entity
/* the context we attached to changed
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PROTECTED Refresh ()
Inherited from OpenEdge.DataAdmin.Entity
/* Refresh if necessary
Top

PUBLIC RemoveData ()
Top

PROTECTED RowDeleted ()
Inherited from OpenEdge.DataAdmin.Entity
/* the context we attached to deleted something changed
Top

PUBLIC INTEGER Serialize (handle)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
phHandle HANDLE
Returns INTEGER
Top

PROTECTED LOGICAL SetProperty (character, character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcPropName CHARACTER
pcValue CHARACTER
Returns LOGICAL
Top

PUBLIC CHARACTER ToString ()
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC WriteTree (IContextTree)
Overrides OpenEdge.DataAdmin.Entity:WriteTree (IContextTree)
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
Top

PUBLIC WriteTree (IContextTree, character)
Overrides OpenEdge.DataAdmin.Entity:WriteTree (IContextTree, character)
/* write specified collections (default all)
See override in ExportTree(file,collection) that deals with tenantGroups versus TenantGroupMembers for .p
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
pcCollections CHARACTER


Constructor Detail
Top

PUBLIC Tenant (character)
Parameters:
cname CHARACTER
Top

PUBLIC Tenant (IDataAdminModel)
Purpose:
Notes:
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PUBLIC Tenant (IDataAdminModel, IRequestInfo)
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
preq OpenEdge.DataAdmin.IRequestInfo


Property Detail
Top

PUBLIC LOGICAL Attached
Inherited from OpenEdge.DataAdmin.Entity
Returns LOGICAL
Top

PUBLIC CHARACTER CodeExtension
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PROTECTED OpenEdge.DataAdmin.Binding.IDataAdminModel Context
Inherited from OpenEdge.DataAdmin.Entity
Returns OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PUBLIC CHARACTER ContextId
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC LOGICAL Created
Inherited from OpenEdge.DataAdmin.Entity
Returns LOGICAL
Top

PUBLIC CHARACTER DefaultAllocation
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultAllocation
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.IArea DefaultDataArea
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultDataArea
Returns OpenEdge.DataAdmin.IArea
Top

PUBLIC OpenEdge.DataAdmin.IArea DefaultIndexArea
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultIndexArea
Returns OpenEdge.DataAdmin.IArea
Top

PUBLIC OpenEdge.DataAdmin.IArea DefaultLobArea
Overrides OpenEdge.DataAdmin.AbstractPartitionParent:DefaultLobArea
Returns OpenEdge.DataAdmin.IArea
Top

PUBLIC CHARACTER Description
Inherited from OpenEdge.DataAdmin.AbstractPartitionParent
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.IDomainSet Domains
Returns OpenEdge.DataAdmin.IDomainSet
Top

PUBLIC Progress.Lang.Error Error
Inherited from OpenEdge.DataAdmin.Entity
Returns Progress.Lang.Error
Top

PUBLIC CHARACTER ExternalID
Returns CHARACTER
Top

PUBLIC INTEGER Id
Inherited from OpenEdge.DataAdmin.AbstractPartitionOwner
Returns INTEGER
Top

PUBLIC LOGICAL IsAllocated
Inherited from OpenEdge.DataAdmin.AbstractPartitionOwner
Returns LOGICAL
Top

PUBLIC LOGICAL IsDataEnabled
Overrides OpenEdge.DataAdmin.AbstractPartitionOwner:IsDataEnabled
Returns LOGICAL
Top

PUBLIC LOGICAL Modified
Inherited from OpenEdge.DataAdmin.Entity
Returns LOGICAL
Top

PUBLIC CHARACTER Name
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.IPartitionMap Partitions
Inherited from OpenEdge.DataAdmin.AbstractPartitionOwner
Returns OpenEdge.DataAdmin.IPartitionMap
Top

PUBLIC OpenEdge.DataAdmin.IRequestInfo RequestInfo
Inherited from OpenEdge.DataAdmin.Entity
Returns OpenEdge.DataAdmin.IRequestInfo
Top

PUBLIC OpenEdge.DataAdmin.ISequenceValueMap SequenceValues
Returns OpenEdge.DataAdmin.ISequenceValueMap
Top

PUBLIC CHARACTER SerializeName
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC IDataAdminService Service
Inherited from OpenEdge.DataAdmin.Entity
Returns IDataAdminService
Top

PROTECTED CHARACTER ShortContextName
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PROTECTED CHARACTER ShortTypeName
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroupMemberSet TenantGroupMembers
Returns OpenEdge.DataAdmin.ITenantGroupMemberSet
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroupSet TenantGroups
Returns OpenEdge.DataAdmin.ITenantGroupSet
Top

PUBLIC CHARACTER Type
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.IUserSet Users
Returns OpenEdge.DataAdmin.IUserSet
Top

PROTECTED CHARACTER ValidDefaultAllocationList
Inherited from OpenEdge.DataAdmin.AbstractPartitionParent
Returns CHARACTER
Top

PRIVATE CHARACTER ValidTypeList
Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0