Consists of a set of related groups and users. A realm is normally mapped to a directory partition (that is, a namingContext) in a directory server. The primary use of a Realm object is to retrieve lists of the groups and users in the realm.

You can instantiate a Realm object by:

  • Calling methods on the Factory.Realm class. (See the note below.)
  • Calling IEntireNetwork.Get_MyRealm(), which returns a Realm object representing the realm in which the caller resides.
  • Enumerating a RealmSet collection.
Note
When instantiating via the static factory methods, calling GetInstance with a Null realm name returns the current realm; the behavior is the same as calling Factory.Realm.FetchCurrent().

The following tables list the members exposed by IRealm.

Public Properties

 NameDescription
Public propertyNameThe name for this object.

For most classes, this property is read-only and returns the value of the designated name property for the object, or its ID if there is no name property. If ClassDescription.NamePropertyIndex has a value, this property contains the value of the designated name property. If there is no designated name property value, and the object has an Id property, this property contains the string value of the Id property. If neither of these conditions is satisfied, this property contains an empty string.

For a ComponentRelationship object, this property is read/write and specifies the name of the object.

Top

Public Methods

 NameDescription
Public methodFindGroupsReturns a set of groups from this realm that matches the search parameters.
Note
Searching is not case sensitive.

The rules that govern the search behavior are:

  • If sortType has a non-null value (not none), then searchAttribute must also have a non-null value. (sortType needs a value to sort on.)
  • If either searchPattern or searchType has a positive value (not empty or non-null, respectively), then searchPattern, searchType, and searchAttribute must all have positive values.
Public methodFindUsersReturns a set of users, a page at a time, from this realm that matches the search parameters. The size of each page of results is governed by the value of the pageSize parameter.
Note
Searching is not case sensitive.

The rules that govern the search behavior are:

  • If sortType has a non-null value (not none), then searchAttribute must also have a non-null value. (sortType needs a value to sort on.)
  • If either searchPattern or searchType has a positive value (not empty or non-null, respectively), then searchPattern, searchType, and searchAttribute must all have positive values.
Top

See Also