ITenantSet methods

Inherits methods from IDataAdminCollection and defines the methods listed in the following table.

Table 1. Multi-tenant Maintenance ITenantSet interface methods
Method syntax Description 
LOGICAL Add ( tenant AS ITenant )
 Adds the tenant object referenced by tenant to the set and returns TRUE if successful. 
LOGICAL CanFind ( tenantId AS INTEGER )
 Returns TRUE if there is a tenant object in the set that has its Id property set to tenantId. 
LOGICAL CanFind ( tenantName AS CHARACTER )
 Returns TRUE if there is a tenant object in the set that has its Name property set to tenantName. 
LOGICAL CanFindByExternalId (
  extId AS CHARACTER )
 Returns TRUE if there is a tenant object in the set that has its ExternalId property set to extId. 
LOGICAL Contains ( tenant AS ITenant )
 Returns TRUE if the tenant object referenced by tenant is in the set. 
ITenant Find ( tenantId AS INTEGER )
 Returns the tenant object from the set that has its Id property set to tenantId. Returns the Unknown value (?) if the object is not found. 
ITenant Find ( tenantName AS CHARACTER )
 Returns the tenant object from the set that has its Name property set to tenantName. Returns the Unknown value (?) if the object is not found. 
ITenant FindByExternalId ( extId AS CHARACTER )
 Returns the tenant object from the set that has its ExternalId property set to extId. Returns the Unknown value (?) if the object is not found. 
LOGICAL Remove ( tenant AS ITenant )
 Removes the tenant object referenced by tenant from the set and returns TRUE if successful.

See also: