The IRealm type exposes the following members.

ToggleMethods

Type NameDescription
Public methodClone
Creates a new object that is a copy of the current instance.
(Inherited from ICloneable.)
Public methodFetchPropertiesOverloaded.
Public methodFetchPropertyOverloaded.
Public methodFindGroups
Returns a set of groups from this realm that matches the search parameters.
Note Note: Searching is not case sensitive.
Note Note: If IBM Virtual Member Manager (VMM) or IBM Connections is configured as a directory service provider for Content Platform Engine, this method will return only the first page of search results.
Note Note:If IBM Connections is configured as a directory service provider for Content Platform Engine, then search type options are limited to the following values: PrincipalSearchType.EXACT or PrincipalSearchType.PREFIX_MATCH.

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 methodFindUsers
Returns 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 Note: Searching is not case sensitive.
Note Note: If IBM Virtual Member Manager (VMM) or IBM Connections is configured as a directory service provider for Content Platform Engine, this method will return only the first page of search results.
Note Note:If IBM Connections is configured as a directory service provider for Content Platform Engine, then search type options are limited to the following values: PrincipalSearchType.EXACT or PrincipalSearchType.PREFIX_MATCH.

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 methodGetClassName
Returns the name of the class from which this object is instantiated.
(Inherited from IEngineObject.)
Public methodGetConnection
Returns a Connection object that represents a logical connection to the FileNet P8 domain. The returned Connection object is used as input to methods such as factory instantiation methods.
(Inherited from IEngineObject.)
Public methodGetObjectReference
Returns an object reference that represents the object's identity.

The ID of an independent object is the class name and ID of the object. The ID can be a path, GUID, or name of the object.

(Inherited from IIndependentObject.)
Public methodGetSuperClasses
Returns a String array specifying the names of the superclasses of the class from which this object is instantiated.
(Inherited from IEngineObject.)
Public methodRefreshOverloaded.

ToggleSee Also