IAdmBusinessUnit

The IAdmBusinessUnit interface represents a business unit.

Inheritance: IAdmTop

Methods

Properties

Details

GetMembershipRules()

Returns the IAdmBusinessUnitMembershipRules interface that represents a collection of business unit membership rules. Membership rules determine which objects are included in the business unit.

IAdmBusinessUnitMembershipRules GetMembershipRules()

GetMembershipRulesEx()

Returns the IAdmBusinessUnitMembershipRules interface that represents a collection of business unit membership rules. Membership rules determine which objects must be included in the business unit.

IAdmBusinessUnitMembershipRules GetMembershipRulesEx(bool resolveValueReferences, 
                                                     out string[] warnings)

Parameters

  • resolveValueReferences – determines whether to replace value references in membership rules. If set to true, all value references will be substituted with the corresponding property values of the user account specified in the UserToResolveValueReferences property.

  • warnings – an output (OUT) parameter that returns a string[] which contains warnings issued while resolving value references.


SetMembershipRules()

Sets a collection of membership rules for the business unit.

void SetMembershipRules(IAdmBusinessUnitMembershipRules membershipRules)

Remarks

To save the changes, call IADs::SetInfo on the business unit object after calling this method.


Members()

Returns the IAdmBusinessUnitMembers interface that represents a collection of business unit members.

IAdmBusinessUnitMembers Members()

IsMember()

Checks whether a particular directory object is a member of the business unit.

bool IsMember(IAdmTop member)

Parameters

  • member – specifies the directory object to check.

GetMemberGuids()

Returns an array of GUIDs of the objects that match the provided membership rules. Each GUID is represented as an array of 16 bytes (Byte[]), and the method returns an array of byte arrays (Byte[][]).

object[] GetMemberGuids(IAdmBusinessUnitMembershipRules membershipRules)

GetColumnSettings()

Returns default column settings for the business unit.

IAdmColumnSettings GetColumnSettings()

SetColumnSettings()

Updates column settings for the business unit.

void SetColumnSettings(IAdmColumnSettings settings)

Parameters

  • settings – the column settings to apply to the business unit.

Remarks

To save the changes, call IADs::SetInfo after calling this method.


UnitName

Gets the name of the business unit.

  • Type:
  • string
  • Access:
  • Read-only

Description

Gets or sets an optional description of the business unit.

  • Type:
  • string
  • Access:
  • Read/Write

UserToResolveValueReferences

Gets or sets the user account whose properties must be used to replace value references contained in membership rules.

Remarks

If the property is not set or set to null, the account of the signed in user is used. This property is not persisted and is initially set to null when you bind to a business unit object.


Requirements

Minimum required version: 2023

See also