com.netegrity.sdk.dmsapi
Class SmDmsGroup

java.lang.Object
  com.netegrity.sdk.dmsapi.SmDmsObject
      com.netegrity.sdk.dmsapi.SmDmsGroup

public class SmDmsGroup
extends SmDmsObject

Represents a group object in an organization.

Groups are sets of objects that have something in common--for example, a group of employees who have been with the company for less than a year. With group objects, users can be assigned privileges collectively instead of individually.

Since:

SDK 2.0

Field Summary

Fields inherited from class com.netegrity.sdk.dmsapi.SmDmsObject

DMSOBJECT_CLASS_DIRECTORY, DMSOBJECT_CLASS_GROUP, DMSOBJECT_CLASS_ORGANIZATION, DMSOBJECT_CLASS_ROLE, DMSOBJECT_CLASS_UNKNOWN, DMSOBJECT_CLASS_USER

Method Summary

SmApiResult	getMembers(SmDmsCursor cursorObj, java.util.Vector attrNames, java.util.Vector members, int direction) Gets the members of a group, and also gets information about the attributes specified in attrNames.
SmApiResult	getMembers(java.util.Vector members) Gets the members of a group.

Methods inherited from class com.netegrity.sdk.dmsapi.SmDmsObject

addObject, addToGroup, clearAttributes, deleteObject, getApiSession, getAttribute, getAttributes, getClassId, getDmsConfig, getDn, getGroups, getGroups, getObject, getObject, getOrganizationDn, getRealm, getUserDirectory, getVersion, isActiveDir, modifyObject, modifyObjectClass, newDmsObject, readAttributes, removeFromGroup, setActiveDir, setAttribute, setAttributes, setClassId, toString, writeAttributes

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getMembers

public SmApiResult getMembers(java.util.Vector members)
                       throws SmApiException

Gets the members of a group.

To retrieve member names and selected attribute information, call getMembers(SmDmsCursor, Vector, Vector, int).

This method requires an organization administrator session or higher.

Note: getMembers() is not supported with ODBC databases. Use an SmDmsOrganization.search... method instead.

Parameters:

members - When this method returns successfully, this output parameter is filled with a Vector of strings containing the distinguished names of group members.

Returns:

SmApiResult Result of the request.

Throws:

SmApiException

getMembers

public SmApiResult getMembers(SmDmsCursor cursorObj,
                              java.util.Vector attrNames,
                              java.util.Vector members,
                              int direction)
                       throws SmApiException

Gets the members of a group, and also gets information about the attributes specified in attrNames.

The search result is sorted and paginated according to the information in SmDmsCursor.

Call this method each time you want to retrieve a new page from the result set.

To retrieve member names only, call getMembers(Vector).

This method requires an organization administrator session or higher.

Note: getMembers() is not supported with ODBC databases. Use an SmDmsOrganization.search... method instead.

Parameters:

members - When this method returns successfully, this output parameter is filled with a Vector of SmDmsObject objects containing the distinguished names of the group members and the specified attribute information.

attrNames - Vector of strings containing the names of the attributes to retrieve.

cursorObj - The object containing sorting and paging information.

direction - The search direction. One of the following:

• Value 1. SmDmsSearch.Forward
• Value 2. SmDmsSearch.Back
• Value 3. SmDmsSearch.Refresh
• Value 0. SmDmsSearch.Reset

Returns:

SmApiResult Result of the request.

Throws:

SmApiException

Since:

SDK 2.2