IAdmBusinessUnit
The IAdmBusinessUnit interface represents a business unit.
Inheritance: IAdmTop
Methods
-
Method
-
Description
-
GetMembershipRules()
-
Returns the IAdmBusinessUnitMembershipRules interface that represents a collection of membership rules of the business unit.
-
SetMembershipRules()
-
Sets a collection of membership rules for the business unit.
-
Members()
-
Returns the IAdmBusinessUnitMembers interface that represents a collection of members of the business unit.
-
IsMember()
-
Checks whether the given directory object is a member of the business unit.
-
GetMembershipRulesEx()
-
Returns the IAdmBusinessUnitMembershipRules interface that represents a collection of membership rules of the business unit.
-
GetMemberGuids()
-
Returns an array of GUIDs of the objects defined by the membership rules passed as the method parameter.
-
GetColumnSettings()
-
Returns default column settings for the business unit.
-
SetColumnSettings()
-
Updates column settings for the business unit.
Properties
-
Property
-
Description
-
UnitName
-
Gets the name of the business unit.
-
Description
-
Gets or sets an optional description of the business unit.
-
UserToResolveValueReferences
-
Gets or sets the user account whose properties must be used to replace value references contained in membership rules.
Details
GetMembershipRules()
Returns the IAdmBusinessUnitMembershipRules interface that represents a collection of membership rules of the business unit. Membership rules determine which objects must be included in the business unit.
IAdmBusinessUnitMembershipRules GetMembershipRules()
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 members of the business unit.
IAdmBusinessUnitMembers Members()
IsMember()
Checks whether the given directory object is a member of the business unit.
bool IsMember(IAdmTop member)
Parameters
The member parameter specifies the directory object to be checked.
GetMembershipRulesEx()
Returns the IAdmBusinessUnitMembershipRules interface that represents a collection of membership rules of the business unit. 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 contained in membership rules. If set to
true
, all value references will be substituted with corresponding property values of the user account specified in theUserToResolveValueReferences
property. - warnings - An output (OUT) parameter that returns a string[] array that contains warnings issued while resolving value references.
GetMemberGuids()
Returns an array of GUIDs of the objects defined by the membership rules passed as the method parameter. Each element in the array is an array of 16 bytes representing a GUID of a directory object.
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
The settings parameter specifies column settings to be applied for 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.
- Type:
- IAdmTop
- Access:
- Read/Write
Remarks
If the property is not set or set to null
, the account of the logged 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