IMultiTenancyServiceGetTenantInfo(Guid, Boolean) Method

Gets minimal information about the tenant with the specified ID.

Namespace: Dundas.BI.AccountServices.MultiTenancy
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (26.2.0.1000)

Syntax

C++

Copy

TenantInfo GetTenantInfo(
	Guid id,
	bool throwIfNotFound
)

Function GetTenantInfo ( 
	id As Guid,
	throwIfNotFound As Boolean
) As TenantInfo

TenantInfo^ GetTenantInfo(
	Guid id, 
	bool throwIfNotFound
)

abstract GetTenantInfo : 
        id : Guid * 
        throwIfNotFound : bool -> TenantInfo

Parameters

id Guid: The ID of the tenant.
throwIfNotFound Boolean: Specifies whether an exception will be thrown if the specified tenant is not found.

Return Value

TenantInfo
The tenant corresponding to the specified ID.

Exceptions

Exception	Condition
NotFoundException	A tenant with the given ID does not exist and throwIfNotFound is .
NoPrivilegeException	The caller is not a member of the specified tenant.
InvalidSessionException	The caller context is not associated with a valid session.
ArgumentException	id is Empty.
NotFoundException	A tenant with the given ID does not exist.
FeatureNotEnabledException	The multi-tenancy features of the application are not enabled.

Remarks

If throwIfNotFound is , and a tenant with the specified ID was not found, this method will return a TenantInfo object with only the Id property populated.

Reference

IMultiTenancyService Interface

GetTenantInfo Overload

Dundas.BI.AccountServices.MultiTenancy Namespace