get method

Use the get method to retrieve the information of an entity or entities.

Purpose

The get method returns the requested information of the specified entities. For example, the properties, the groups that the entity belongs to, the ancestors, or descendants of the entity.

To retrieve an entity, the entity data object with its Identifier is added under the root data object. Multiple entities can be retrieved in one get method call by adding multiple entity data objects under the root.

By specifying different controls, different information can be returned. For example, PropertyControl is used for returning the properties of the entities. GroupMembershipControl is used for returning groups that the entities belong to.
Note: SortControl is ignored in the ProfileManager, if the requested entities were returned by an asynchronous adapter. In this case, results are sorted depending on the sorting functions supported by the asynchronous adapter.

Parameters

root
Specifies the root data object containing the request information.

Returns

The root data object containing the requested information.
Note: The password property is returned only if the underlying repository returns it. The password is returned in the same form that the underlying repository returns the password to virtual member manager.

Exceptions

  • WIMException:
  • RemoteException:

Signature

public DataObject get(DataObject root) throws WIMException, RemoteException

Icon that indicates the type of topic Reference topic



Timestamp icon Last updated: March 6, 2017 0:20
File name: get.html